Instance | Unreal Engine 5.2 Documentation

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

Inheritance Hierarchy

References


Module	MutableRuntime
Header	/Engine/Plugins/Experimental/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
InstancePtr	Clone ()	Clone this instance.
void	FindBaseSurfaceBySharedId ( int32 CompIndex, int32 SharedId, int32& OutSurfaceIndex, int32& OutLODIndex )	Find the base surface index and Lod index when reusing surfaces between LODs.
int32	FindSurfaceById ( int32 lod, int32 comp, uint32 id )	Find a surface index from the internal id (as returned by GetSurfaceId).
int32	GetComponentCount ( int32 lod )	Get the number of components in a level-of-detail
uint16	GetComponentId ( int32 lod, int32 comp )	Get the Id of a component
const char *	GetComponentName ( int32 lod, int32 comp )	Get the name of a component
void	GetExtensionData ( int32 Index, ExtensionDataPtrConst& OutExtensionData, const char*& OutName )	Get an ExtensionData value from a component
int32	GetExtensionDataCount ()	Get the number of ExtensionData values in a component.
Instance::ID	GetId ()	Get a unique identifier for this instance.
int32	GetImageCount ( int32 lod, int32 comp, int32 surf )	Get the number of images in a component
FResourceID	GetImageId ( int32 lod, int32 comp, int32 surf, int32 img )	Get an image resource id from a component
const char *	GetImageName ( int32 lod, int32 comp, int32 surf, int32 img )	Get the name of an image in a component
int32	GetLODCount ()	Get the number of levels-of-detail of this instance.
int32	GetMeshCount ( int32 lod, int32 comp )	Get the number of meshes in a surface
FResourceID	GetMeshId ( int32 lod, int32 comp, int32 mesh )	Get a mesh resource id from a component
Private *	GetPrivate ()
float	GetScalar ( int32 lod, int32 comp, int32 surf, int32 sca )	Get a scalar value from a component
int32	GetScalarCount ( int32 lod, int32 comp, int32 surf )	Get the number of scalar values in a component
const char *	GetScalarName ( int32 lod, int32 comp, int32 surf, int32 sca )	Get the name of a scalar from a component
int32	GetSharedSurfaceId ( int32 lod, int32 comp, int32 surf )	Get an id that can be used to find the same surface on other LODs
const char *	GetString ( int32 lod, int32 comp, int32 surf, int32 str )	Get a string value from a component
int32	GetStringCount ( int32 lod, int32 comp, int32 surf )	Get the number of string values in a component
const char *	GetStringName ( int32 lod, int32 comp, int32 surf, int32 str )	Get the name of a string from a component
int32	GetSurfaceCount ( int32 lod, int32 comp )	Get the number of surfaces in a component
uint32	GetSurfaceCustomId ( int32 lod, int32 comp, int32 surf )	Get an optional, opaque application-defined identifier for this surface.
uint32	GetSurfaceId ( int32 lod, int32 comp, int32 surf )	Get an id that can be used to match the surface data with the mesh surface data.
const char *	GetSurfaceName ( int32 lod, int32 comp, int32 surf )	Get the name of a surface
FVector4f	GetVector ( int32 lod, int32 comp, int32 surf, int32 vec )	Get a vector from a component
int32	GetVectorCount ( int32 lod, int32 comp, int32 surf )	Get the number of vectors in a component
const char *	GetVectorName ( int32 lod, int32 comp, int32 surf, int32 vec )	Get the name of a vector in a component