Navigation
API > API/Plugins > API/Plugins/MutableRuntime
A customised object created from a model and a set of parameter values. It corresponds to an "engine object" but the contents of its data depends on the Model, and it may contain any number of LODs, components, surfaces, meshes and images, even none.
| Name | FInstance |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Instance.h |
| Include Path | #include "MuR/Instance.h" |
Syntax
class FInstance : public mu::FResource
Inheritance Hierarchy
- FResource → FInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInstance() |
Life cycle. | MuR/Instance.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FInstance() |
MuR/Instance.h |
Classes
| Name | Remarks |
|---|---|
| Private |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FID | uint32 | Type for the instance unique identifiers. | MuR/Instance.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| m_pD | Private * | MuR/Instance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FInstance > Clone() |
Clone this instance. | MuR/Instance.h | |
void FindBaseSurfaceBySharedId
(
int32 ComponentIndex, |
Find the base surface index and Lod index when reusing surfaces between LODs. | MuR/Instance.h | |
int32 FindSurfaceById
(
int32 ComponentIndex, |
Find a surface index from the internal id (as returned by GetSurfaceId). | MuR/Instance.h | |
int32 GetComponentCount() |
Get the number of components of this instance. | MuR/Instance.h | |
uint16 GetComponentId
(
int32 ComponentIndex |
Get the Id of a component | MuR/Instance.h | |
void GetExtensionData
(
int32 Index, |
Get an ExtensionData value from a component | MuR/Instance.h | |
int32 GetExtensionDataCount() |
Get the number of ExtensionData values in a component. | MuR/Instance.h | |
FInstance::FID GetId () |
Get a unique identifier for this instance. | MuR/Instance.h | |
int32 GetImageCount
(
int32 ComponentIndex, |
Get the number of images in a component | MuR/Instance.h | |
FResourceID GetImageId
(
int32 ComponentIndex, |
Get an image resource id from a component | MuR/Instance.h | |
FName GetImageName
(
int32 ComponentIndex, |
Get the name of an image in a component | MuR/Instance.h | |
int32 GetLODCount
(
int32 ComponentIndex |
Get the number of LODs in a component | MuR/Instance.h | |
FResourceID GetMeshId
(
int32 ComponentIndex, |
Get the mesh resource id from a component | MuR/Instance.h | |
int32 GetOverlayMaterial
(
int32 ComponentIndex |
Get the index of the overlay material. | MuR/Instance.h | |
Private * GetPrivate() |
MuR/Instance.h | ||
float GetScalar
(
int32 ComponentIndex, |
Get a scalar value from a component | MuR/Instance.h | |
int32 GetScalarCount
(
int32 ComponentIndex, |
Get the number of scalar values in a component | MuR/Instance.h | |
FName GetScalarName
(
int32 ComponentIndex, |
Get the name of a scalar from a component | MuR/Instance.h | |
int32 GetSharedSurfaceId
(
int32 ComponentIndex, |
Get an id that can be used to find the same surface on other LODs | MuR/Instance.h | |
FString GetString
(
int32 ComponentIndex, |
Get a string value from a component | MuR/Instance.h | |
int32 GetStringCount
(
int32 ComponentIndex, |
Get the number of string values in a component | MuR/Instance.h | |
FName GetStringName
(
int32 ComponentIndex, |
Get the name of a string from a component | MuR/Instance.h | |
int32 GetSurfaceCount
(
int32 ComponentIndex, |
Get the number of surfaces in a component | MuR/Instance.h | |
uint32 GetSurfaceCustomId
(
int32 ComponentIndex, |
Get an optional, opaque application-defined identifier for this surface. | MuR/Instance.h | |
uint32 GetSurfaceId
(
int32 ComponentIndex, |
Get an id that can be used to match the surface data with the mesh surface data. | MuR/Instance.h | |
FVector4f GetVector
(
int32 ComponentIndex, |
Get a vector from a component | MuR/Instance.h | |
int32 GetVectorCount
(
int32 ComponentIndex, |
Get the number of vectors in a component | MuR/Instance.h | |
FName GetVectorName
(
int32 ComponentIndex, |
Get the name of a vector in a component | MuR/Instance.h |
Overridden from FResource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetDataSize() |
Return the size in bytes of all the LODs of the image. | MuR/Instance.h |