class unreal.CreateMeshObjectParams

Bases: unreal.StructBase

FCreateMeshObjectParams is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateMeshObject(). Not all data necessarily needs to be specified, this will depend on the particular implementation. The comments below are representative of how this data structure is used in the Tools and API implementation(s) provided with Unreal Engine, but end-user implementors could abuse these fields as necessary.

The definition of a “mesh object” is implementation-specific.

C++ Source:

  • Plugin: MeshModelingToolset

  • Module: ModelingComponents

  • File: ModelingObjectsCreationAPI.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_materials (Array(MaterialInterface)): [Read-Write] Asset Materials: Optional Materials for a newly-created Mesh Asset, if this is applicable for the created mesh object

  • base_name (str): [Read-Write] Base Name: The base name of the new mesh object

  • collision_mode (CollisionTraceFlag): [Read-Write] Collision Mode: Which Collision mode to enable on the new mesh object, if supported

  • enable_collision (bool): [Read-Write] Enable Collision: Specify whether the new mesh object should have collision support/data

  • enable_nanite (bool): [Read-Write] Enable Nanite: Specify whether Nanite should be enabled on this new mesh object

  • enable_raytracing_support (bool): [Read-Write] Enable Raytracing Support: Specify whether normals should be automatically recomputed for this new mesh object

  • enable_recompute_normals (bool): [Read-Write] Enable Recompute Normals: Specify whether normals should be automatically recomputed for this new mesh object

  • enable_recompute_tangents (bool): [Read-Write] Enable Recompute Tangents: Specify whether tangents should be automatically recomputed for this new mesh object

  • materials (Array(MaterialInterface)): [Read-Write] Materials: Materials for the new mesh object

  • nanite_proxy_triangle_percent (float): [Read-Write] Nanite Proxy Triangle Percent: Specify the Nanite proxy triangle percentage for this new mesh object

  • source_component (PrimitiveComponent): [Read-Write] Source Component: A Source Component the new mesh is based on, if such a Component exists

  • target_world (World): [Read-Write] Target World: The World/Level the new mesh object should be created in (if known)

  • transform (Transform): [Read-Write] Transform: The 3D local-to-world transform for the new mesh object

  • type_hint (CreateObjectTypeHint): [Read-Write] Type Hint: A suggested type for the newly-created Mesh (possibly ignored)

  • type_hint_class (type(Class)): [Read-Write] Type Hint Class: A suggested UClass type for the newly-created Object (possibly ignored)

  • type_hint_extended (int32): [Read-Write] Type Hint Extended: An arbitrary integer that can be used to pass data to an API implementation