Navigation
API > API/Plugins > API/Plugins/MutableRuntime
A Model represents a customisable object with any number of parameters. When values are given to the parameters, specific Instances can be built, which hold the built application-usable data.
| Name | FModel |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Model.h |
| Include Path | #include "MuR/Model.h" |
Syntax
class FModel
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FEntity → FTopologicalEntity → FTopologicalShapeEntity → FModel
- FHaveStates → FEntity → FTopologicalEntity → FTopologicalShapeEntity → FModel
- FModel
- FSharedFromThisBase → TSharedFromThis → FModel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FModel() |
Life cycle. | MuR/Model.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FModel() |
Don't call directly. Manage with a TSharedPtr. | MuR/Model.h |
Classes
| Name | Remarks |
|---|---|
| Private |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| m_pD | Private * | MuR/Model.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 FindState
(
const FString& Name |
Find a state index by state name. | MuR/Model.h | |
bool GetBoolDefaultValue
(
int32 Index |
Return the default value of a boolean parameter. The parameter specified by index is a T_BOOL. | MuR/Model.h | |
void GetColourDefaultValue
(
int32 Index, |
Return the default value of a colour parameter. The parameter specified by index is a T_FLOAT. | MuR/Model.h | |
int32 GetConstantImageRomId
(
int32 ConstantImageIndex, |
Returns the ConstantImageIndex LODIndex rom id. | MuR/Model.h | |
float GetFloatDefaultValue
(
int32 Index |
Return the default value of a float parameter. The parameter specified by index is a T_FLOAT. | MuR/Model.h | |
FName GetImageDefaultValue
(
int32 Index |
Return the default value of an image parameter. The parameter specified by index is a T_IMAGE. | MuR/Model.h | |
int32 GetIntDefaultValue
(
int32 Index |
Return the default value of a integer parameter. The parameter specified by index is a T_INT. | MuR/Model.h | |
FMatrix44f GetMatrixDefaultValue
(
int32 Index |
Return the default value of a colour parameter. The parameter specified by index is a T_FLOAT. | MuR/Model.h | |
Private * GetPrivate() |
MuR/Model.h | ||
void GetProjectorDefaultValue
(
int32 Index, |
Return the default value of a projector parameter, as a 4x4 matrix. | MuR/Model.h | |
int32 GetRomCount() |
MuR/Model.h | ||
uint32 GetRomSize
(
int32 Index |
MuR/Model.h | ||
uint32 GetRomSourceId
(
int32 Index |
MuR/Model.h | ||
int32 GetStateCount() |
Get the number of states in the model. | MuR/Model.h | |
const FString & GetStateName
(
int32 StateIndex |
Get a state name by state index from 0 to GetStateCount-1. | MuR/Model.h | |
int32 GetStateParameterCount
(
int32 StateIndex |
Get the number of parameters available in a particular state. | MuR/Model.h | |
int32 GetStateParameterIndex
(
int32 StateIndex, |
Get the index of one of the parameters in the given state. | MuR/Model.h | |
bool HasExternalData () |
Return true if the model has external data in other files. | MuR/Model.h | |
void Invalidate () |
Invalidate the Model. | MuR/Model.h | |
bool IsMeshData
(
int32 Index |
MuR/Model.h | ||
bool IsParameterMultidimensional
(
int32 ParameterIndex |
Return true if the parameter is multi-dimensional | MuR/Model.h | |
bool IsRomHighRes
(
int32 Index |
MuR/Model.h | ||
bool IsValid() |
Return true unless the streamed resources were destroyed, which could happen in the editor after recompiling the CO. | MuR/Model.h | |
void UnloadExternalData() |
Free memory used by streaming data that may be loaded again when needed. | MuR/Model.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< FParameters > NewParameters
(
TSharedPtr< const FModel > Model, |
Create a set of new parameters of the model with the default values. | MuR/Model.h | |
static void Serialise
(
const FModel*, |
MuR/Model.h | ||
static void Serialise
(
FModel*, |
Special serialise operation that serialises the data in separate "files". | MuR/Model.h | |
static TSharedPtr< FModel > StaticUnserialise
(
FInputArchive& |
MuR/Model.h |