1. Epic GamesDeveloper
  3. Parameters

Parameters

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 > API/Plugins/MutableRuntime/MuR

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 Parameters object is alive, its model will not be freed.

Inheritance Hierarchy

References

   
Module MutableRuntime
Header /Engine/Plugins/Experimental/Mutable/Source/MutableRuntime/Public/MuR/Parameters.h
Include #include "MuR/Parameters.h"

Syntax

class Parameters : public mu::RefCounted

Remarks

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

Constructors

  Type Name Description
Protected function   Forbid creation. Instances of this class must be obtained from a Model instance.

Destructors

  Type Name Description
Protected function   Forbidden. Manage with the Ptr<> template.

Functions

  Type Name Description
Public function void

ClearAllValues ( int paramIndex
)

 Remove all the multidimensional values for a parameter. The current non-dimensional value is kept.
Public function Const ParametersPtr

Clone ()

 Deep clone this object.
Public function Const int

Find ( const char* strName
)

 Find the parameter index by name. It returns -1 if the parameter doesn't exist.
Public function Const bool

GetBoolValue ( int index,
const Ptr< const RangeIndex >& pos
)

 Return the value of a boolean parameter. The parameter specified by index is a T_BOOL.
Public function Const void

GetColourValue ( int index,
float* pR,
float* pG,
float* pB,
const Ptr< const RangeIndex >& pos
)

 Return the value of a colour parameter. The parameter specified by index is a T_FLOAT.
Public function Const int Return the number of parameters.
Public function Const PARAMETER_DETAILED_TYPE

GetDetailedType ( int index
)

 Return the additional type data of the parameter.
Public function Const float

GetFloatValue ( int index,
const Ptr< const RangeIndex >& pos
)

 Return the value of a float parameter. The parameter specified by index is a T_FLOAT.
Public function Const FName

GetImageValue ( int index,
const Ptr< const RangeIndex >& pos
)

 Return the value of an image parameter. The parameter specified by index is a T_IMAGE.
Public function Const int

GetIntPossibleValue ( int paramIndex,
int valueIndex
)

 Get the value of one of the possible values for this integer.
Public function Const int

GetIntPossibleValueCount ( int paramIndex
)

 Get the number of possible values for this integer parameter.
Public function Const const char *

GetIntPossibleValueName ( int paramIndex,
int valueIndex
)

 Get the name of one of the possible values for this integer.
Public function Const int

GetIntValue ( int index,
const Ptr< const RangeIndex >& pos
)

 Return the value of a integer parameter. The parameter specified by index is a T_INT.
Public function Const int

GetIntValueIndex ( int paramIndex,
const char* valueName
)

 Get the index of the value of one of the possible values for this integer.
Public function Const int

GetIntValueIndex ( int paramIndex,
int32 Value
)

 Get the index of the value of one of the possible values for this integer.
Public function Const const char *

GetName ( int index
)

 Return the name of the parameter.
Public function Const Private *  
Public function Const void

GetProjectorValue ( int ParameterIndex,
PROJECTOR_TYPE* OutProjectionType,
FVector3f* OutPos,
FVector3f* OutDir,
FVector3f* OutUp,
FVector3f* OutScale,
float* OutProjectionAngle,
const Ptr< const RangeIndex >& RangePosition
)

 Return the value of a projector parameter, as a 4x4 matrix.
Public function Const const char *

GetStringValue ( int index,
const Ptr< const RangeIndex >& pos
)

 Return the value of a float parameter. The parameter specified by index is a T_FLOAT.
Public function Const PARAMETER_TYPE

GetType ( int index
)

 Return the type of the parameter.
Public function Const const char *

GetUid ( int index
)

 Return the Guid of the parameter, resistant to parameter name changes.
Public function Const int

GetValueCount ( int paramIndex
)

 Return the number of values other than the default that have been set to a specific parameter.
Public function Const Ptr< RangeIndex >

GetValueIndex ( int paramIndex,
int valueIndex
)

 Return the RangeIndex of a value that has been set to a parameter.
Public function Const bool

HasSameValue ( int thisParamIndex,
const ParametersPtrConst& other,
int otherParamIndex
)

 Utility method to compare the values of a specific parameter with the values of another Parameters object.
Public function Const Ptr< RangeIndex >

NewRangeIndex ( int paramIndex
)

 Create a new RangeIndex object to use to access a multi-dimensional parameter.
Public function Static void

Serialise ( const Parameters* p,
OutputArchive& arch
)

 Life cycle.
Public function Static void Portable serialisation, which tries to keep values when:
Public function void

SetBoolValue ( int index,
bool value,
const Ptr< const RangeIndex >& pos
)

 Set the value of a parameter of type boolean. The parameter specified by index is a T_BOOL.
Public function void

SetColourValue ( int index,
float r,
float g,
float b,
const Ptr< const RangeIndex >& pos
)

 If the parameter is of the colour type, set its value.
Public function void

SetFloatValue ( int index,
float value,
const Ptr< const RangeIndex >& pos
)

 If the parameter is of the float type, set its value.
Public function void

SetImageValue ( int index,
FName externalId,
const Ptr< const RangeIndex >& pos
)

 If the parameter is of the image type, set its value.
Public function void

SetIntValue ( int index,
int value,
const Ptr< const RangeIndex >& pos
)

 If the parameter is of the integer type, set its value.
Public function void

SetProjectorValue ( int ParameterIndex,
const FVector3f& pos,
const FVector3f& dir,
const FVector3f& up,
const FVector3f& scale,
float projectionAngle,
const Ptr< const RangeIndex >& RangePosition
)

 If the parameter is of the projector type, set its value.
Public function void

SetStringValue ( int index,
const char* value,
const Ptr< const RangeIndex >& pos
)

 If the parameter is of the float type, set its value.
Public function Static ParametersPtr  
Public function Static ParametersPtr  

Classes

  Type Name Description
Public class Private    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page