FArticyModelDef Struct Reference

#include <PackagesImport.h>

Public Member Functions
void	ImportFromJson (const TSharedPtr< FJsonObject > JsonModel)
void	GatherScripts (UArticyImportData *Data) const
UArticyObject *	GenerateSubAsset (const UArticyImportData *Data, UObject *Outer) const
FName	GetType () const
const FString &	GetTechnicalName () const
const FString &	GetNameAndId () const
const FArticyId &	GetId () const
const FArticyId &	GetParent () const
const FString &	GetAssetRef () const
const EArticyAssetCategory &	GetAssetCat () const
TSharedPtr< FJsonObject >	GetPropertiesJson () const
TSharedPtr< FJsonObject >	GetTemplatesJson () const

Detailed Description

Represents a model definition in Articy with properties for asset reference, category, and JSON strings for properties and templates.

Member Function Documentation

GatherScripts()

void FArticyModelDef::GatherScripts

(

UArticyImportData *

Data

)

const

Gathers scripts from the model definition and adds them to the ArticyImportData.

Parameters

Data	A pointer to the UArticyImportData object.

GenerateSubAsset()

UArticyObject * FArticyModelDef::GenerateSubAsset	(	const UArticyImportData *	Data,
		UObject *	Outer ) const

Generates a sub-asset from the model definition.

Parameters

Data	A pointer to the UArticyImportData object.
Outer	The outer object for the sub-asset.

Returns

A pointer to the generated UArticyObject sub-asset.

GetAssetCat()

const EArticyAssetCategory & FArticyModelDef::GetAssetCat ( ) const

inline

Gets the asset category of the model.

Returns

The asset category as an EArticyAssetCategory.

GetAssetRef()

const FString & FArticyModelDef::GetAssetRef ( ) const

inline

Gets the asset reference of the model.

Returns

The asset reference as a string.

GetId()

const FArticyId & FArticyModelDef::GetId ( ) const

inline

Gets the ID of the model.

Returns

The model ID as an FArticyId.

GetNameAndId()

const FString & FArticyModelDef::GetNameAndId ( ) const

inline

Gets the combined name and ID of the model.

Returns

The name and ID as a string.

GetParent()

const FArticyId & FArticyModelDef::GetParent ( ) const

inline

Gets the parent ID of the model.

Returns

The parent ID as an FArticyId.

GetPropertiesJson()

TSharedPtr< FJsonObject > FArticyModelDef::GetPropertiesJson

(

)

const

Gets the properties JSON object from the cached properties JSON string.

Returns

A shared pointer to the properties JSON object.

GetTechnicalName()

const FString & FArticyModelDef::GetTechnicalName ( ) const

inline

Gets the technical name of the model.

Returns

The technical name as a string.

GetTemplatesJson()

TSharedPtr< FJsonObject > FArticyModelDef::GetTemplatesJson

(

)

const

Gets the templates JSON object from the cached templates JSON string.

Returns

A shared pointer to the templates JSON object.

GetType()

FName FArticyModelDef::GetType ( ) const

inline

Gets the type of the model.

Returns

The model type as an FName.

ImportFromJson()

void FArticyModelDef::ImportFromJson

(

const TSharedPtr< FJsonObject >

JsonModel

)

Imports model definition data from a JSON object.

Parameters

JsonModel

A shared pointer to the JSON object containing the model definition.

---

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

• Source/ArticyEditor/Public/PackagesImport.h
• Source/ArticyEditor/Private/PackagesImport.cpp