Navigation
API > API/Plugins > API/Plugins/ModelingComponentsEditorOnly
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UModelingObjectsCreationAPI
- UEditorModelingObjectsCreationAPI
References
| Module | ModelingComponentsEditorOnly |
| Header | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponentsEditorOnly/Public/EditorModelingObjectsCreationAPI.h |
| Include | #include "EditorModelingObjectsCreationAPI.h" |
Syntax
UCLASS ()
class UEditorModelingObjectsCreationAPI : public UModelingObjectsCreationAPI
Remarks
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
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FGetAssetPathNameCallbackSignature | GetNewAssetPathNameCallback | |
 |
FModelingActorCreatedSignature | OnModelingActorCreated | |
 |
FModelingMaterialCreatedSignature | OnModelingMaterialCreated | |
 |
FModelingMeshCreatedSignature | OnModelingMeshCreated | |
 |
FModelingTextureCreatedSignature | OnModelingTextureCreated |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FCreateMeshObjectResult | CreateDynamicMeshActor
(
FCreateMeshObjectParams&& CreateMeshParams |
|
 |
FCreateMeshObjectResult | CreateStaticMeshAsset
(
FCreateMeshObjectParams&& CreateMeshParams |
Internal implementations called by public functions |
 |
FCreateMeshObjectResult | CreateVolume
(
FCreateMeshObjectParams&& CreateMeshParams |
|
  |
bool | Deregister
(
UInteractiveToolsContext* ToolsContext |
|
 |
TArray< UMaterialInterface * > | FilterMaterials
(
const TArray< UMaterialInterface* >& MaterialsIn |
|
  |
UEditorModelingObjectsCreationAPI * | Find
(
UInteractiveToolsContext* ToolsContext |
|
 |
ECreateModelingObjectResult | GetNewAssetPath
(
FString& OutNewAssetPath, |
|
  |
UEditorModelingObjectsCreationAPI * | Register
(
UInteractiveToolsContext* ToolsContext |
Utility functions to handle registration/unregistration |
Overridden from UModelingObjectsCreationAPI
| Type | Name | Description | |
|---|---|---|---|
  |
FCreateMaterialObjectResult | CreateMaterialObject
(
FCreateMaterialObjectParams&& CreateMaterialParams |
|
  |
FCreateMaterialObjectResult | CreateMaterialObject
(
const FCreateMaterialObjectParams& CreateMaterialParams |
Create a new material object based on the data in CreateMaterialParams |
  |
FCreateMeshObjectResult | CreateMeshObject
(
FCreateMeshObjectParams&& CreateMeshParams |
|
  |
FCreateMeshObjectResult | CreateMeshObject
(
const FCreateMeshObjectParams& CreateMeshParams |
Create a new mesh object based on the data in CreateMeshParams |
  |
FCreateActorResult | CreateNewActor
(
FCreateActorParams&& CreateActorParams |
|
  |
FCreateActorResult | CreateNewActor
(
const FCreateActorParams& CreateActorParams |
Create a new material object based on the data in CreateMaterialParams |
  |
FCreateTextureObjectResult | CreateTextureObject
(
FCreateTextureObjectParams&& CreateTexParams |
|
  |
FCreateTextureObjectResult | CreateTextureObject
(
const FCreateTextureObjectParams& CreateTexParams |
Create a new texture object based on the data in CreateTexParams |
   |
bool | Non-UFunction variants that support std::move operators |
Typedefs
| Name | Description |
|---|---|
| FGetAssetPathNameCallbackSignature | Callbacks that editor can hook into to handle asset creation |
| FModelingActorCreatedSignature | |
| FModelingMaterialCreatedSignature | |
| FModelingMeshCreatedSignature | |
| FModelingTextureCreatedSignature |