xiiDynamicDefaultStateProvider Class Reference

Retrieves the dynamic default state of an object or container attributed with xiiDynamicDefaultValueAttribute from an asset's meta data. More...

#include <DynamicDefaultStateProvider.h>

Inheritance diagram for xiiDynamicDefaultStateProvider:

Public Member Functions
	xiiDynamicDefaultStateProvider (xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiDocumentObject *pClassObject, const xiiDocumentObject *pRootObject, const xiiAbstractProperty *pRootProp, xiiInt32 iRootDepth)
virtual xiiInt32	GetRootDepth () const override
	Returns the root depth of this provider instance.
virtual xiiColorGammaUB	GetBackgroundColor () const override
	Returns a color to be used in the property grid. Only the hue of the color is used. If alpha is 0, the color is ignored and no tinting of the property grid takes place.
virtual xiiString	GetStateProviderName () const override
	Returns the name of this state provider. Can be used to check what the outer most provider is for GUI purposes.
virtual xiiVariant	GetDefaultValue (SuperArray superPtr, xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant()) override
	Returns the default value of an object's property at a given index.
virtual xiiStatus	CreateRevertContainerDiff (SuperArray superPtr, xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiDeque< xiiAbstractGraphDiffOperation > &out_diff) override
	Queries an array of diff operations that can be executed to revert the object container.
Public Member Functions inherited from xiiDefaultStateProvider
virtual bool	IsDefaultValue (SuperArray superPtr, xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant())
virtual xiiStatus	RevertProperty (SuperArray superPtr, xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant())
virtual xiiStatus	RevertObjectContainer (SuperArray superPtr, xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp)
Public Member Functions inherited from xiiRefCounted
virtual	~xiiRefCounted ()=default
	Adds a virtual destructor.
Public Member Functions inherited from xiiRefCountingImpl
	xiiRefCountingImpl ()=default
	Constructor.
	xiiRefCountingImpl (const xiiRefCountingImpl &rhs)
void	operator= (const xiiRefCountingImpl &rhs)
xiiUInt32	AddRef () const
	Increments the reference counter. Returns the new reference count.
xiiUInt32	ReleaseRef () const
	Decrements the reference counter. Returns the new reference count.
bool	IsReferenced () const
	Returns true if the reference count is greater than 0, false otherwise.
xiiUInt32	GetRefCount () const
	Returns the current reference count.

Static Public Member Functions
static xiiSharedPtr< xiiDefaultStateProvider >	CreateProvider (xiiObjectAccessorBase *pAccessor, const xiiDocumentObject *pObject, const xiiAbstractProperty *pProp)
Static Public Member Functions inherited from xiiDefaultStateProvider
static bool	DoesVariantMatchProperty (const xiiVariant &value, const xiiAbstractProperty *pProp, xiiVariant index=xiiVariant())
	A sanity check function that verifies that a given variant's value matches that expected of the property at the given index. If index is invalid and the property a container, the value must be an array or dictionary of the property's type.

Additional Inherited Members
Public Types inherited from xiiDefaultStateProvider
using	SuperArray = const xiiArrayPtr<const xiiSharedPtr<xiiDefaultStateProvider>>
	Parent hierarchy of state providers.

Detailed Description

Retrieves the dynamic default state of an object or container attributed with xiiDynamicDefaultValueAttribute from an asset's meta data.

Member Function Documentation

CreateRevertContainerDiff()

xiiStatus xiiDynamicDefaultStateProvider::CreateRevertContainerDiff ( SuperArray superPtr, xiiObjectAccessorBase * pAccessor, const xiiDocumentObject * pObject, const xiiAbstractProperty * pProp, xiiDeque< xiiAbstractGraphDiffOperation > & out_diff )

overridevirtual

Queries an array of diff operations that can be executed to revert the object container.

Parameters

superPtr	superPtr Parent hierarchy of inner providers that should be called of this instance cannot handle the request. See SuperArray definition for details.
pAccessor	pAccessor Accessor to be used for querying object values if necessary. Always valid.
pObject	pObject The object which is to be reverted. Always valid.
pProp	pProp The container property which is to be reverted. Always valid.
out_diff	An array of diff operations that should be executed via xiiDocumentObjectConverterReader::ApplyDiffToObject to revert the object / container to its default state.

Returns

If failure is returned, the operation failed and the undo transaction should be canceled.

See also

xiiDocumentObjectConverterReader::ApplyDiffToObject

Implements xiiDefaultStateProvider.

GetBackgroundColor()

xiiColorGammaUB xiiDynamicDefaultStateProvider::GetBackgroundColor ( ) const

overridevirtual

Returns a color to be used in the property grid. Only the hue of the color is used. If alpha is 0, the color is ignored and no tinting of the property grid takes place.

Implements xiiDefaultStateProvider.

GetDefaultValue()

xiiVariant xiiDynamicDefaultStateProvider::GetDefaultValue ( SuperArray superPtr, xiiObjectAccessorBase * pAccessor, const xiiDocumentObject * pObject, const xiiAbstractProperty * pProp, xiiVariant index = xiiVariant() )

overridevirtual

Returns the default value of an object's property at a given index.

Parameters

superPtr	Parent hierarchy of inner providers that should be called of this instance cannot handle the request. See SuperArray definition for details.
pAccessor	Accessor to be used for querying object values if necessary. Always valid.
pObject	The object for which the default value should be queried. Always valid.
pProp	The property for which the default value should be queried. Always valid.
index	For containers: If the index is valid, the container element's default value is requested. If not, the entire container (either array or dictionary) is requested.

Returns

The default value. xiiReflectionUtils::GetDefaultValue is a good example what is expected to be returned.

See also

xiiReflectionUtils::GetDefaultValue, xiiDefaultStateProvider::DoesVariantMatchProperty

Implements xiiDefaultStateProvider.

GetRootDepth()

xiiInt32 xiiDynamicDefaultStateProvider::GetRootDepth ( ) const

overridevirtual

Returns the root depth of this provider instance.

This is through how many properties and objects we needed to pass through from the object and property passed into the factory method to find the root object / property that this provider represents. For example if we have this object hierarchy: A |-children- B |-elements- C

If A is a prefab and the factory method was called for C (with no property) then we need to walk up the hierarchy via elements container, the B object, the children container and then finally A. Thus, we need 4 hops to get the the prefab root which means the root depth for this provider instance is 4.

Implements xiiDefaultStateProvider.

GetStateProviderName()

virtual xiiString xiiDynamicDefaultStateProvider::GetStateProviderName ( ) const

inlineoverridevirtual

Returns the name of this state provider. Can be used to check what the outer most provider is for GUI purposes.

Implements xiiDefaultStateProvider.

---

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

• /home/runner/work/XII/XII/Source/Editor/EditorFramework/GUI/DynamicDefaultStateProvider.h
• /home/runner/work/XII/XII/Source/Editor/EditorFramework/GUI/Implementation/DynamicDefaultStateProvider.cpp