Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ModelingComponents

Light Theme

Dark Theme

ModelingComponents

Windows

MacOS

Linux

Filters

Classes

	Name	Description
	APreviewMeshActor	UPreviewMesh internally spawns a APreviewMeshActor to hold the preview mesh object.
	FDynamicMeshOpResult	FDynamicMeshOpResult is a container for a computed Mesh and Transform
	FModelingComponentsModule
	FSnapGeometry	FSnapGeometry stores information about geometry data of a snap, which we might use for highlights/etc
	TGenericDataBackgroundCompute	TGenericDataBackgroundCompute is an infrastructure object that implements a common UI pattern in interactive 3D tools, where we want to run an expensive parameterized computation (via a TGenericDataOperator) in a background thread so as to not block the UI.
	UBaseDynamicMeshComponent	UBaseDynamicMeshComponent is a base interface for a UMeshComponent based on a FDynamicMesh.
	UMeshOpPreviewWithBackgroundCompute	UMeshOpPreviewWithBackgroundCompute is an infrastructure object that implements a common UI pattern in interactive 3D tools, where we want to run an expensive computation on a mesh that is based on user-specified parameters, and show a preview of the result.
	UOctreeDynamicMeshComponent	UOctreeDynamicMeshComponent is a mesh component similar to UProceduralMeshComponent, except it bases the renderable geometry off an internal FDynamicMesh3 instance.
	UPreviewMesh	UPreviewMesh is a utility object that spawns and owns a transient mesh object in the World.
	USimpleDynamicMeshComponent	USimpleDynamicMeshComponent is a mesh component similar to UProceduralMeshComponent, except it bases the renderable geometry off an internal FDynamicMesh3 instance.

Typedefs

Name	Description
FBackgroundDynamicMeshComputeSource	FBackgroundDynamicMeshComputeSource is an instantiation of the TBackgroundModelingComputeSource template for FDynamicMeshOperator / IDynamicMeshOperatorFactory

Enums

	Name	Description
	EDynamicMeshTangentCalcType	Tangent calculation modes
	EMeshRenderAttributeFlags	EMeshRenderAttributeFlags is used to identify different mesh rendering attributes, for things like fast-update functions
	ToolSetupUtil::ImageMaterialType	Types of image-based material that we can create

Functions

	Name	Description
