Navigation
API > API/Plugins > API/Plugins/MutableRuntime
Type used to set or read multi-dimensional parameter values. If parameters have multiple values because of ranges, FRangeIndex can be used to specify what value is read or set in the methods of the Parameter class. FRangeIndex objects can be reused in multiple calls for the same parameter in the Parameter class interface even after changing the position values.
| Name | FRangeIndex |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Parameters.h |
| Include Path | #include "MuR/Parameters.h" |
Syntax
class FRangeIndex
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRangeIndex() |
Instances of this class must be obtained from a FParameters instance. | MuR/Parameters.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Parameter | int32 | Index of the parameter for which we are a range index. | MuR/Parameters.h | |
| Parameters | TSharedPtr< const FParameters > | Run-time data. | MuR/Parameters.h | |
| Values | TArray< int32 > | Position in the several dimension of the range, as defined in Parameters. | MuR/Parameters.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetPosition
(
int32 Index |
Return the position in one of the dimensions of the index. | MuR/Parameters.h | |
int32 GetRangeCount() |
Return the number of ranges (or dimensions) used by this index. | MuR/Parameters.h | |
const FString & GetRangeName
(
int32 Index |
Return the name of a range. | MuR/Parameters.h | |
const FString & GetRangeUid
(
int32 Index |
Return the Guid of the parameter, resistant to parameter name changes. | MuR/Parameters.h | |
void SetPosition
(
int32 Index, |
Set the position in one of the dimensions of the index. | MuR/Parameters.h |