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

#include <ArticyObject.h>

Inheritance diagram for UArticyObject:
UArticyPrimitive UArticyBaseObject IArticyReflectable UArticyAsset UArticyComment UArticyConnection UArticyDocument UArticyEntity UArticyLink UArticyLocation UArticyLocationImage UArticyLocationText UArticyNode UArticyPath UArticySpot UArticyTextObject UArticyUserFolder UArticyZone

Public Member Functions

FName GetTechnicalName () const
UArticyObjectGetParent () const
TArray< TWeakObjectPtr< UArticyObject > > GetChildren () const
FArticyId GetParentID () const
TArray< FArticyIdGetChildrenIDs () const
Public Member Functions inherited from UArticyPrimitive
FArticyId GetId () const
uint32 GetCloneId () const
void SetCloneID (uint32 cCloneId)
Public Member Functions inherited from UArticyBaseObject
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

Protected Member Functions

void InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyPrimitive
void InitFromJson (TSharedPtr< FJsonValue > Json) override
Protected Member Functions inherited from UArticyBaseObject
void AddSubobject (UArticyPrimitive *Obj)
FText GetPropertyText (const FText Property)

Protected Attributes

FArticyId Parent
TArray< FArticyIdChildren
FString TechnicalName
Protected Attributes inherited from UArticyPrimitive
FArticyId Id
int32 CloneId = 0
Protected Attributes inherited from UArticyBaseObject
TMap< FArticyId, UArticyPrimitive * > Subobjects

Additional Inherited Members

Static Public Member Functions inherited from IArticyReflectable
static bool HasProperty (const UClass *Class, const FName &Property)
Public Attributes inherited from UArticyBaseObject
FArticyType ArticyType
Public Attributes inherited from IArticyReflectable
FReportChangedDelegate ReportChanged

Detailed Description

Base UCLASS for all articy objects.

Member Function Documentation

◆ GetChildren()

TArray< TWeakObjectPtr< UArticyObject > > UArticyObject::GetChildren ( ) const

Gets the children of this Articy object.

Returns
An array of weak pointers to the child Articy objects.

◆ GetChildrenIDs()

TArray< FArticyId > UArticyObject::GetChildrenIDs ( ) const

Includes all children IDs regardless of type (including pins etc.)

Gets the IDs of the children Articy objects.

Returns
An array of IDs for the children Articy objects.

◆ GetParent()

UArticyObject * UArticyObject::GetParent ( ) const

Gets the parent Articy object.

Returns
Pointer to the parent Articy object, or nullptr if not found.

◆ GetParentID()

FArticyId UArticyObject::GetParentID ( ) const

Gets the ID of the parent Articy object.

Returns
The ID of the parent Articy object.

◆ GetTechnicalName()

FName UArticyObject::GetTechnicalName ( ) const

Gets the technical name of the Articy object.

Returns
The technical name of the object.

◆ InitFromJson()

void UArticyObject::InitFromJson ( TSharedPtr< FJsonValue > Json)
overrideprotectedvirtual

Used internally by ArticyImporter.

Initializes the UArticyObject from a JSON value.

Parameters
JsonThe JSON value to initialize from. Must be a JSON object.

Reimplemented from UArticyBaseObject.


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