ArticyXImporter
ArticyXImporter for Unreal Engine
Loading...
Searching...
No Matches
UArticyBaseObject Class Reference

#include <ArticyBaseObject.h>

Inheritance diagram for UArticyBaseObject:
IArticyReflectable UArticyBaseFeature UArticyPreviewImage UArticyPrimitive UArticyTransformation UArticyFlowPin UArticyObject UArticyScriptFragment UArticyInputPin UArticyOutputPin UArticyAsset UArticyComment UArticyConnection UArticyDocument UArticyEntity UArticyLink UArticyLocation UArticyLocationImage UArticyLocationText UArticyNode UArticyPath UArticySpot UArticyTextObject UArticyUserFolder UArticyZone UArticyScriptCondition UArticyScriptInstruction

Public Member Functions

bool WasLoaded () const
void Initialize ()
UArticyPrimitiveGetSubobject (FArticyId Id) const
FArticyType GetArticyType () const
Public Member Functions inherited from IArticyReflectable
template<typename TValue>
TValue SetProp (FName Property, TValue Value, int32 ArrayIndex=0)
template<typename TValue>
TValue & GetProp (FName Property, int32 ArrayIndex=0)
template<typename TValue>
const TValue & GetProp (FName Property, int32 ArrayIndex=0) const
template<typename TValue>
TValue * GetPropPtr (FName Property, int32 ArrayIndex=0) const
FProperty * GetProperty (FName Property) const
virtual UClass * GetObjectClass () const

Public Attributes

FArticyType ArticyType
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate ReportChanged

Protected Member Functions

virtual void InitFromJson (TSharedPtr< FJsonValue > Json)
void AddSubobject (UArticyPrimitive *Obj)
FText GetPropertyText (const FText Property)

Protected Attributes

TMap< FArticyId, UArticyPrimitive * > Subobjects

Friends

template<typename Type, typename PropType>
struct ArticyObjectTypeInfo

Additional Inherited Members

Static Public Member Functions inherited from IArticyReflectable
static bool HasProperty (const UClass *Class, const FName &Property)

Detailed Description

Base class for all Articy objects.

Member Function Documentation

◆ AddSubobject()

void UArticyBaseObject::AddSubobject ( UArticyPrimitive * Obj)
protected

Adds a subobject to this Articy object.

Parameters
ObjThe subobject to add.

◆ GetArticyType()

FArticyType UArticyBaseObject::GetArticyType ( ) const

Gets the Articy type of this object.

Returns
The FArticyType associated with this object.

◆ GetPropertyText()

FText UArticyBaseObject::GetPropertyText ( const FText Property)
protected

Retrieves a localized text property for this Articy object.

Parameters
PropertyThe text property to localize.
Returns
A localized FText object.

◆ GetSubobject()

UArticyPrimitive * UArticyBaseObject::GetSubobject ( FArticyId Id) const

Retrieves a subobject of this Articy object using its unique identifier.

Parameters
IdThe unique identifier of the subobject to retrieve.
Returns
A pointer to the UArticyPrimitive subobject if found, otherwise nullptr.

◆ InitFromJson()

virtual void UArticyBaseObject::InitFromJson ( TSharedPtr< FJsonValue > Json)
inlineprotectedvirtual

Initializes the object from a JSON value.

Parameters
JsonThe JSON value to initialize from.

Reimplemented in UArticyConnection, UArticyFlowPin, UArticyObject, UArticyPrimitive, and UArticyScriptFragment.

◆ Initialize()

void UArticyBaseObject::Initialize ( )
inline

For ArticyImporter internal use only: initializes the bWasDeserialized variable.

◆ WasLoaded()

bool UArticyBaseObject::WasLoaded ( ) const
inline

Returns true if deserialization was already performed for this object.

Member Data Documentation

◆ ArticyType

FArticyType UArticyBaseObject::ArticyType

The Articy type of this object.

◆ Subobjects

TMap<FArticyId, UArticyPrimitive*> UArticyBaseObject::Subobjects
protected

Objects that are dynamically created for this object during import (like Pins, Connections, etc.).


The documentation for this class was generated from the following files:
  • Source/ArticyRuntime/Public/ArticyBaseObject.h
  • Source/ArticyRuntime/Private/ArticyBaseObject.cpp