1. Epic GamesDeveloper
  3. FCustomizableObjectInstanceDescriptor

FCustomizableObjectInstanceDescriptor

Set of parameters + state that defines a CustomizableObjectInstance.

API > API/Plugins > API/Plugins/CustomizableObject > API/Plugins/CustomizableObject/MuCO

References

   
Module CustomizableObject
Header /Engine/Plugins/Experimental/Mutable/Source/CustomizableObject/Public/MuCO/CustomizableObjectInstanceDescriptor.h
Include #include "MuCO/CustomizableObjectInstanceDescriptor.h"

Syntax

USTRUCT&40;&41;  
struct FCustomizableObjectInstanceDescriptor

Remarks

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.

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function bool

CreateMultiLayerProjector ( const FName& ProjectorParamName
)

 Multilayer Projectors
Public function Const int32

FindBoolParameterNameIndex ( const FString& ParamName
)

 Finds in BoolParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const int32

FindFloatParameterNameIndex ( const FString& ParamName
)

 Finds in FloatParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const int32

FindIntParameterNameIndex ( const FString& ParamName
)

 Finds in IntParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const int32 Finds in ProjectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const int32

FindTextureParameterNameIndex ( const FString& ParamName
)

 Finds in TextureParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const int32

FindVectorParameterNameIndex ( const FString& ParamName
)

 Finds in VectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function TArray< FCustomizableObjectBoolParameterValue > & Parameters
Public function Const const TArray< FCustomizableObjectBoolParameterValue > &  
Public function Const bool

GetBoolParameterSelectedOption ( const FString& BoolParamName
)

 Gets the value of the bool parameter with name "BoolParamName".
Public function Const bool  
Public function Const FLinearColor

GetColorParameterSelectedOption ( const FString& ColorParamName
)

 Gets the value of a color parameter with name "ColorParamName".
Public function Const FString Get the current optimization state.
Public function Const UCustomizableObject *  
Public function TArray< FCustomizableObjectFloatParameterValue > &  
Public function Const const TArray< FCustomizableObjectFloatParameterValue > &  
Public function Const float

GetFloatParameterSelectedOption ( const FString& FloatParamName,
int32 RangeIndex
)

 Gets the value of a float parameter with name "FloatParamName".
Public function Const int32

GetFloatValueRange ( const FString& ParamName
)

 Gets the range of values of the float with ParamName, returns -1 if the parameter does not exist.
Public function Const const TArray< FCustomizableObjectIntParameterValue > &  
Public function TArray< FCustomizableObjectIntParameterValue > &  
Public function Const const FString &

GetIntParameterSelectedOption ( const FString& ParamName,
int32 RangeIndex
)

 Gets the value of the int parameter with name "ParamName".
Public function Const int32

GetIntValueRange ( const FString& ParamName
)

 Gets the range of values of the int with ParamName, returns -1 if the parameter does not exist.
Public function Const int32  
Public function Const int32  
Public function Const mu::Ptr< mu::Parameters > Return a Mutable Core object containing all parameters.
Public function Const FCustomizableObjectProjector

GetProjector ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector for the parameter with the given name.
Public function Const float

GetProjectorAngle ( const FString& ParamName,
int32 RangeIndex
)

 Get the current cylindrical projector angle for the parameter with the given name.
Public function Const FVector

GetProjectorDirection ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector direction vector for the parameter with the given name.
Public function TArray< FCustomizableObjectProjectorParameterValue > &  
Public function Const const TArray< FCustomizableObjectProjectorParameterValue > &  
Public function Const ECustomizableObjectProjectorType

GetProjectorParameterType ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector type for the parameter with the given name.
Public function Const FVector

GetProjectorPosition ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector position for the parameter with the given name.
Public function Const FVector

GetProjectorScale ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector scale for the parameter with the given name.
Public function Const FVector

GetProjectorUp ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector up vector for the parameter with the given name.
Public function Const void

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

 Get the projector values of a projector parameter with index "ProjectorParamIndex".
Public function Const void

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

 Float version. See GetProjectorValue.
Public function Const int32

GetProjectorValueRange ( const FString& ParamName
)

 Gets the range of values of the projector with ParamName, returns -1 if the parameter does not exist.
Public function Const const TArray< uint16 > &  
Public function Const int32 States Get the current optimization state.
Public function Const const TArray< FCustomizableObjectTextureParameterValue > &  
Public function TArray< FCustomizableObjectTextureParameterValue > &  
Public function Const FName

GetTextureParameterSelectedOption ( const FString& TextureParamName,
int32 RangeIndex
)

 Gets the value of a texture parameter with name "TextureParamName".
Public function Const int32

