IToolsContextAssetAPI

Users of the Tools Framework need to provide an [IToolsContextAssetAPI](API\Runtime\InteractiveToolsFramework\IToolsContextAssetAPI) implementation that allows Packages and Assets to be created/saved.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/ToolContextInterfaces.h

Include

#include "ToolContextInterfaces.h"

Syntax

class IToolsContextAssetAPI

Remarks

Users of the Tools Framework need to provide an IToolsContextAssetAPI implementation that allows Packages and Assets to be created/saved.

that this is not strictly necessary, for example a trivial implementation could just store things in the Transient package and not do any saving.

Destructors

Name Description

Public function Virtual

~IToolsContextAssetAPI()

Functions

Name Description

Public function

void

 

AutoSaveGeneratedAsset

(
    UObject* Asset,
    UPackage* AssetPackage
)

Autosave asset to persistent storage

Public function

AActor *

 

GenerateStaticMeshActor

(
    UWorld* TargetWorld,
    FTransform Transform,
    FString ObjectBaseName,
    FGeneratedStaticMeshAssetConfig&& ...
)

Create a new UStaticMeshAsset for the provided mesh, then a new UStaticMeshComponent and AStaticMeshActor in the TargetWorld

Public function

FString

 

GetActiveAssetFolderPath()

Get a "currently-visible/selected" location to save assets in.

Public function

FString

 

GetWorldRelativeAssetRootPath

(
    const UWorld* World
)

Get a path to save assets in that is relative to the given UWorld.

Public function

void

 

InteractiveSaveGeneratedAsset

(
    UObject* Asset,
    UPackage* AssetPackage
)

Request saving of asset to persistent storage via something like an interactive popup dialog

Public function

FString

 

InteractiveSelectAssetPath

(
    const FString& DefaultAssetName,
    const FText& DialogTitleMessage
)

Allow the user to select a path and filename for an asset using a modal dialog

Public function

UPackage ...

 

MakeNewAssetPackage

(
    const FString& FolderPath,
    const FString& AssetBaseName,
    FString& UniqueAssetNameOut
)

Creates a new package for an asset

Public function

void

 

NotifyGeneratedAssetModified

(
    UObject* Asset,
    UPackage* AssetPackage
)

Notify that asset has been created and is dirty

Public function Virtual

bool

 

SaveGeneratedTexture2D

(
    UTexture2D* GeneratedTexture,
    FString ObjectBaseName,
    const UObject* RelativeToAsset
)

Save a generated UTexture2D as an Asset.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss