Represents an attribute that should resolve to an AZ::TypeId with a string representation. More...

#include <DocumentSchema.h>

Public Member Functions
constexpr	TypeIdAttributeDefinition (AZStd::string_view name)

Dom::Value	ValueToDom (const AZ::TypeId &attribute) const override
	Converts a value of this attribute's type to a DOM value.

AZStd::optional< AZ::TypeId >	DomToValue (const Dom::Value &value) const override
	Converts a DOM value to an instance of AttributeType.

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

AZ::Dom::Value	LegacyAttributeToDomValue (AZ::PointerObject instanceObject, AZ::Attribute *attribute) const override

Public Member Functions inherited from AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >
constexpr	AttributeDefinition (AZStd::string_view name)

Name	GetName () const override
	Retrieves the name of this attribute, as used as a key in the DOM.

AZStd::optional< AZ::TypeId >	ExtractFromDomNode (const Dom::Value &node) const
	Extracts this value from a given Node, if this attribute is set there.

AZ::TypeId	GetTypeId () const override
	Gets this attribute's type ID.

Additional Inherited Members
Protected Attributes inherited from AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >
AZStd::fixed_string< 128 >	m_name

Detailed Description

Represents an attribute that should resolve to an AZ::TypeId with a string representation.

Member Function Documentation

AZStd::optional< AZ::TypeId > AZ::DocumentPropertyEditor::TypeIdAttributeDefinition::DomToValue ( const Dom::Value & value ) const

overridevirtual

Converts a DOM value to an instance of AttributeType.

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

overridevirtual

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

Parameters

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

AZ::Dom::Value AZ::DocumentPropertyEditor::TypeIdAttributeDefinition::LegacyAttributeToDomValue	(	AZ::PointerObject	instanceObject,
		AZ::Attribute *	attribute
	)		const

overridevirtual

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

Parameters

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

Dom::Value AZ::DocumentPropertyEditor::TypeIdAttributeDefinition::ValueToDom ( const AZ::TypeId & attribute ) const

overridevirtual

Converts a value of this attribute's type to a DOM value.

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

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/DocumentSchema.h