AActor *	AssetGenerationUtil::GenerateStaticMeshActor ( IToolsContextAssetAPI* AssetAP..., UWorld* TargetWorld, const FDynamicMesh3* Mesh, const FTransform3d& Transform, FString ObjectName, UMaterialInterface* Material )	Creates a new StaticMesh actor/component, with a new mesh asset stored at the given PackagePath created via the AssetAPI
AActor *	AssetGenerationUtil::GenerateStaticMeshActor ( IToolsContextAssetAPI* AssetAP..., UWorld* TargetWorld, const FDynamicMesh3* Mesh, const FTransform3d& Transform, FString ObjectName, const TArrayView< UMaterialInterfac... )	Creates a new StaticMesh actor/component, with a new mesh asset stored at the given PackagePath created via the AssetAPI
FString	AssetGenerationUtil::GetComponentAssetBaseName ( UPrimitiveComponent* Component, bool bRemoveAutoGeneratedSuffixes )	Look up the name for the Asset underlying the given Component, if there is one.
bool	AssetGenerationUtil::SaveGeneratedTexture2D ( IToolsContextAssetAPI* AssetAP..., UTexture2D* TransientTexture, FString ObjectName, const UObject* RelativeToAsset )	Save generated UTexture2D that is currently in the Transient package (ie generated in code) as an Asset with a given name
FString	AssetGenerationUtil::StripGeneratedAssetSuffixFromName ( FString InputName )	Strip the appended auto-generated _UUID suffix on the given string, if we can detect one
constexpr bo...	operator! ( EMeshRenderAttributeFlags E )
constexpr EM...	operator& ( EMeshRenderAttributeFlags Lhs, EMeshRenderAttributeFlags Rhs )
EMeshRenderA...	operator&= ( EMeshRenderAttributeFlags& Lhs, EMeshRenderAttributeFlags Rhs )
constexpr EM...	operator^ ( EMeshRenderAttributeFlags Lhs, EMeshRenderAttributeFlags Rhs )
EMeshRenderA...	operator^= ( EMeshRenderAttributeFlags& Lhs, EMeshRenderAttributeFlags Rhs )
constexpr EM...	operator\| ( EMeshRenderAttributeFlags Lhs, EMeshRenderAttributeFlags Rhs )
EMeshRenderA...	operator\|= ( EMeshRenderAttributeFlags& Lhs, EMeshRenderAttributeFlags Rhs )
constexpr EM...	operator~ ( EMeshRenderAttributeFlags E )
double	ToolSceneQueriesUtil::CalculateDimensionFromVisualAngleD ( const FViewCameraState& CameraStat..., const FVector3d& Point, double TargetVisualAngleDeg )
double	ToolSceneQueriesUtil::CalculateDimensionFromVisualAngleD ( const UInteractiveTool* Tool, const FVector3d& Point, double TargetVisualAngleDeg )
double	ToolSceneQueriesUtil::CalculateNormalizedViewVisualAngleD ( const FViewCameraState& CameraStat..., const FVector3d& Point1, const FVector3d& Point2 )
double	ToolSceneQueriesUtil::CalculateViewVisualAngleD ( const UInteractiveTool* Tool, const FVector3d& Point1, const FVector3d& Point2 )
double	ToolSceneQueriesUtil::CalculateViewVisualAngleD ( const FViewCameraState& CameraStat..., const FVector3d& Point1, const FVector3d& Point2 )
bool	ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( UWorld* World, FHitResult& HitResultOut, const FRay& Ray, const TArray< UPrimitiveComponent&..., const TArray< UPrimitiveComponent&... )	Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
bool	ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( UWorld* World, FHitResult& HitResultOut, const FVector& Start, const FVector& End, const TArray< UPrimitiveComponent&..., const TArray< UPrimitiveComponent&... )	Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
bool	ToolSceneQueriesUtil::FindSceneSnapPoint ( const UInteractiveTool* Tool, const FVector3d& Point, FVector3d& SnapPointOut, bool bVertices, bool bEdges, double VisualAngleThreshold, FSnapGeometry* SnapGeometry, FVector* DebugTriangleOut )	Run a query against the scene to find the best SnapPointOut for the given Point
bool	ToolSceneQueriesUtil::FindWorldGridSnapPoint ( const UInteractiveTool* Tool, const FVector3d& QueryPoint, FVector3d& GridSnapPointOut )	Run a query against the scene to find the nearest WorldGrid snap point
double	ToolSceneQueriesUtil::GetDefaultVisualAngleSnapThreshD()
bool	ToolSceneQueriesUtil::IsPointVisible ( const FViewCameraState& CameraStat..., const FVector3d& Point )
bool	ToolSceneQueriesUtil::IsVisibleObjectHit ( const FHitResult& HitResult )
double	ToolSceneQueriesUtil::PointSnapMetric ( const FViewCameraState& CameraStat..., const FVector3d& Point1, const FVector3d& Point2 )	Get a measurement for testing whether two points can snap together, useful for choosing the best snap point among multiple options.
bool	ToolSceneQueriesUtil::PointSnapQuery ( const UInteractiveTool* Tool, const FVector3d& Point1, const FVector3d& Point2, double VisualAngleThreshold )	Test if two points are close enough to snap together.
bool	ToolSceneQueriesUtil::PointSnapQuery ( const FViewCameraState& CameraStat..., const FVector3d& Point1, const FVector3d& Point2, double VisualAngleThreshold )	Test if two points are close enough to snap together.
UMaterialIns...	ToolSetupUtil::GetCustomImageBasedSculptMaterial ( UInteractiveToolManager* ToolM..., UTexture* SetImage )
UMaterialIns...	ToolSetupUtil::GetDefaultBrushVolumeMaterial ( UInteractiveToolManager* ToolM... )
UMaterialInt...	ToolSetupUtil::GetDefaultLineComponentMaterial ( UInteractiveToolManager* ToolM..., bool bDepthTested )
UMaterialInt...	ToolSetupUtil::GetDefaultMaterial()	Get the default material for surfaces
UMaterialInt...	ToolSetupUtil::GetDefaultMaterial ( UInteractiveToolManager* ToolM..., UMaterialInterface* SourceMate... )	Get the default material to use for objects in an InteractiveTool.
UMaterialInt...	ToolSetupUtil::GetDefaultPointComponentMaterial ( bool bRoundPoints, UInteractiveToolManager* ToolM... )
UMaterialInt...	ToolSetupUtil::GetDefaultSculptMaterial ( UInteractiveToolManager* ToolM... )
UMaterialInt...	ToolSetupUtil::GetDefaultWorkingMaterial ( UInteractiveToolManager* ToolM... )
UMaterialInt...	ToolSetupUtil::GetImageBasedSculptMaterial ( UInteractiveToolManager* ToolM..., ImageMaterialType Type )
UMaterialInt...	ToolSetupUtil::GetSelectionMaterial ( UInteractiveToolManager* ToolM... )
UMaterialInt...	ToolSetupUtil::GetSelectionMaterial ( const FLinearColor& UseColor, UInteractiveToolManager* ToolM..., float PercentDepthOffset )
UMaterialIns...	ToolSetupUtil::GetSimpleCustomMaterial ( UInteractiveToolManager* ToolM..., const FLinearColor& Color, float Opacity )
UMaterialIns...	ToolSetupUtil::GetUVCheckerboardMaterial ( double CheckerDensity )	Get a black-and-white NxN checkerboard material
UMaterialIns...	ToolSetupUtil::GetVertexColorMaterial ( UInteractiveToolManager* ToolM... )
void	UE::WeightMaps::FindVertexWeightMaps ( const FMeshDescription* Mesh, TArray< FName >& PropertyNamesOut )	Find the set of per-vertex weight map attributes on a MeshDescription
bool	UE::WeightMaps::GetVertexWeightMap ( const FMeshDescription* Mesh, FName AttributeName, FIndexedWeightMap1f& WeightMap, float DefaultValue )	Extract a per-vertex weight map from a MeshDescription If the attribute with the given name is not found, a WeightMap initialized with the default value is returned

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss