1. Epic GamesDeveloper
  3. FParameters

FParameters

This class represents the parameters of a model including description, type and value, and additional resources associated to the parameter.

API > API/Plugins > API/Plugins/MutableRuntime

Warnings * Every object of this class holds a reference to the model that it was created from. This implies that while any instance of a FParameters object is alive, its model will not be freed.

This class represents the parameters of a model including description, type and value, and additional resources associated to the parameter.

Every object of this class holds a reference to the model that it was created from. This implies that while any instance of a FParameters object is alive, its model will not be freed.

   
Name FParameters
Type class
Header File /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Parameters.h
Include Path #include "MuR/Parameters.h"

Syntax

class FParameters : public TSharedFromThis< FParameters >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FParameters()

 Life cycle. MuR/Parameters.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FParameters()

   MuR/Parameters.h  

Classes

Name Remarks
Private  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
m_pD Private *   MuR/Parameters.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearAllValues ( int32 ParamIndex
)

 Remove all the multidimensional values for a parameter. The current non-dimensional value is kept. MuR/Parameters.h  

TSharedPtr< FParameters > Clone()

 Deep clone this object. MuR/Parameters.h  

int32 Find ( const FString& Name
) const

 Find the parameter index by name. It returns -1 if the parameter doesn't exist. MuR/Parameters.h  

bool GetBoolValue ( int32 Index,
const FRangeIndex* Pos
) const

 Return the value of a boolean parameter. The parameter specified by index is a T_BOOL. MuR/Parameters.h  

void GetColourValue ( int32 Index,
FVector4f& OutColor,
const FRangeIndex* Pos
) const

 Return the value of a colour parameter. The parameter specified by index is a T_FLOAT. MuR/Parameters.h  

int32 GetCount()

 Return the number of parameters. MuR/Parameters.h  

float GetFloatValue ( int32 Index,
const FRangeIndex* Pos
) const

 Return the value of a float parameter. The parameter specified by index is a T_FLOAT. MuR/Parameters.h  

FName GetImageValue ( int32 Index,
const FRangeIndex* Pos
) const

 Return the value of an image parameter. The parameter specified by index is a T_IMAGE. MuR/Parameters.h  

int32 GetIntPossibleValue ( int32 ParamIndex,
int32 ValueIndex
) const

 Get the value of one of the possible values for this integer. MuR/Parameters.h  

int32 GetIntPossibleValueCount ( int32 ParamIndex
) const

 Get the number of possible values for this integer parameter. MuR/Parameters.h  

const FString & GetIntPossibleValueName ( int32 ParamIndex,
int32 ValueIndex
) const

 Get the name of one of the possible values for this integer. MuR/Parameters.h  

int32 GetIntValue ( int32 Index,
const FRangeIndex* Pos
) const

 Return the value of a integer parameter. The parameter specified by index is a T_INT. MuR/Parameters.h  

int32 GetIntValueIndex ( int32 ParamIndex,
const FString& ValueIndex
) const

 Get the index of the value of one of the possible values for this integer. MuR/Parameters.h  

int32 GetIntValueIndex ( int32 ParamIndex,
int32 Value
) const

 Get the index of the value of one of the possible values for this integer. MuR/Parameters.h  

void GetMatrixValue ( int32 Index,
FMatrix44f& OutValue,
const FRangeIndex*
) const

 Return the value of a matrix parameter. The parameter specified by index is a T_MATRIX. MuR/Parameters.h  

FName GetMeshValue ( int32 Index,
const FRangeIndex* Pos
) const

   MuR/Parameters.h  

const FString & GetName ( int32 Index
) const

 Return the name of the parameter. MuR/Parameters.h  

Private * GetPrivate()

   MuR/Parameters.h  

void GetProjectorValue ( int32 ParameterIndex,
EProjectorType* OutProjectionType,
FVector3f* OutPos,
FVector3f* OutDir,
FVector3f* OutUp,
FVector3f* OutScale,
float* OutProjectionAngle,
const FRangeIndex* RangePosition
) const

 Return the value of a projector parameter, as a 4x4 matrix. MuR/Parameters.h  

void GetStringValue ( int32 Index,
FString& OutValue,
const FRangeIndex*
) const

 Return the value of a float parameter. The parameter specified by index is a T_FLOAT. MuR/Parameters.h  

EParameterType GetType ( int32 Index
) const

 Return the type of the parameter. MuR/Parameters.h  

const FGuid & GetUid ( int32 Index
) const

 Return the Guid of the parameter, resistant to parameter name changes. MuR/Parameters.h  

int32 GetValueCount ( int32 ParamIndex
) const

 Return the number of values other than the default that have been set to a specific parameter. MuR/Parameters.h  

TSharedPtr< FRangeIndex > GetValueIndex ( int32 ParamIndex,
int32 ValueIndex
) const

 Return the FRangeIndex of a value that has been set to a parameter. MuR/Parameters.h  

bool HasSameValue ( int32 ThisParamIndex,
const TSharedPtr< const FParameters >& Other,
int32 OtherParamIndex
) const

 Utility method to compare the values of a specific parameter with the values of another FParameters object. MuR/Parameters.h  

TSharedPtr< FRangeIndex > NewRangeIndex ( int32 ParamIndex
) const

 Create a new FRangeIndex object to use to access a multi-dimensional parameter. MuR/Parameters.h  

void SetBoolValue ( int32 Index,
bool bValue,
const FRangeIndex* Pos
)

 Set the value of a parameter of type boolean. The parameter specified by index is a T_BOOL. MuR/Parameters.h  

void SetColourValue ( int32 Index,
FVector4f Color,
const FRangeIndex* Pos
)

 If the parameter is of the colour type, set its value. MuR/Parameters.h  

void SetFloatValue ( int32 Index,
float Value,
const FRangeIndex* Pos
)

 If the parameter is of the float type, set its value. MuR/Parameters.h  

void SetImageValue ( int32 Index,
FName externalId,
const FRangeIndex*
)

 If the parameter is of the image type, set its value. MuR/Parameters.h  

void SetIntValue ( int32 Index,
int32 Value,
const FRangeIndex* Pos
)

 If the parameter is of the integer type, set its value. MuR/Parameters.h  

void SetMatrixValue ( int32 Index,
const FMatrix44f& Value,
const FRangeIndex* Pos
)

 If the parameter is of the matrix type, set its value. MuR/Parameters.h  

void SetMeshValue ( int32 Index,
FName externalId,
const FRangeIndex*
)

   MuR/Parameters.h  

void SetProjectorValue ( int32 ParameterIndex,
const FVector3f& Pos,
const FVector3f& Dir,
const FVector3f& Up,
const FVector3f& Scale,
float ProjectionAngle,
const FRangeIndex* RangePosition
)

 If the parameter is of the projector type, set its value. MuR/Parameters.h  

void SetStringValue ( int32 Index,
const FString& Value,
const FRangeIndex*
)

 If the parameter is of the float type, set its value. MuR/Parameters.h  

Static

Name Remarks Include Path Unreal Specifiers

static void Serialise ( const FParameters*,
FOutputArchive&
)

 Serialisation. MuR/Parameters.h  

static TSharedPtr< FParameters > StaticUnserialise ( FInputArchive&
)

   MuR/Parameters.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page