FCustomizableObjectInstanceDescriptor

Internal use only! Currently in /Public due to UCustomizableObjectInstance::Descriptor.

API > API/Plugins > API/Plugins/CustomizableObject

Internal use only! Currently in /Public due to UCustomizableObjectInstance::Descriptor.

Set of parameters + state that defines a CustomizableObjectInstance.

This object has the same parameters + state interface as UCustomizableObjectInstance. UCustomizableObjectInstance must share the same interface. Any public methods added here should also end up in the Instance.

   
Name FCustomizableObjectInstanceDescriptor
Type struct
Header File /Engine/Plugins/Mutable/Source/CustomizableObject/Public/MuCO/CustomizableObjectInstanceDescriptor.h
Include Path #include "MuCO/CustomizableObjectInstanceDescriptor.h"

Syntax

USTRUCT ()  
struct FCustomizableObjectInstanceDescriptor

Constructors

Name Remarks Include Path Unreal Specifiers
  MuCO/CustomizableObjectInstanceDescriptor.h  
  MuCO/CustomizableObjectInstanceDescriptor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bBuildParameterRelevancy bool If this is set to true, when updating the instance an additional step will be performed to calculate the list of instance parameters that are relevant for the current parameter values. MuCO/CustomizableObjectInstanceDescriptor.h  
BoolParameters TArray< FCustomizableObjectBoolParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
CustomizableObject TObjectPtr< UCustomizableObject >   MuCO/CustomizableObjectInstanceDescriptor.h  
ExternalTypeParameters TArray< FCustomizableObjectExternalTypeParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
FDescriptorHash friend Friends. MuCO/CustomizableObjectInstanceDescriptor.h  
FloatParameters TArray< FCustomizableObjectFloatParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
FMultilayerProjector friend   MuCO/CustomizableObjectInstanceDescriptor.h  
FMutableUpdateCandidate friend   MuCO/CustomizableObjectInstanceDescriptor.h  
IntParameters TArray< FCustomizableObjectIntParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
MaterialParameters TArray< FCustomizableObjectMaterialParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
ProjectorParameters TArray< FCustomizableObjectProjectorParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
SkeletalMeshParameters TArray< FCustomizableObjectSkeletalMeshParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
State int32 Mutable parameters optimization state. MuCO/CustomizableObjectInstanceDescriptor.h
  • Transient
