1. Epic GamesDeveloper
  3. FCustomizableObjectInstanceDescriptor

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  
FDescriptorHash friend Friends. MuCO/CustomizableObjectInstanceDescriptor.h  
FirstRequestedLOD TMap< FName, uint8 > RequestedLODs per component to generate. 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  
MeshParameters TArray< FCustomizableObjectAssetParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
MinLOD TMap< FName, uint8 > These are the LODs Mutable can generate based on user input and quality settings, they MUST NOT be used in an update (Mutable thread). MuCO/CustomizableObjectInstanceDescriptor.h  
ProjectorParameters TArray< FCustomizableObjectProjectorParameterValue >   MuCO/CustomizableObjectInstanceDescriptor.h  
QualitySettingMinLODs TMap< FName, uint8 > These are the MinLODs based on the active quality setting MuCO/CustomizableObjectInstanceDescriptor.h  
State int32 Mutable parameters optimization state. MuCO/CustomizableObjectInstanceDescriptor.h
  • Transient
TextureParameters TArray< FCustomizableObjectAssetParameterValue >   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
)

 Increases the range of values of the float with ParamName, returns the index of the new float value, -1 otherwise. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToIntRange ( const FString& ParamName
)

 Increases the range of values of the integer with ParamName, returns the index of the new integer value, -1 otherwise. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToProjectorRange ( const FString& ParamName
)

 Increases the range of values of the projector with ParamName, returns the index of the new projector value, -1 otherwise. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 AddValueToTextureRange ( const FString& ParamName
)

 Increases the range of values of the float with ParamName, returns the index of the new float value, -1 otherwise. MuCO/CustomizableObjectInstanceDescriptor.h  

void CreateLayer ( const FName& ParamName,
int32 Index
)

 Creates a new layer for the multilayer projector with name ParamName. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Finds the parameter with name ParamName in the array of its type, returns the index if found, INDEX_NONE otherwise. MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectBoolParameterValue > & GetBoolParameters()

 FParameters MuCO/CustomizableObjectInstanceDescriptor.h  

bool GetBoolParameterSelectedOption ( const FString& BoolParamName
) const

 Gets the value of the bool parameter with name "BoolParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

bool GetBuildParameterRelevancy()

   MuCO/CustomizableObjectInstanceDescriptor.h  

FLinearColor GetColorParameterSelectedOption ( const FString& ColorParamName
) const

 Gets the value of a color parameter with name "ColorParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

FString GetCurrentState()

 Get the current optimization state. MuCO/CustomizableObjectInstanceDescriptor.h  

UCustomizableObject * GetCustomizableObject()

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

const TMap< FName, uint8 > & GetFirstRequestedLOD()

   MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectFloatParameterValue > & GetFloatParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Gets the value of a float parameter with name "FloatParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetFloatValueRange ( const FString& ParamName
) const

 Gets the range of values of the float with ParamName, returns -1 if the parameter does not exist. MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectIntParameterValue > & GetIntParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Gets the value of the int parameter with name "ParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetIntValueRange ( const FString& ParamName
) const

 Gets the range of values of the int with ParamName, returns -1 if the parameter does not exist. MuCO/CustomizableObjectInstanceDescriptor.h  

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

   MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectAssetParameterValue > & GetMeshParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

TSharedPtr< mu::FParameters > GetParameters()

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

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

 Get the current projector for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current cylindrical projector angle for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current projector direction vector for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectProjectorParameterValue > & GetProjectorParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current projector type for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current projector position for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current projector scale for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the current projector up vector for the parameter with the given name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Get the projector values of a projector parameter with index "ProjectorParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Float version. See GetProjectorValue. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetProjectorValueRange ( const FString& ParamName
) const

 Gets the range of values of the projector with ParamName, returns -1 if the parameter does not exist. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetState()

 StatesGet the current optimization state. MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectAssetParameterValue > & GetTextureParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

FName GetTextureParameterSelectedOption ( const FString& TextureParamName,
int32 RangeIndex
) const

 Gets the value of a texture parameter with name "TextureParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

int32 GetTextureValueRange ( const FString& ParamName
) const

 Gets the range of values of the texture with ParamName, returns -1 if the parameter does not exist. MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectTransformParameterValue > & GetTransformParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

FTransform GetTransformParameterSelectedOption ( const FString& TransformParamName
) const

 Gets the value of a transform parameter with name "TransformParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

const TArray< FCustomizableObjectVectorParameterValue > & GetVectorParameters()

   MuCO/CustomizableObjectInstanceDescriptor.h  

bool HasAnyParameters()

 Return true if there are any parameters. MuCO/CustomizableObjectInstanceDescriptor.h  

bool IsMultilayerProjector ( const FString& ParamName
) const

 Multilayer Projectors MuCO/CustomizableObjectInstanceDescriptor.h  

void LoadDescriptor ( FArchive& Ar
)

 Deserialize this object. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 NumProjectorLayers ( const FName& ParamName
) const

 Layers. 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
)

 Removes the layer at Index from the multilayer projector with name ParamName. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromFloatRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the FRangeIndex element of the float range of values from the parameter ParamName. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromIntRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the FRangeIndex element of the integer range of values from the parameter ParamName. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromProjectorRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the FRangeIndex element of the projector range of values from the parameter ParamName. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromTextureRange ( const FString& ParamName
)

 Remove the last of the texture range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left. MuCO/CustomizableObjectInstanceDescriptor.h  

int32 RemoveValueFromTextureRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the FRangeIndex element of the texture range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left. MuCO/CustomizableObjectInstanceDescriptor.h  

void SaveDescriptor ( FArchive& Ar,
bool bUseCompactDescriptor
)

 Serialize this object. MuCO/CustomizableObjectInstanceDescriptor.h  

void SetBoolParameterSelectedOption ( const FString& BoolParamName,
bool BoolValue
)

 Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

void SetBuildParameterRelevancy ( bool Value
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetColorParameterSelectedOption ( const FString& ColorParamName,
const FLinearColor& ColorValue
)

 Sets the color value "ColorValue" of a color parameter with index "ColorParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

void SetCurrentState ( const FString& StateName
)

 Set the current optimization state. MuCO/CustomizableObjectInstanceDescriptor.h  

void SetCustomizableObject ( UCustomizableObject* InCustomizableObject
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetDefaultValue ( int32 ParamIndex
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetDefaultValues()

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetFirstRequestedLOD ( const TMap< FName, uint8 >& FirstRequestedLOD
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the float value "FloatValue" of a float parameter with index "FloatParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the selected option of an int parameter by the option's name. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the selected option of an int parameter, by the option's name MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Set only the cylindrical projector angle. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Set only the projector direction. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Set only the projector position. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Set only the projector scale. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Set only the projector up vector. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the projector values of a projector parameter with index "ProjectorParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

void SetRandomValues()

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetRandomValuesFromStream ( const FRandomStream& InStream
)

   MuCO/CustomizableObjectInstanceDescriptor.h  

void SetState ( int32 InState
)

 Set the current optimization state. MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the texture value "TextureValue" of a texture parameter with index "TextureParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the transform value "TransformValue" of a transform parameter with name "TransformParamName". MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Sets the vector value "VectorValue" of a bool parameter with index "VectorParamIndex". MuCO/CustomizableObjectInstanceDescriptor.h  

FString ToString()

   MuCO/CustomizableObjectInstanceDescriptor.h  

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

 Updates the parameters of the layer at Index from the multilayer projector with name ParamName. 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