1. Epic GamesDeveloper
  3. System

System

Main system class to load models and build instances.

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

Inheritance Hierarchy

References

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

Syntax

class System : public mu::RefCounted

Remarks

Main system class to load models and build instances.

Constructors

  Type Name Description
Public function  

System ( const System&
)

 Prevent copy, move and assignment.
Public function  

System ( System&&
)

  
Public function  

System ( const Ptr< Settings >& Settings,
const TSharedPtr< ExtensionDataStreamer >& DataStreamer
)

 Constructor of a system object to build data.

Destructors

  Type Name Description
Protected function  

~System ()

 Forbidden. Manage with the Ptr<> template.

Functions

  Type Name Description
Public function const Instance *

BeginUpdate ( Instance::ID InstanceID,
const Ptr< const Parameters >& Params,
int32 StateIndex,
uint32 LodMask
)

 Update an instance with a new parameter set and/or state.
Public function void Removes all the possible working memory regardless of the budget set.
Public function void

EndUpdate ( Instance::ID InstanceID
)

 Invalidate and free the last Instance data returned by a call to BeginUpdate with the same instance index.
Public function Ptr< const Image >

GetImage ( Instance::ID InstanceID,
FResourceID ImageId,
int32 MipsToSkip,
int32 LOD
)

 Only valid between BeginUpdate and EndUpdate
Public function void

GetImageDesc ( Instance::ID InstanceID,
FResourceID ImageId,
FImageDesc& OutDesc
)

 Only valid between BeginUpdate and EndUpdate Calculate the description of an image, without generating it.
Public function Ptr< const Mesh >

GetMesh ( Instance::ID InstanceID,
FResourceID MeshId
)

 Only valid between BeginUpdate and EndUpdate.
Public function void

GetParameterRelevancy ( Instance::ID InstanceID,
const Ptr< const Parameters >& Parameters,
bool* Flags
)

 Calculate the relevancy of every parameter.
Public function Const Private *  
Public function Instance::ID

NewInstance ( const TSharedPtr< const Model >& Model
)

 Create a new instance from the given model.
Public function void

ReleaseInstance ( Instance::ID InstanceID
)

 Completely destroy an instance.
Public function void

SetGeneratedCacheSize ( uint32 InCount
)

 Set the amount of generated resources keys that will be stored for resource reusal.
Public function void Set a new provider for external image data.
Public function void Set a new provider for model data.
Public function void

SetWorkingMemoryBytes ( uint64 Bytes
)

 Set the working memory limit, overrding any set in the settings when the system was created.

Operators

  Type Name Description
Public function System &

operator= ( const System&
)

  
Public function System &  

Classes

  Type Name Description
Public class Private    

Constants

Name Description
AllLODs This constant can be used in place of the lodMask in methods like BeginUpdate.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page