Navigation
API > API/Plugins > API/Plugins/ModelingComponentsEditorOnly
Implementation of UModelingObjectsCreationAPI suitable for use in UE Editor.
- CreateMeshObject() currently creates a StaticMesh Asset/Actor, a Volume Actor or a DynamicMesh Actor
- CreateTextureObject() currently creates a UTexture2D Asset
- CreateMaterialObject() currently creates a UMaterial Asset
This is intended to be registered in the ToolsContext ContextObjectStore. Static utility functions Register() / Find() / Deregister() can be used to do this in a consistent way.
Several client-provided callbacks can be used to customize functionality (eg in Modeling Mode)
- GetNewAssetPathNameCallback is called to determine an asset path. This can be used to do things like pop up an interactive path-selection dialog, use project-defined paths, etc
- OnModelingMeshCreated is broadcast for each new created mesh object
- OnModelingTextureCreated is broadcast for each new created texture object
- OnModelingMaterialCreated is broadcast for each new created material object
| Name | UEditorModelingObjectsCreationAPI |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponentsEditorOnly/Public/EditorModelingObjectsCreationAPI.h |
| Include Path | #include "EditorModelingObjectsCreationAPI.h" |
Syntax
UCLASS ()
class UEditorModelingObjectsCreationAPI : public UModelingObjectsCreationAPI
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UModelingObjectsCreationAPI → UEditorModelingObjectsCreationAPI
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetAssetPathNameCallbackSignature | TBaseDelegate_ThreeParams< FString, const FString &BaseName, const UWorld *TargetWorld, FString SuggestedFolder > | Callbacks that editor can hook into to handle asset creation | EditorModelingObjectsCreationAPI.h |
| FModelingActorCreatedSignature | TMulticastDelegate_OneParam< void, const FCreateActorResult &CreatedInfo > | EditorModelingObjectsCreationAPI.h | |
| FModelingComponentCreatedSignature | TMulticastDelegate_OneParam< void, const FCreateComponentResult &CreatedInfo > | EditorModelingObjectsCreationAPI.h | |
| FModelingMaterialCreatedSignature | TMulticastDelegate_OneParam< void, const FCreateMaterialObjectResult &CreatedInfo > | EditorModelingObjectsCreationAPI.h | |
| FModelingMeshCreatedSignature | TMulticastDelegate_OneParam< void, const FCreateMeshObjectResult &CreatedInfo > | EditorModelingObjectsCreationAPI.h | |
| FModelingTextureCreatedSignature | TMulticastDelegate_OneParam< void, const FCreateTextureObjectResult &CreatedInfo > | EditorModelingObjectsCreationAPI.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GetNewAssetPathNameCallback | FGetAssetPathNameCallbackSignature | EditorModelingObjectsCreationAPI.h | ||
| OnModelingActorCreated | FModelingActorCreatedSignature | EditorModelingObjectsCreationAPI.h | ||
| OnModelingComponentCreated | FModelingComponentCreatedSignature | EditorModelingObjectsCreationAPI.h | ||
| OnModelingMaterialCreated | FModelingMaterialCreatedSignature | EditorModelingObjectsCreationAPI.h | ||
| OnModelingMeshCreated | FModelingMeshCreatedSignature | EditorModelingObjectsCreationAPI.h | ||
| OnModelingTextureCreated | FModelingTextureCreatedSignature | EditorModelingObjectsCreationAPI.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCreateMeshObjectResult CreateDynamicMeshActor
(
FCreateMeshObjectParams&& CreateMeshParams |
EditorModelingObjectsCreationAPI.h | ||
FCreateMeshObjectResult CreateStaticMeshAsset
(
FCreateMeshObjectParams&& CreateMeshParams |
Internal implementations called by public functions | EditorModelingObjectsCreationAPI.h | |
FCreateMeshObjectResult CreateVolume
(
FCreateMeshObjectParams&& CreateMeshParams |
EditorModelingObjectsCreationAPI.h | ||
TArray< UMaterialInterface * > FilterMaterials
(
const TArray< UMaterialInterface* >& MaterialsIn |
EditorModelingObjectsCreationAPI.h | ||
ECreateModelingObjectResult GetNewAssetPath
(
FString& OutNewAssetPath, |
EditorModelingObjectsCreationAPI.h |
Overridden from UModelingObjectsCreationAPI
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FCreateMaterialObjectResult CreateMaterialObject
(
FCreateMaterialObjectParams&& CreateMaterialParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateMaterialObjectResult CreateMaterialObject
(
const FCreateMaterialObjectParams& CreateMaterialParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateMeshObjectResult CreateMeshObject
(
const FCreateMeshObjectParams& CreateMeshParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateMeshObjectResult CreateMeshObject
(
FCreateMeshObjectParams&& CreateMeshParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateActorResult CreateNewActor
(
const FCreateActorParams& CreateActorParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateActorResult CreateNewActor
(
FCreateActorParams&& CreateActorParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateComponentResult CreateNewComponentOnActor
(
const FCreateComponentParams& CreateComponentParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateComponentResult CreateNewComponentOnActor
(
FCreateComponentParams&& CreateComponentParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateTextureObjectResult CreateTextureObject
(
const FCreateTextureObjectParams& CreateTexParams |
EditorModelingObjectsCreationAPI.h | ||
virtual FCreateTextureObjectResult CreateTextureObject
(
FCreateTextureObjectParams&& CreateTexParams |
EditorModelingObjectsCreationAPI.h | ||
virtual bool HasMoveVariants() |
Non-UFunction variants that support std::move operators | EditorModelingObjectsCreationAPI.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool Deregister
(
UInteractiveToolsContext* ToolsContext |
EditorModelingObjectsCreationAPI.h | ||
static UEditorModelingObjectsCreationAPI * Find
(
UInteractiveToolsContext* ToolsContext |
EditorModelingObjectsCreationAPI.h | ||
static UEditorModelingObjectsCreationAPI * Register
(
UInteractiveToolsContext* ToolsContext |
Utility functions to handle registration/unregistration | EditorModelingObjectsCreationAPI.h |