Navigation
API > API/Plugins > API/Plugins/MutableRuntime > API/Plugins/MutableRuntime/MuR
Inheritance Hierarchy
- Base
- RefCounted
- System
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 | |
|---|---|---|---|
| Prevent copy, move and assignment. | |||
System
(
const Ptr< Settings >& Settings, |
Constructor of a system object to build data. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
~System () |
Forbidden. Manage with the Ptr<> template. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const Instance * | BeginUpdate
(
Instance::ID InstanceID, |
Update an instance with a new parameter set and/or state. | |
| void | Removes all the possible working memory regardless of the budget set. | ||
| void | EndUpdate
(
Instance::ID InstanceID |
Invalidate and free the last Instance data returned by a call to BeginUpdate with the same instance index. | |
| Ptr< const Image > | GetImage
(
Instance::ID InstanceID, |
Only valid between BeginUpdate and EndUpdate | |
| void | GetImageDesc
(
Instance::ID InstanceID, |
Only valid between BeginUpdate and EndUpdate Calculate the description of an image, without generating it. | |
| Ptr< const Mesh > | GetMesh
(
Instance::ID InstanceID, |
Only valid between BeginUpdate and EndUpdate. | |
| void | GetParameterRelevancy
(
Instance::ID InstanceID, |
Calculate the relevancy of every parameter. | |
| Private * | GetPrivate () |
||
| Instance::ID | NewInstance
(
const TSharedPtr< const Model >& Model |
Create a new instance from the given model. | |
| void | ReleaseInstance
(
Instance::ID InstanceID |
Completely destroy an instance. | |
| void | SetGeneratedCacheSize
(
uint32 InCount |
Set the amount of generated resources keys that will be stored for resource reusal. | |
| void | SetImageParameterGenerator
(
const TSharedPtr< ImageParameterGenerator >& |
Set a new provider for external image data. | |
| void | SetStreamingInterface
(
const TSharedPtr< ModelReader >& |
Set a new provider for model data. | |
| void | SetWorkingMemoryBytes
(
uint64 Bytes |
Set the working memory limit, overrding any set in the settings when the system was created. |
Operators
Classes
| Type | Name | Description | |
|---|---|---|---|
| Private |
Constants
| Name | Description |
|---|---|
| AllLODs | This constant can be used in place of the lodMask in methods like BeginUpdate. |