unreal.ModelingObjectsCreationAPI

class unreal.ModelingObjectsCreationAPI(outer=None, name='None')

Bases: unreal.Object

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.

C++ Source:

• Plugin: MeshModelingToolset

• Module: ModelingComponents

• File: ModelingObjectsCreationAPI.h

create_mesh_object(create_mesh_params) → CreateMeshObjectResult

Create a new mesh object based on the data in CreateMeshParams

Parameters

create_mesh_params (CreateMeshObjectParams) –

Returns

a results data structure, containing a result code and information about any new objects created

Return type

CreateMeshObjectResult

create_texture_object(create_tex_params) → CreateTextureObjectResult

Create a new texture object based on the data in CreateTexParams

Parameters

create_tex_params (CreateTextureObjectParams) –

Returns

a results data structure, containing a result code and information about any new objects created

Return type

CreateTextureObjectResult