Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::Edit::ClassData Struct Reference

This structure is built up and stored in the edit context while you are calling EditContext::ClassInfo functions to reflect a class's data to the edit context. More...

Public Member Functions

 ClassData ()
 Initializes a ClassData object. More...
 
void ClearElements ()
 Removes the reflection for any data that a class has reflected to the edit context. More...
 
const ElementDataFindElementData (AttributeId elementId) const
 Returns the element data of the specified element. More...
 

Public Attributes

const char * m_name
 The name of the class. More...
 
const char * m_description
 A description of the class. More...
 
SerializeContext::ClassDatam_classData
 A pointer to the SerializeContext::ClassData object that corresponds to the Edit::ClassData object. More...
 
AZStd::list< ElementDatam_elements
 The subtypes (for example, class members) of the class. More...
 

Detailed Description

This structure is built up and stored in the edit context while you are calling EditContext::ClassInfo functions to reflect a class's data to the edit context.

Constructor & Destructor Documentation

◆ ClassData()

AZ::Edit::ClassData::ClassData ( )
inline

Initializes a ClassData object.

Member Function Documentation

◆ ClearElements()

void AZ::Edit::ClassData::ClearElements ( )

Removes the reflection for any data that a class has reflected to the edit context.

◆ FindElementData()

const ElementData* AZ::Edit::ClassData::FindElementData ( AttributeId  elementId) const

Returns the element data of the specified element.

Parameters
elementIdThe ID of the element to find.
Returns
A pointer to the ElementData that represents the specified element. Returns a null pointer if an element with the specified ID could not be found.

Member Data Documentation

◆ m_classData

SerializeContext::ClassData* AZ::Edit::ClassData::m_classData

A pointer to the SerializeContext::ClassData object that corresponds to the Edit::ClassData object.

◆ m_description

const char* AZ::Edit::ClassData::m_description

A description of the class.

◆ m_elements

AZStd::list<ElementData> AZ::Edit::ClassData::m_elements

The subtypes (for example, class members) of the class.

Each subtype is represented as an ElementData, and each ElementData can be assigned any number of attributes.

◆ m_name

const char* AZ::Edit::ClassData::m_name

The name of the class.


The documentation for this struct was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AZCore/AZCore/Serialization/EditContext.h