1. Epic GamesDeveloper
  3. Model

Model

A [Model](API\Plugins\MutableRuntime\MuR\Model) represents a customisable object with any number of parameters.

API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR

References

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

Syntax

class Model

Remarks

When values are given to the parameters, specific Instances can be built, which hold the built application-usable data.

Constructors

  Type Name Description
Public function  

Model ()

 Life cycle.

Destructors

  Type Name Description
Public function  

~Model ()

 Don't call directly. Manage with a TSharedPtr.

Functions

  Type Name Description
Public function Const int

FindState ( const char* strName
)

 Find a state index by state name.
Public function Const bool

GetBoolDefaultValue ( int32 Index
)

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

GetColourDefaultValue ( int32 Index,
float* R,
float* G,
float* B
)

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

GetFloatDefaultValue ( int32 Index
)

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

GetImageDefaultValue ( int32 Index
)

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

GetIntDefaultValue ( int32 Index
)

 Return the default value of a integer parameter. The parameter specified by index is a T_INT.
Public function Const Private *  
Public function Const void

GetProjectorDefaultValue ( int32 Index,
PROJECTOR_TYPE* OutProjectionType,
FVector3f* OutPos,
FVector3f* OutDir,
FVector3f* OutUp,
FVector3f* OutScale,
float* OutProjectionAngle
)

 Return the default value of a projector parameter, as a 4x4 matrix.
Public function Const int32  
Public function Const uint32

GetRomId ( int32 Index
)

  
Public function Const uint32

GetRomSize ( int32 Index
)

  
Public function Const int Get the number of states in the model.
Public function Const const char *

GetStateName ( int stateIndex
)

 Get a state name by state index from 0 to GetStateCount-1.
Public function Const int

GetStateParameterCount ( int stateIndex
)

 Get the number of parameters available in a particular state.
Public function Const int

GetStateParameterIndex ( int stateIndex,
int paramIndex
)

 Get the index of one of the parameters in the given state.
Public function Const bool Return true if the model has external data in other files.
Public function Const bool

IsParameterMultidimensional ( int32 ParameterIndex
)

 Return true if the parameter is multi-dimensional
Public function Static ParametersPtr

NewParameters ( TSharedPtr< const Model > Model,
const Parameters* pOld
)

 Create a set of new parameters of the model with the default values.
Public function Static void

Serialise ( const Model* p,
OutputArchive& arch
)

  
Public function Static void

Serialise ( Model* p,
ModelWriter& arch
)

 Special serialise operation that serialises the data in separate "files".
Public function Static TSharedPtr< Model >  
Public function void Free memory used by streaming data that may be loaded again when needed.

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