Navigation
API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR
Inheritance Hierarchy
- RefCounted
- Resource
- Instance
References
| Module | MutableRuntime |
| Header | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Instance.h |
| Include | #include "MuR/Instance.h" |
Syntax
class Instance : public mu::Resource
Remarks
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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Instance () |
Life cycle. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
 |
~Instance () |
Forbidden. Manage with the Ptr<> template. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
Ptr< Instance > | Clone () |
Clone this instance. |
  |
void | FindBaseSurfaceBySharedId
(
int32 ComponentIndex, |
Find the base surface index and Lod index when reusing surfaces between LODs. |
  |
int32 | FindSurfaceById
(
int32 ComponentIndex, |
Find a surface index from the internal id (as returned by GetSurfaceId). |
  |
int32 | Get the number of components of this instance. | |
  |
uint16 | GetComponentId
(
int32 ComponentIndex |
Get the Id of a component |
  |
void | GetExtensionData
(
int32 Index, |
Get an ExtensionData value from a component |
  |
int32 | Get the number of ExtensionData values in a component. | |
  |
Instance::ID | GetId () |
Get a unique identifier for this instance. |
  |
int32 | GetImageCount
(
int32 ComponentIndex, |
Get the number of images in a component |
  |
FResourceID | GetImageId
(
int32 ComponentIndex, |
Get an image resource id from a component |
  |
FName | GetImageName
(
int32 ComponentIndex, |
Get the name of an image in a component |
  |
int32 | GetLODCount
(
int32 ComponentIndex |
Get the number of LODs in a component |
  |
FResourceID | GetMeshId
(
int32 ComponentIndex, |
Get the mesh resource id from a component |
  |
Private * | GetPrivate () |
|
  |
float | GetScalar
(
int32 ComponentIndex, |
Get a scalar value from a component |
  |
int32 | GetScalarCount
(
int32 ComponentIndex, |
Get the number of scalar values in a component |
  |
FName | GetScalarName
(
int32 ComponentIndex, |
Get the name of a scalar from a component |
  |
int32 | GetSharedSurfaceId
(
int32 ComponentIndex, |
Get an id that can be used to find the same surface on other LODs |
  |
FString | GetString
(
int32 ComponentIndex, |
Get a string value from a component |
  |
int32 | GetStringCount
(
int32 ComponentIndex, |
Get the number of string values in a component |
  |
FName | GetStringName
(
int32 ComponentIndex, |
Get the name of a string from a component |
  |
int32 | GetSurfaceCount
(
int32 ComponentIndex, |
Get the number of surfaces in a component |
  |
uint32 | GetSurfaceCustomId
(
int32 ComponentIndex, |
Get an optional, opaque application-defined identifier for this surface. |
  |
uint32 | GetSurfaceId
(
int32 ComponentIndex, |
Get an id that can be used to match the surface data with the mesh surface data. |
  |
FVector4f | GetVector
(
int32 ComponentIndex, |
Get a vector from a component |
  |
int32 | GetVectorCount
(
int32 ComponentIndex, |
Get the number of vectors in a component |
  |
FName | GetVectorName
(
int32 ComponentIndex, |
Get the name of a vector in a component |
Overridden from Resource
| Type | Name | Description | |
|---|---|---|---|
   |
int32 | GetDataSize () |
Return the size in bytes of all the LODs of the image. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
Private |
Typedefs
| Name | Description |
|---|---|
| ID | Type for the instance unique identifiers. |