1. Epic GamesDeveloper
  3. UCustomizableObjectSystem

UCustomizableObjectSystem

API > API/Plugins > API/Plugins/CustomizableObject > API/Plugins/CustomizableObject/MuCO

Inheritance Hierarchy

References

   
Module CustomizableObject
Header /Engine/Plugins/Experimental/Mutable/Source/CustomizableObject/Classes/MuCO/CustomizableObjectSystem.h
Include #include "MuCO/CustomizableObjectSystem.h"

Syntax

UCLASS&40;Blueprintable, BlueprintType&41;  
class UCustomizableObjectSystem : public UObject

Variables

  Type Name Description
Public variable UProperty Transient TObjectPtr< UCustomizableInstanceLODManagementBase > CurrentInstanceLODManagement  
Public variable UProperty Transient TObjectPtr< UCustomizableInstanceLODManagementBase > DefaultInstanceLODManagement  
Public variable FEditorCompileSettings EditorSettings Copy of the Mutable Editor Settings tied to CO compilation. They are updated whenever changed.
Public variable UProperty Transient TArray< TObjectPtr< UTexture2D > > ProtectedCachedTextures Array where textures are added temporarily while the mutable thread may want to reused them for some instance under construction.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void

AddUncompiledCOWarning ( const UCustomizableObject& InObject,
FString const* OptionalLogInfo
)

 Show a warning on-screen and via a notification (if in Editor) and log an error when a CustomizableObject is being used and it's not compiled.
Public function void

CacheImage ( FName ImageId
)

 [Texture Parameters] Interface to actually cache Images in the Mutable system and make them availabe at run-time.
Public function Const bool Checks if there are any outstading disk or mip update operations in flight for the parameter Customizable Object that may make it unsafe to compile at the moment.
Public function void  
Public function void [Texture Parameters] Remove all images from the cache.
Public function void Unprotect the resources in the instances of this object of being garbage collector while an instance is being built or updated, so that they can be reused.
Public function void

EditorSettingsChanged ( const FEditorCompileSettings& InEditorSettings
)

 Called whenever the Mutable Editor Settings change, copying the new value of the current needed settings to the Customizable Object System.
Public function void Enables the collection of internal mutabe performance data. It has a performance cost.
Public function void Writes the benchmark results.
Public function Const UFunction BlueprintCallable, Category int32 Return the average build/update time of an instance in ms.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category UCustomizableObjectSystem * Get the singleton object. It will be created if it doesn't exist yet.
Public function UCustomizableInstanceLODManagementBase *  
Public function uint64

GetMaxChunkSizeForPlatform ( const ITargetPlatform* InTargetPlatform
)

 Get the maximum size a chunk can have on a specific platform. If unspecified return MUTABLE_STREAMED_DATA_MAXCHUNKSIZE.
Public function FCustomizableObjectCompilerBase * Creates a new Customizable Object Compiler (Only does real work in editor builds). The caller is responsible for freeing the new compiler.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of instances built and alive.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of instances waiting to be updated.
Public function UDefaultImageProvider & Initialize (if was not already) and get the default image provider.
Public function Const UFunction BlueprintCallable, Category FString Find out the version of the plugin.
Public function Const const FCustomizableObjectSystemPrivate * Give access to the internal object data.
Public function FCustomizableObjectSystemPrivate * Give access to the internal object data.
Public function FCustomizableObjectSystemPrivate *  
Public function Const const FCustomizableObjectSystemPrivate *  
Public function FStreamableManager &  
Public function Const UFunction BlueprintCallable, Category int32 Get the amount of memory in use for textures generated by mutable.
Public function TArray< FCustomizableObjectExternalTexture > [Texture Parameters] Get a list of all the possible values for external texture parameters according to the various providers registered with RegisterImageProvider.
Public function Const UFunction BlueprintCallable, Category int32 Get the total number of instances includingbuilt and not built.
Public function void  
Public function Const bool If true, uncompiled Customizable Objects will be compiled synchronously.
Public function Const bool If true, uncompiled Customizable Objects will be compiled whenever an instance update is required.
Public function Const bool If compilation is disabled, Customizable Objects won't be compiled in the editor.
Public function Static bool Return true if the singleton has been created. It is different than GetInstance in that GetInstance will create it if it doesn't exist.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function bool Lock a CustomizableObjects, preventing the generation or update of any of its instances Will return true if successful, false if it fails to lock because an update is already underway This is usually only used in the editor
Public function Const void

LogShowData ( bool bFullInfo,
bool ShowMaterialInfo
)

 Show data about all UCustomizableObjectInstance existing elements.
Public function void  
Public function void

RecompileCustomizableObjectAsync ( const FAssetData& InAssetData,
const UCustomizableObject* InObject
)

  
Public function void  
Public function void [Texture Parameters] Add a new image provider to the CustomizableObject System.
Public function void Pass a null ptr to reset to the default InstanceLODManagement.
Public function void  
Public function void  
Public function void

SetProgressiveMipStreamingEnabled ( bool bIsEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetReleaseMutableTexturesImmediately ( bool bReleaseTextures
)

 If set to true, Mutable will release Mutable-generated textures immediately when they are no longer used without waiting for GC IMPORTANT!!! Do NOT keep references to any Mutable generated textures or skeletal meshes if this is enabled, they are owned by Mutable and will be destroyed without notice
Public function void  
Public function void

UnCacheImage ( FName ImageId
)

 [Texture Parameters] Remove an image from the cache.
Public function void  
Public function void [Texture Parameters] Remove a previously registered provider.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page