Navigation
API > API/Plugins > API/Plugins/ModelingComponents
UModelingObjectsCreationAPI is a base interface for functions that can be used to create various types of objects from Modeling Tools, or other sources. The "type" is very generic here - "Mesh", "Texture", etc - because this API is meant to provide an abstraction for Tools to emit different types of objects in different situations. For example an Tool might emit StaticMesh Asset/Actors in-Editor, but ProceduralMeshComponents at Runtime.
The creation inputs are specified via the structs above (eg FCreateMeshObjectParams, FCreateTextureObjectParams), which are very extensive, kitchen-sink sort of structs. Generally "New Mesh Object" creation behavior will be very complex and so this API is really just a way to route the data, and very few guarantees can be made about any specific implementation.
The assumed (but not really required) usage of instances of this type are that they will be registered with an InteractiveToolsContext's ContextObjectStore, and then fetched from there by Tools/Algorithms/etc that need to use these capabilities can use the UE::Modeling::CreateXObject() helper functions below. However the interface does not have any dependencies on this usage model.
See UEditorModelingObjectsCreationAPI for an example implementation suitable for in-Editor use.
| Name | UModelingObjectsCreationAPI |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/ModelingObjectsCreationAPI.h |
| Include Path | #include "ModelingObjectsCreationAPI.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType)
class UModelingObjectsCreationAPI : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UModelingObjectsCreationAPI
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FCreateMaterialObjectResult CreateMaterialObject
(
const FCreateMaterialObjectParams& CreateMaterialParams |
Create a new material object based on the data in CreateMaterialParams | ModelingObjectsCreationAPI.h |
|
virtual FCreateMaterialObjectResult CreateMaterialObject
(
FCreateMaterialObjectParams&& CreateMaterialParams |
ModelingObjectsCreationAPI.h | ||
virtual FCreateMeshObjectResult CreateMeshObject
(
const FCreateMeshObjectParams& CreateMeshParams |
Create a new mesh object based on the data in CreateMeshParams | ModelingObjectsCreationAPI.h |
|
virtual FCreateMeshObjectResult CreateMeshObject
(
FCreateMeshObjectParams&& CreateMeshParams |
ModelingObjectsCreationAPI.h | ||
virtual FCreateActorResult CreateNewActor
(
const FCreateActorParams& CreateActorParams |
Create a new material object based on the data in CreateMaterialParams | ModelingObjectsCreationAPI.h |
|
virtual FCreateActorResult CreateNewActor
(
FCreateActorParams&& CreateActorParams |
ModelingObjectsCreationAPI.h | ||
virtual FCreateComponentResult CreateNewComponentOnActor
(
const FCreateComponentParams& CreateComponentParams |
Create a new component on the specified actor of the requested class. | ModelingObjectsCreationAPI.h |
|
virtual FCreateComponentResult CreateNewComponentOnActor
(
FCreateComponentParams&& CreateComponentParams |
ModelingObjectsCreationAPI.h | ||
virtual FCreateTextureObjectResult CreateTextureObject
(
const FCreateTextureObjectParams& CreateTexParams |
Create a new texture object based on the data in CreateTexParams | ModelingObjectsCreationAPI.h |
|
virtual FCreateTextureObjectResult CreateTextureObject
(
FCreateTextureObjectParams&& CreateTexParams |
ModelingObjectsCreationAPI.h | ||
virtual bool HasMoveVariants () |
Non-UFunction variants that support std::move operators If this function returns true, then the CreateMeshObject() and CreateTextureObject() that take && types can be called. | ModelingObjectsCreationAPI.h |