1. Epic GamesDeveloper
  3. FCreateMeshObjectParams

FCreateMeshObjectParams

[FCreateMeshObjectParams](API\Plugins\ModelingComponents\FCreateMeshObjectParams) is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateMeshObject().

API > API/Plugins > API/Plugins/ModelingComponents

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.

   
Name FCreateMeshObjectParams
Type struct
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/ModelingObjectsCreationAPI.h
Include Path #include "ModelingObjectsCreationAPI.h"

Syntax

USTRUCT (Blueprintable)  
struct FCreateMeshObjectParams

Constructors

Name Remarks Include Path Unreal Specifiers

FCreateMeshObjectParams ( bool bConstructWithDefaultModelingComponentSettings
)

   ModelingObjectsCreationAPI.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetMaterials TArray< TObjectPtr< UMaterialInterface > > Optional Materials for a newly-created Mesh Asset, if this is applicable for the created mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
BaseName FString The base name of the new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bEnableCollision bool Collision settings, if applicable for the given mesh object Specify whether the new mesh object should have collision support/data ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bEnableNanite bool Specify whether Nanite should be enabled on this new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bEnableRaytracingSupport bool Rendering Configuration Options, if this is applicable for the given mesh object Specify whether normals should be automatically recomputed for this new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bEnableRecomputeNormals bool Mesh Build Options, if this is applicable for the given mesh object (Currently somewhat specific to Assets in the Editor) Specify whether normals should be automatically recomputed for this new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bEnableRecomputeTangents bool Specify whether tangents should be automatically recomputed for this new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
bGenerateLightmapUVs bool Specify whether to auto-generate Lightmap UVs (if applicable for the output mesh type) ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
CollisionMode TEnumAsByte< enum ECollisionTraceFlag > Which Collision mode to enable on the new mesh object, if supported ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
CollisionShapeSet TOptional< UE::Geometry::FSimpleShapeSet3d > Collision Shapes ModelingObjectsCreationAPI.h  
DynamicMesh TOptional< UE::Geometry::FDynamicMesh3 >   ModelingObjectsCreationAPI.h  
Materials TArray< TObjectPtr< UMaterialInterface > > Materials settings Materials for the new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
MeshDescription TOptional< FMeshDescription >   ModelingObjectsCreationAPI.h  
MeshType ECreateMeshObjectSourceMeshType The Mesh Object should be created based on the mesh data structures below. ModelingObjectsCreationAPI.h  
NaniteSettings FMeshNaniteSettings Specify the Nanite Settings for this new mesh object, only used if bEnableNanite=true ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
SourceComponent TObjectPtr< UPrimitiveComponent > Base data A Source Component the new mesh is based on, if such a Component exists ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
TargetWorld TObjectPtr< UWorld > The World/Level the new mesh object should be created in (if known) ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
Transform FTransform The 3D local-to-world transform for the new mesh object ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
TypeHint ECreateObjectTypeHint A suggested type for the newly-created Mesh (possibly ignored) ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
TypeHintClass TObjectPtr< UClass > A suggested UClass type for the newly-created Object (possibly ignored) ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere
TypeHintExtended int32 An arbitrary integer that can be used to pass data to an API implementation ModelingObjectsCreationAPI.h
  • Category="CreateMeshObjectParams"
  • EditAnywhere

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetMesh ( FMeshDescription&& MeshDescriptionIn
)

   ModelingObjectsCreationAPI.h  

void SetMesh ( const UE::Geometry::FDynamicMesh3* DynamicMeshIn
)

   ModelingObjectsCreationAPI.h  

void SetMesh ( UE::Geometry::FDynamicMesh3&& DynamicMeshIn
)

   ModelingObjectsCreationAPI.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
NaniteProxyTrianglePercent_DEPRECATED float Specify the Nanite proxy triangle percentage for this new mesh object ModelingObjectsCreationAPI.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Replaced NaniteProxyTrianglePercent with usage of Engine FMeshNaniteSettings")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page