Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::Edit::ElementData Struct Reference

A named group of attributes. More...

Public Member Functions

 ElementData ()
 Initializes an ElementData object. More...
 
void ClearAttributes ()
 Removes all attributes from the element. More...
 
bool IsClassElement () const
 Finds whether this element is a logical element or a data element. More...
 
Edit::AttributeFindAttribute (AttributeId attributeId) const
 Finds the specified attribute of an element. More...
 

Public Attributes

AttributeId m_elementId
 The ID of the element. More...
 
const char * m_description
 A description of the element. More...
 
const char * m_name
 The name of the element. More...
 
SerializeContext::ClassElementm_serializeClassElement
 A pointer to the SerializeContext::ClassElement for this element. More...
 
AttributeArray m_attributes
 An array of attributes of the element. More...
 

Detailed Description

A named group of attributes.

An ElementData can represent a member variable or an arbitrary group of attributes. For examples of attributes, see the AZ::Edit::Attributes constants that are defined in EditContextConstants.inl.

Constructor & Destructor Documentation

◆ ElementData()

AZ::Edit::ElementData::ElementData ( )
inline

Initializes an ElementData object.

Member Function Documentation

◆ ClearAttributes()

void AZ::Edit::ElementData::ClearAttributes ( )

Removes all attributes from the element.

◆ FindAttribute()

Edit::Attribute* AZ::Edit::ElementData::FindAttribute ( AttributeId  attributeId) const

Finds the specified attribute of an element.

Parameters
attributeIdThe ID of the attribute to find.
Returns
A pointer to the attribute.

◆ IsClassElement()

bool AZ::Edit::ElementData::IsClassElement ( ) const
inline

Finds whether this element is a logical element or a data element.

Returns
True if this element is a logical element (group of attributes), not a data element within a class.

Member Data Documentation

◆ m_attributes

AttributeArray AZ::Edit::ElementData::m_attributes

An array of attributes of the element.

◆ m_description

const char* AZ::Edit::ElementData::m_description

A description of the element.

◆ m_elementId

AttributeId AZ::Edit::ElementData::m_elementId

The ID of the element.

◆ m_name

const char* AZ::Edit::ElementData::m_name

The name of the element.

◆ m_serializeClassElement

SerializeContext::ClassElement* AZ::Edit::ElementData::m_serializeClassElement

A pointer to the SerializeContext::ClassElement for this element.

This pointer is null if this element is a logical element (a group), rather than a data element within a class.


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