Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AZ::DocumentPropertyEditor::AttributeDefinitionInterface Class Referenceabstract

#include <DocumentSchema.h>

Inherited by AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::function< CallbackSignature > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >, AZ::DocumentPropertyEditor::AttributeDefinition< GenericValueContainer< GenericValueType > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::Name >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >, and AZ::DocumentPropertyEditor::AttributeDefinition< AttributeType >.

Public Member Functions

virtual Name GetName () const =0
 Retrieves the name of this attribute, as used as a key in the DOM.
 
virtual AZ::TypeId GetTypeId () const =0
 Gets this attribute's type ID.
 
virtual AZStd::shared_ptr< AZ::Attribute > DomValueToLegacyAttribute (const AZ::Dom::Value &value, bool fallback=true) const =0
 
virtual AZ::Dom::Value LegacyAttributeToDomValue (void *instance, AZ::Attribute *attribute) const =0
 

Detailed Description

Base class for a schema definition for an attribute type on a node. Attributes are stroed as key/value pairs, and their definitions provide helpers for marshalling data into and out of the DOM to their associated type.

See also
AttributeDefinition

Member Function Documentation

◆ DomValueToLegacyAttribute()

virtual AZStd::shared_ptr< AZ::Attribute > AZ::DocumentPropertyEditor::AttributeDefinitionInterface::DomValueToLegacyAttribute ( const AZ::Dom::Value &  value,
bool  fallback = true 
) const
pure virtual

Converts this attribute to an AZ::Attribute usable by the ReflectedPropertyEditor

Parameters
fallbackif false, the Attribute type must match AZ::Dom::Value; if true, it will attempt a fallback on failure

Implemented in AZ::DocumentPropertyEditor::AttributeDefinition< AttributeType >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::function< CallbackSignature > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >, AZ::DocumentPropertyEditor::AttributeDefinition< GenericValueContainer< GenericValueType > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::Name >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >, AZ::DocumentPropertyEditor::TypeIdAttributeDefinition, AZ::DocumentPropertyEditor::NamedCrcAttributeDefinition, and AZ::DocumentPropertyEditor::CallbackAttributeDefinition< CallbackSignature >.

◆ GetName()

virtual Name AZ::DocumentPropertyEditor::AttributeDefinitionInterface::GetName ( ) const
pure virtual

Retrieves the name of this attribute, as used as a key in the DOM.

Implemented in AZ::DocumentPropertyEditor::AttributeDefinition< AttributeType >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::function< CallbackSignature > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >, AZ::DocumentPropertyEditor::AttributeDefinition< GenericValueContainer< GenericValueType > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::Name >, and AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >.

◆ GetTypeId()

virtual AZ::TypeId AZ::DocumentPropertyEditor::AttributeDefinitionInterface::GetTypeId ( ) const
pure virtual

Gets this attribute's type ID.

Implemented in AZ::DocumentPropertyEditor::AttributeDefinition< AttributeType >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::function< CallbackSignature > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >, AZ::DocumentPropertyEditor::AttributeDefinition< GenericValueContainer< GenericValueType > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::Name >, and AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >.

◆ LegacyAttributeToDomValue()

virtual AZ::Dom::Value AZ::DocumentPropertyEditor::AttributeDefinitionInterface::LegacyAttributeToDomValue ( void *  instance,
AZ::Attribute *  attribute 
) const
pure virtual

Converts this attribute from an AZ::Attribute to a Dom::Value usable in the DocumentPropertyEditor.

Parameters
fallbackif false, a Read<AttributeType> failure will return a null Value; if true, it will attempt a fallback on failure

Implemented in AZ::DocumentPropertyEditor::AttributeDefinition< AttributeType >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::function< CallbackSignature > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZStd::pair< GenericValueType, AZStd::string > >, AZ::DocumentPropertyEditor::AttributeDefinition< GenericValueContainer< GenericValueType > >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::Name >, AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >, AZ::DocumentPropertyEditor::TypeIdAttributeDefinition, AZ::DocumentPropertyEditor::NamedCrcAttributeDefinition, AZ::DocumentPropertyEditor::GenericValueAttributeDefinition< GenericValueType >, AZ::DocumentPropertyEditor::GenericValueListAttributeDefinition< GenericValueType >, and AZ::DocumentPropertyEditor::CallbackAttributeDefinition< CallbackSignature >.

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