Represents an attribute that should resolve to an AZ::TypeId with a string representation. More...
#include <DocumentSchema.h>
Inherits AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >.
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 (void *instance, 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. | |
| virtual Dom::Value | ValueToDom (const AZ::TypeId &attribute) const |
| Converts a value of this attribute's type to a DOM value. | |
| virtual AZStd::optional< AZ::TypeId > | DomToValue (const Dom::Value &value) const |
| Converts a DOM value to an instance of AttributeType. | |
| 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. | |
| AZStd::shared_ptr< AZ::Attribute > | DomValueToLegacyAttribute (const AZ::Dom::Value &value, bool fallback) const override |
| AZ::Dom::Value | LegacyAttributeToDomValue (void *instance, AZ::Attribute *attribute) const override |
| 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 |
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
◆ DomToValue()
|
overridevirtual |
Converts a DOM value to an instance of AttributeType.
Reimplemented from AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >.
◆ DomValueToLegacyAttribute()
|
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
Implements AZ::DocumentPropertyEditor::AttributeDefinitionInterface.
◆ LegacyAttributeToDomValue()
|
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
Implements AZ::DocumentPropertyEditor::AttributeDefinitionInterface.
◆ ValueToDom()
|
overridevirtual |
Converts a value of this attribute's type to a DOM value.
Reimplemented from AZ::DocumentPropertyEditor::AttributeDefinition< AZ::TypeId >.
The documentation for this class was generated from the following file:
- Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/DocumentSchema.h