GetTextureValueRange ( const FString& ParamName
)

 Gets the range of values of the texture with ParamName, returns -1 if the parameter does not exist.
Public function TArray< FCustomizableObjectVectorParameterValue > &  
Public function Const const TArray< FCustomizableObjectVectorParameterValue > &  
Public function Const bool Return true if there are any parameters.
Public function void Deserialize this object.
Public function void

MultilayerProjectorCreateLayer ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::CreateLayer.
Public function void

MultilayerProjectorCreateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::VirtualLayer.
Public function FMultilayerProjectorVirtualLayer

MultilayerProjectorFindOrCreateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::FindOrCreateVirtualLayer.
Public function Const FMultilayerProjectorLayer

MultilayerProjectorGetLayer ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::GetLayer.
Public function Const FMultilayerProjectorVirtualLayer

MultilayerProjectorGetVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::GetVirtualLayer.
Public function Const TArray< FName >

MultilayerProjectorGetVirtualLayers ( const FName& ProjectorParamName
)

 See FMultilayerProjector::GetVirtualLayers.
Public function Const int32

MultilayerProjectorNumLayers ( const FName& ProjectorParamName
)

 See FMultilayerProjector::NumLayers.
Public function void

MultilayerProjectorRemoveLayerAt ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::RemoveLayerAt.
Public function void

MultilayerProjectorRemoveVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::RemoveVirtualLayer.
Public function void

MultilayerProjectorUpdateLayer ( const FName& ProjectorParamName,
int32 Index,
const FMultilayerProjectorLayer& Layer
)

 See FMultilayerProjector::UpdateLayer.
Public function void

MultilayerProjectorUpdateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id,
const FMultilayerProjectorVirtualLayer& Layer
)

 See FMultilayerProjector::UpdateVirtualLayer.
Public function void Update all parameters to be up to date with the Mutable Core parameters.
Public function void

RemoveMultilayerProjector ( const FName& ProjectorParamName
)

 Given Multilayer Projector name, remove a Multilayer Projector Helper.
Public function int32

RemoveValueFromFloatRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the float range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left.
Public function int32

RemoveValueFromFloatRange ( const FString& ParamName
)

 Remove the last of the float range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left.
Public function int32

RemoveValueFromIntRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the integer range of values from the parameter ParamName, returns the index of the last valid integer, -1 if no values left.
Public function int32

RemoveValueFromIntRange ( const FString& ParamName
)

 Remove the last of the integer range of values from the parameter ParamName, returns the index of the last valid integer, -1 if no values left.
Public function int32

RemoveValueFromProjectorRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the projector range of values from the parameter ParamName, returns the index of the last valid projector, -1 if no values left.
Public function int32

RemoveValueFromProjectorRange ( const FString& ParamName
)

 Remove the last of the projector range of values from the parameter ParamName, returns the index of the last valid projector, -1 if no values left.
Public function int32

RemoveValueFromTextureRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the texture range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left.
Public function 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.
Public function void

SaveDescriptor ( FArchive& Ar,
bool bUseCompactDescriptor
)

 Serialize this object.
Public function void

SetBoolParameterSelectedOption ( const FString& BoolParamName,
bool BoolValue
)

 Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName".
Public function void  
Public function void

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

 Sets the color value "ColorValue" of a color parameter with index "ColorParamIndex".
Public function void

SetCurrentState ( const FString& StateName
)

 Set the current optimization state.
Public function void

SetCustomizableObject ( UCustomizableObject& InCustomizableObject
)

  
Public function void

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

 Sets the float value "FloatValue" of a float parameter with index "FloatParamIndex".
Public function void

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

 Sets the selected option of an int parameter by the option's name.
Public function void

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

 Sets the selected option of an int parameter, by the option's name
Public function void

SetMaxLod ( int32 InMaxLOD
)

  
Public function void

SetMinLod ( int32 InMinLOD
)

  
Public function void

SetProjectorPosition ( const FString& ProjectorParamName,
const FVector3f& Pos,
int32 RangeIndex
)

 Set only the projector position.
Public function 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".
Public function void

SetRandomValues ( const int32& InRandomizationSeed
)

  
Public function void

SetRequestedLODLevels ( const TArray< uint16 >& InRequestedLODLevels
)

  
Public function void

SetState ( int32 InState
)

 Set the current optimization state.
Public function void

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

 Sets the texture value "TextureValue" of a texture parameter with index "TextureParamIndex".
Public function void

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

 Sets the vector value "VectorValue" of a bool parameter with index "VectorParamIndex".

Deprecated Functions

  Type Name Description
Public function void

SetTextureParameterSelectedOptionT ( const FString& TextureParamName,
UTexture2D* TextureValue,
int32 RangeIndex
)

 Use SetTextureParameterSelectedOption instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page