UArticyCloneableObject Class Reference

#include <ArticyDatabase.h>

Inheritance diagram for UArticyCloneableObject:

Public Member Functions
void	Init (UArticyObject *InitialClone)
UArticyObject *	Get (const IShadowStateManager *ShadowManager, int32 CloneId=0, bool bForceUnshadowed=false) const
UArticyObject *	Clone (const IShadowStateManager *ShadowManager, int32 CloneId, bool bFailIfExists=true)

Detailed Description

Contains a reference to a UArticyObject, and to its clones if any.

Member Function Documentation

Clone()

UArticyObject * UArticyCloneableObject::Clone	(	const IShadowStateManager *	ShadowManager,
		int32	CloneId,
		bool	bFailIfExists = true )

Clone the original object and assign it the id CloneId. If bFailIfExists is true, nullptr is returned if the clone already exists. Otherwise, the existing clone is returned.

Parameters

ShadowManager	The manager for shadow states.
CloneId	The clone ID for the new clone.
bFailIfExists	Fails if the clone already exists.

Returns

A pointer to the newly created clone or nullptr if creation failed.

Clones the Articy object, creating a new instance with the specified clone ID.

Parameters

ShadowManager	The manager for shadow states.
CloneId	The ID for the new clone.
bFailIfExists	Fails if the clone already exists.

Returns

A pointer to the newly created or existing clone, or nullptr if creation failed.

Get()

UArticyObject * UArticyCloneableObject::Get	(	const IShadowStateManager *	ShadowManager,
		int32	CloneId = 0,
		bool	bForceUnshadowed = false ) const

Get the clone of this object with a certain CloneId. Returns nullptr if the clone does not exist.

Parameters

ShadowManager	The manager for shadow states.
CloneId	The clone ID to retrieve.
bForceUnshadowed	Force retrieval of the unshadowed version.

Returns

A pointer to the clone or nullptr if not found.

Retrieves a clone of the Articy object based on clone ID and shadow state.

Parameters

ShadowManager	The manager for shadow states.
CloneId	The ID of the clone to retrieve.
bForceUnshadowed	Force retrieval of the unshadowed version.

Returns

A pointer to the shadowed or unshadowed UArticyObject clone.

Init()

void UArticyCloneableObject::Init ( UArticyObject * InitialClone )

inline

Initializes the cloneable object with the initial clone.

Parameters

InitialClone

The initial clone to add.

---

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

• Source/ArticyRuntime/Public/ArticyDatabase.h
• Source/ArticyRuntime/Private/ArticyDatabase.cpp