TextureParameters TArray< FCustomizableObjectTextureParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
TransformParameters TArray< FCustomizableObjectTransformParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
UCustomizableInstancePrivate friend   MuCO/CustomizableObjectInstanceDescriptor.h  
UCustomizableObjectInstance friend   MuCO/CustomizableObjectInstanceDescriptor.h  
VectorParameters TArray< FCustomizableObjectVectorParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddValueToFloatRange ( const FString& ParamName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToIntRange ( const FString& ParamName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToProjectorRange ( const FString& ParamName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToTextureRange ( const FString& ParamName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void CreateLayer ( const FName& ParamName,
int32 Index
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 FindTypedParameterIndex ( const FString& ParamName,
EMutableParameterType Type
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

bool GetBoolParameterSelectedOption ( const FString& BoolParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

bool GetBuildParameterRelevancy()

   MuCO/CustomizableObjectInstanceDescriptor.h  

FString GetCurrentState()

   MuCO/CustomizableObjectInstanceDescriptor.h  

UCustomizableObject * GetCustomizableObject()

 Could return nullptr in some rare situations, so check first. MuCO/CustomizableObjectInstanceDescriptor.h  

FInstancedStruct GetExternalTypeParameterSelectedOption ( const FString& ExternalTypeParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

float GetFloatParameterSelectedOption ( const FString& FloatParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetFloatValueRange ( const FString& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

const FString & GetIntParameterSelectedOption ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetIntValueRange ( const FString& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FMultilayerProjectorLayer GetLayer ( const FName& ParamName,
int32 Index
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

UMaterialInterface * GetMaterialParameterSelectedOption ( const FString& MaterialMeshParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

TSharedPtr< UE::Mutable::Private::FParameters > GetParameters()

 Return a Mutable Core object containing all parameters. MuCO/CustomizableObjectInstanceDescriptor.h  

float GetProjectorAngle ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FVector GetProjectorDirection ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FCustomizableObjectProjector GetProjectorParameterSelectedOption ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

ECustomizableObjectProjectorType GetProjectorParameterType ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FVector GetProjectorPosition ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FVector GetProjectorScale ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FVector GetProjectorUp ( const FString& ParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

void GetProjectorValue ( const FString& ProjectorParamName,
FVector& OutPos,
FVector& OutDirection,
FVector& OutUp,
FVector& OutScale,
float& OutAngle,
ECustomizableObjectProjectorType& OutType,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

void GetProjectorValueF ( const FString& ProjectorParamName,
FVector3f& OutPos,
FVector3f& OutDirection,
FVector3f& OutUp,
FVector3f& OutScale,
float& OutAngle,
ECustomizableObjectProjectorType& OutType,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetProjectorValueRange ( const FString& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

USkeletalMesh * GetSkeletalMeshParameterSelectedOption ( const FString& SkeletalMeshParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetState()

   MuCO/CustomizableObjectInstanceDescriptor.h  

UTexture * GetTextureParameterSelectedOption ( const FString& TextureParamName,
int32 RangeIndex
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetTextureValueRange ( const FString& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FTransform GetTransformParameterSelectedOption ( const FString& TransformParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

FVector4f GetVectorParameterSelectedOption ( const FString& BoolParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

bool HasAnyParameters()

 FParameters MuCO/CustomizableObjectInstanceDescriptor.h  

bool IsMultilayerProjector ( const FString& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

void LoadDescriptor ( FArchive& Ar
)

 Deserialize this object. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 NumProjectorLayers ( const FName& ParamName
) const

   MuCO/CustomizableObjectInstanceDescriptor.h  

void ReloadParameters()

 Update all parameters to be up to date with the Mutable Core parameters. MuCO/CustomizableObjectInstanceDescriptor.h  

void RemoveLayerAt ( const FName& ParamName,
int32 Index
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromFloatRange ( const FString& ParamName,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromIntRange ( const FString& ParamName,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromProjectorRange ( const FString& ParamName,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromTextureRange ( const FString& ParamName,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromTextureRange ( const FString& ParamName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SaveDescriptor ( FArchive& Ar,
bool bUseCompactDescriptor
)

 Serialize this object. MuCO/CustomizableObjectInstanceDescriptor.h  

void SetBoolParameterSelectedOption ( const FString& BoolParamName,
bool BoolValue
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetBuildParameterRelevancy ( bool Value
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetCurrentState ( const FString& StateName
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetCustomizableObject ( UCustomizableObject* InCustomizableObject
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetDefaultValue ( int32 ParamIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetDefaultValues()

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetExternalTypeParameterSelectedOption ( const FString& ParamName,
const FInstancedStruct& Value,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetFloatParameterSelectedOption ( const FString& FloatParamName,
float FloatValue,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetIntParameterSelectedOption ( int32 IntParamIndex,
const FString& SelectedOption,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetIntParameterSelectedOption ( const FString& ParamName,
const FString& SelectedOptionName,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetMaterialParameterSelectedOption ( const FString& MaterialParamName,
UMaterialInterface* MaterialValue,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorAngle ( const FString& ProjectorParamName,
float Angle,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorDirection ( const FString& ProjectorParamName,
const FVector& Direction,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorParameterSelectedOption ( const FString& ProjectorParamName,
const FCustomizableObjectProjector& ProjectorValue,
const int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorPosition ( const FString& ProjectorParamName,
const FVector& Pos,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorScale ( const FString& ProjectorParamName,
const FVector& Scale,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorUp ( const FString& ProjectorParamName,
const FVector& Up,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetProjectorValue ( const FString& ProjectorParamName,
const FVector& Pos,
const FVector& Direction,
const FVector& Up,
const FVector& Scale,
float Angle,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetRandomValues()

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetRandomValuesFromStream ( const FRandomStream& InStream
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetSkeletalMeshParameterSelectedOption ( const FString& SkeletalMeshParamName,
USkeletalMesh* SkeletalMeshValue,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetState ( int32 InState
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetTextureParameterSelectedOption ( const FString& TextureParamName,
UTexture* TextureValue,
int32 RangeIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetTransformParameterSelectedOption ( const FString& TransformParamName,
const FTransform& TransformValue
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetVectorParameterSelectedOption ( const FString& VectorParamName,
const FVector4f& VectorValue
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

FString ToString()

   MuCO/CustomizableObjectInstanceDescriptor.h  

void UpdateLayer ( const FName& ParamName,
int32 Index,
const FMultilayerProjectorLayer& Layer
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page