Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::ComponentDescriptorDefault< ComponentClass > Class Template Reference

Default descriptor implementation. More...

Inherits AZ::ComponentDescriptorHelper< ComponentClass >.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ComponentDescriptorDefault< ComponentClass >, SystemAllocator, 0)
 Specifies that this class should use the AZ::SystemAllocator for memory management by default. More...
 
void Reflect (ReflectContext *reflection) const override
 Calls the static function AZ::ComponentDescriptor::Reflect if the user provided it. More...
 
void GetProvidedServices (ComponentDescriptor::DependencyArrayType &provided, const Component *instance) const override
 Calls the static function AZ::ComponentDescriptor::GetProvidedServices, if the user provided it. More...
 
void GetDependentServices (ComponentDescriptor::DependencyArrayType &dependent, const Component *instance) const override
 Calls the static function AZ::ComponentDescriptor::GetDependentServices, if the user provided it. More...
 
void GetRequiredServices (ComponentDescriptor::DependencyArrayType &required, const Component *instance) const override
 Calls the static function AZ::ComponentDescriptor::GetRequiredServices, if the user provided it. More...
 
void GetIncompatibleServices (ComponentDescriptor::DependencyArrayType &incompatible, const Component *instance) const override
 Calls the static function AZ::ComponentDescriptor::GetIncompatibleServices, if the user provided it. More...
 
- Public Member Functions inherited from AZ::ComponentDescriptorHelper< ComponentClass >
 ComponentDescriptorHelper ()
 Connects to the component descriptor bus. More...
 
ComponentCreateComponent () override
 Creates an instance of the component. More...
 
const char * GetName () const override
 Gets the name of the component. More...
 
const Uuid & GetUuid () const override
 Gets the ID of the component. More...
 

Detailed Description

template<class ComponentClass>
class AZ::ComponentDescriptorDefault< ComponentClass >

Default descriptor implementation.

This implementation forwards all descriptor calls to a static function inside the class.

Member Function Documentation

◆ AZ_CLASS_ALLOCATOR()

template<class ComponentClass >
AZ::ComponentDescriptorDefault< ComponentClass >::AZ_CLASS_ALLOCATOR ( ComponentDescriptorDefault< ComponentClass >  ,
SystemAllocator  ,
 
)

Specifies that this class should use the AZ::SystemAllocator for memory management by default.

◆ GetDependentServices()

template<class ComponentClass >
void AZ::ComponentDescriptorDefault< ComponentClass >::GetDependentServices ( ComponentDescriptor::DependencyArrayType dependent,
const Component instance 
) const
inlineoverride

Calls the static function AZ::ComponentDescriptor::GetDependentServices, if the user provided it.

Parameters
providedArray of dependent services.
instanceOptional parameter with which you can refine services for each instance. This value is null if no instance exists.

◆ GetIncompatibleServices()

template<class ComponentClass >
void AZ::ComponentDescriptorDefault< ComponentClass >::GetIncompatibleServices ( ComponentDescriptor::DependencyArrayType incompatible,
const Component instance 
) const
inlineoverride

Calls the static function AZ::ComponentDescriptor::GetIncompatibleServices, if the user provided it.

Parameters
providedArray of incompatible services.
instanceOptional parameter with which you can refine services for each instance. This value is null if no instance exists.

◆ GetProvidedServices()

template<class ComponentClass >
void AZ::ComponentDescriptorDefault< ComponentClass >::GetProvidedServices ( ComponentDescriptor::DependencyArrayType provided,
const Component instance 
) const
inlineoverride

Calls the static function AZ::ComponentDescriptor::GetProvidedServices, if the user provided it.

Parameters
providedArray of provided services.
instanceOptional parameter with which you can refine services for each instance. This value is null if no instance exists.

◆ GetRequiredServices()

template<class ComponentClass >
void AZ::ComponentDescriptorDefault< ComponentClass >::GetRequiredServices ( ComponentDescriptor::DependencyArrayType required,
const Component instance 
) const
inlineoverride

Calls the static function AZ::ComponentDescriptor::GetRequiredServices, if the user provided it.

Parameters
providedArray of required services.
instanceOptional parameter with which you can refine services for each instance. This value is null if no instance exists.

◆ Reflect()

template<class ComponentClass >
void AZ::ComponentDescriptorDefault< ComponentClass >::Reflect ( ReflectContext reflection) const
inlineoverride

Calls the static function AZ::ComponentDescriptor::Reflect if the user provided it.

Parameters
Apointer to the reflection context.

The documentation for this class was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/Component/Component.h