Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more. |
Base class for all reflection contexts. More...
Inherited by AZ::BehaviorContext , and AZ::SerializeContext .
Public Member Functions |
|
ReflectContext () | |
Initializes a reflection context instance.
More...
|
|
virtual | ~ReflectContext () |
An empty destructor.
More...
|
|
void | EnableRemoveReflection () |
Sets the behavior such that calls to this context remove reflection for types passed to it.
More...
|
|
void | DisableRemoveReflection () |
Sets the behavior such that calls to this context add reflection for types passed to it.
More...
|
|
bool | IsRemovingReflection () const |
Indicates whether calls to this context remove reflection for types passed to it.
More...
|
|
Detailed Description
Base class for all reflection contexts.
A reflection context is an object that contains information about a type for a particular purpose. A type can be reflected into multiple contexts. For example, to make the properties of a component editable in the Lumberyard editor, you reflect its properties to an edit context. To enable the component to be manipulated during runtime, you reflect its methods to a behavior context. To enable the component to be constructed and stored, you reflect its data fields to a serialize context.
We recommend that you use the following declarative format for all contexts:
This is only for direct C++ interfaces. Code generators generate code on top of this interface.
We recommend that all reflection context implementations provide a way to remove reflection when a reflected class or descriptor is deleted. To do so, make sure that when
IsRemovingReflection()
returns
true
, any calls to
Class<...>()
remove reflection.
Constructor & Destructor Documentation
◆ ReflectContext()
|
inline |
Initializes a reflection context instance.
◆ ~ReflectContext()
|
inline virtual |
An empty destructor.
Member Function Documentation
◆ DisableRemoveReflection()
|
inline |
Sets the behavior such that calls to this context add reflection for types passed to it.
This is the default behavior.
◆ EnableRemoveReflection()
|
inline |
Sets the behavior such that calls to this context remove reflection for types passed to it.
◆ IsRemovingReflection()
|
inline |
Indicates whether calls to this context remove reflection for types passed to it.
- Returns
- True if calls to this context remove reflection for types passed to it. Otherwise, false.
The documentation for this class was generated from the following file:
- C:/lumberyard-root/dev/Code/Framework/AZCore/AZCore/RTTI/ ReflectContext.h