Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::AttributeData< T > Class Template Reference

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.

A generic attribute that contains data that is stored by value. More...

Inherits AZ::Attribute .

Inherited by AZ::AttributeMemberData< T C::* > .

Public Member Functions

template<class U >
AttributeData (U data)
Initializes an attribute with the provided data. More...
virtual const T & Get (void *instance) const
Gets the data from a data attribute. More...
- Public Member Functions inherited from AZ::Attribute
Attribute ()
Initializes an instance of an attribute. More...
virtual ~Attribute ()
An empty destructor. More...
void SetContextData (void *contextData)
Associates additional data with the attribute. More...
void * GetContextData () const
Gets additional data that is associated with the attribute, if any. More...

Additional Inherited Members

- Public Attributes inherited from AZ::Attribute
bool m_describesChildren
Indicates that this attribute is a container for child attributes. More...

Detailed Description

template<class T>
class AZ::AttributeData< T >

A generic attribute that contains data that is stored by value.

This is the most common attribute.

Template Parameters
T The data type.

Constructor & Destructor Documentation

AttributeData()

template<class T >
template<class U >
AZ::AttributeData < T >:: AttributeData ( U data )
inline explicit

Initializes an attribute with the provided data.

Template Parameters
T The type of AttributeData class to use.
U The type of data to put in the attribute.
Parameters
data The data that the attribute will contain.

Member Function Documentation

Get()

template<class T >
virtual const T& AZ::AttributeData < T >::Get ( void * instance ) const
inline virtual

Gets the data from a data attribute.

Parameters
instance A void pointer, which is not used because the data does not belong to an instance of a class.
Returns
A reference to the data that the attribute contains.

Reimplemented in AZ::AttributeMemberData< T C::* > .


The documentation for this class was generated from the following file: