1. Epic GamesDeveloper
  3. ModelingComponents

ModelingComponents

API > API/Plugins

Filters

Classes

  Type Name Description
Public class UClass NotPlaceable Transient hidden, notblueprintable, notblueprinttype APreviewMeshActor UPreviewMesh internally spawns a APreviewMeshActor to hold the preview mesh object.  
Public struct UStruct blueprintable FCreateActorParams FCreateActorParams is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateNewActor().  
Public struct UStruct BlueprintType FCreateActorResult FCreateActorResult is returned by UModelingObjectsCreationAPI::FCreateActorParams() to indicate success/failure and provide information about created actors  
Public struct UStruct blueprintable FCreateMaterialObjectParams FCreateMaterialObjectParams is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateMaterialObject().  
Public struct UStruct BlueprintType FCreateMaterialObjectResult FCreateMaterialObjectResult is returned by UModelingObjectsCreationAPI::CreateMaterialObject() to indicate success/failure and provide information about created texture objects  
Public struct UStruct blueprintable FCreateMeshObjectParams FCreateMeshObjectParams is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateMeshObject().  
Public struct UStruct BlueprintType FCreateMeshObjectResult FCreateMeshObjectResult is returned by UModelingObjectsCreationAPI::CreateMeshObject() to indicate success/failure and provide information about created mesh objects  
Public struct UStruct blueprintable FCreateTextureObjectParams FCreateTextureObjectParams is a collection of input data intended to be passed to UModelingObjectsCreationAPI::CreateTextureObject().  
Public struct UStruct BlueprintType FCreateTextureObjectResult FCreateTextureObjectResult is returned by UModelingObjectsCreationAPI::CreateTextureObject() to indicate success/failure and provide information about created texture objects  
Public struct FDrawSplineSettings Used for DrawSpline()  
Public struct FDynamicMeshOpResult FDynamicMeshOpResult is a container for a computed Mesh and Transform  
Public struct FFindSceneSnapPointParams    
Public class FModelingComponentsModule    
Public struct FSnapGeometry FSnapGeometry stores information about geometry data of a snap, which we might use for highlights/etc  
Public class IToolActivityHost    
Public class 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.  
Public class UClass UInteractiveToolActivity A tool activity is a sort of "sub-tool" used to break apart functionality in tools that provide support for different multi-interaction subtasks.  
Public class UClass Transient 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.  
Public class UClass Config UModelingComponentsEditorSettings Editor preferences for the Modeling Components plug-in.  
Public class UClass Config UModelingComponentsSettings Settings for the Modeling Components plug-in.  
Public class UClass Abstract BlueprintType UModelingObjectsCreationAPI UModelingObjectsCreationAPI is a base interface for functions that can be used to create various types of objects from Modeling Tools, or other sources.  
Public class UClass Transient UPreviewMesh UPreviewMesh is a utility object that spawns and owns a transient mesh object in the World.  
Public class UToolActivityHost    

Typedefs

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

Enums

  Type Name Description
Public enum UEnum BlueprintType ECreateMeshObjectSourceMeshType Types of possible source meshes stored in FCreateMeshObjectParams  
Public enum UEnum BlueprintType ECreateModelingObjectResult Result code returned by UModelingObjectsCreationAPI functions  
Public enum UEnum BlueprintType ECreateObjectTypeHint Hint for the type of mesh object a UModelingObjectsCreationAPI might create based on FCreateMeshObjectParams data.  
Public enum UEnum EModelingComponentsPlaneVisualizationMode Modeling Components plugin-wide plane visualization modes  
Public enum EToolActivityEndResult    
Public enum EToolActivityStartResult    
Public enum ToolSetupUtil::ImageMaterialType Types of image-based material that we can create  
Public enum UE::ToolTarget::EDynamicMeshUpdateResult EDynamicMeshUpdateResult is returned by functions below that update a ToolTarget with a new Mesh  

Functions

  Type Name Description
Public function double

ToolSceneQueriesUtil::CalculateDimensionFromVisualAngleD ( const UInteractiveTool* Tool,
const FVector3d& Point,
double TargetVisualAngleDeg
)

  
Public function double

ToolSceneQueriesUtil::CalculateDimensionFromVisualAngleD ( const FViewCameraState& CameraState,
const FVector3d& Point,
double TargetVisualAngleDeg
)

  
Public function double

ToolSceneQueriesUtil::CalculateNormalizedViewVisualAngleD ( const FViewCameraState& CameraState,
const FVector3d& Point1,
const FVector3d& Point2
)

  
Public function double

ToolSceneQueriesUtil::CalculateViewVisualAngleD ( const FViewCameraState& CameraState,
const FVector3d& Point1,
const FVector3d& Point2
)

  
Public function double

ToolSceneQueriesUtil::CalculateViewVisualAngleD ( const UInteractiveTool* Tool,
const FVector3d& Point1,
const FVector3d& Point2
)

  
Public function bool

ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( const UInteractiveTool* Tool,
FHitResult& HitResultOut,
const FRay& Ray,
const TArray< const UPrimitiveComponent* >* IgnoreComponents,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
Public function bool

ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( const UInteractiveTool* Tool,
FHitResult& HitResultOut,
const FVector& Start,
const FVector& End,
const TArray< const UPrimitiveComponent* >* IgnoreComponents,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
Public function bool

ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( USceneSnappingManager* SnappingManager,
FHitResult& HitResultOut,
const FRay& Ray,
const TArray< const UPrimitiveComponent* >* IgnoreComponents,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
Public function bool

ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( UWorld* World,
FHitResult& HitResultOut,
const FRay& Ray,
const TArray< const UPrimitiveComponent* >* IgnoreComponents,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
Public function bool

ToolSceneQueriesUtil::FindNearestVisibleObjectHit ( UWorld* World,
FHitResult& HitResultOut,
const FVector& Start,
const FVector& End,
const TArray< const UPrimitiveComponent* >* IgnoreComponents,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Find the nearest object hit by the LineTrace from Start to End that is currently visible (provides correct result in Editor)
Public function bool Run a query against the scene to find the best SnapPointOut for the given Point
Public function 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
Public function bool

ToolSceneQueriesUtil::FindWorldGridSnapPoint ( const UInteractiveTool* Tool,
const FVector3d& QueryPoint,
FVector3d& GridSnapPointOut
)

 Run a query against the scene to find the nearest WorldGrid snap point
Public function double  
Public function bool

ToolSceneQueriesUtil::IsPointVisible ( const FViewCameraState& CameraState,
const FVector3d& Point
)

  
Public function bool  
Public function double

ToolSceneQueriesUtil::PointSnapMetric ( const FViewCameraState& CameraState,
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.
Public function bool

ToolSceneQueriesUtil::PointSnapQuery ( const UInteractiveTool* Tool,
const FVector3d& Point1,
const FVector3d& Point2,
double VisualAngleThreshold
)

 Test if two points are close enough to snap together.
Public function bool

ToolSceneQueriesUtil::PointSnapQuery ( const FViewCameraState& CameraState,
const FVector3d& Point1,
const FVector3d& Point2,
double VisualAngleThreshold
)

 Test if two points are close enough to snap together.
Public function double Round the given distance to the nearest multiple of the world grid cell size
Public function void Rendering Configuration/Setup Functions These utility functions are used to configure rendering settings on Preview Meshes created internally by Modeling Tools.
Public function void Rendering Configuration/Setup Functions These utility functions are used to configure rendering settings on Preview Meshes created internally by Modeling Tools.
Public function UCurveFloat *  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetCustomDepthOffsetMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
float PercentDepthOffset
)

  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetCustomDepthOffsetMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
float PercentDepthOffset,
float Opacity
)

  
Public function UMaterialInstanceDynamic *  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetCustomTwoSidedDepthOffsetMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
float PercentDepthOffset,
float Opacity
)

  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetCustomTwoSidedDepthOffsetMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
float PercentDepthOffset
)

  
Public function UMaterialInstanceDynamic * Get a Material to use with a square brush plane/ROI indicator that has an analytic falloff function combined w/ an alpha mask texture.
Public function UMaterialInstanceDynamic *  
Public function UMaterialInterface *  
Public function UMaterialInstanceDynamic *  
Public function UMaterialInterface * Gets a custom material suitable for use with ULineSetComponent.
Public function UMaterialInterface * Get the default material for surfaces
Public function UMaterialInterface * Get the default material to use for objects in an InteractiveTool.
Public function UMaterialInterface * Gets a custom material suitable for use with UPointSetComponent for square points.
Public function UMaterialInterface *  
Public function UMaterialInterface *  
Public function UMaterialInstanceDynamic *  
Public function UMaterialInterface *  
Public function UMaterialInterface * Gets a custom material suitable for use with UPointSetComponent for round points.
Public function UMaterialInterface *

ToolSetupUtil::GetSelectionMaterial ( const FLinearColor& UseColor,
UInteractiveToolManager* ToolManager,
float PercentDepthOffset
)

  
Public function UMaterialInterface *  
Public function UMaterialInstanceDynamic *  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetSimpleCustomMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
float Opacity
)

  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetTransparentSculptMaterial ( UInteractiveToolManager* ToolManager,
const FLinearColor& Color,
double Opacity,
bool bTwoSided
)

  
Public function UMaterialInstanceDynamic *

ToolSetupUtil::GetUVCheckerboardMaterial ( double CheckerDensity
)

 Get a black-and-white NxN checkerboard material
Public function UMaterialInstanceDynamic *  
Public function void  
Public function FCreateMaterialObjectResult Create a new material object based on the data in CreateMaterialParams.
Public function FCreateMeshObjectResult Create a new mesh object based on the data in CreateMeshParams.
Public function FCreateActorResult Create a new actor based on the data in CreateActorParams.
Public function FCreateTextureObjectResult Create a new texture object based on the data in CreateTexParams.
Public function FString Generate a N-letter GUID string that contains only hex digits, and contains at least one letter and one number.
Public function FString

UE::Modeling::GetComponentAssetBaseName ( UPrimitiveComponent* Component,
bool bRemoveAutoGeneratedSuffixes
)

 Look up the name for the Asset underlying the given Component, if there is one.
Public function FString Strip the appended auto-generated _UUID suffix on the given string, if we can detect one
Public function bool Apply an incremental mesh edit (MeshEditingFunc) to the ToolTarget.
Public function EDynamicMeshUpdateResult

UE::ToolTarget::CommitDynamicMeshNormalsUpdate ( UToolTarget* Target,
const UE::Geometry::FDynamicMesh3* UpdatedMesh,
bool bUpdateTangents
)

 Update the Normals/Tangents of the ToolTarget's mesh (assuming it has one) based on the provided UpdatedMesh.
Public function EDynamicMeshUpdateResult

UE::ToolTarget::CommitDynamicMeshUpdate ( UToolTarget* Target,
const UE::Geometry::FDynamicMesh3& UpdatedMesh,
bool bHaveModifiedTopology,
const FConversionToMeshDescriptionOptions& ConversionOptions,
const FComponentMaterialSet* UpdatedMaterials
)

 Update the Mesh in a ToolTarget based on the provided DynamicMesh, and optional material set
Public function EDynamicMeshUpdateResult Update the UV sets of the ToolTarget's mesh (assuming it has one) based on the provided UpdatedMesh.
Public function bool

UE::ToolTarget::CommitMaterialSetUpdate ( UToolTarget* Target,
const FComponentMaterialSet& UpdatedMaterials,
bool bApplyToAsset
)

 Update the material set of the Target
Public function EDynamicMeshUpdateResult

UE::ToolTarget::CommitMeshDescriptionUpdate ( UToolTarget* Target,
const FMeshDescription* UpdatedMesh,
const FComponentMaterialSet* UpdatedMaterials,
const FCommitMeshParameters& CommitParams
)

 Update the Mesh in a ToolTarget based on the provided MeshDescription, and optional material set
Public function EDynamicMeshUpdateResult Update the Mesh in a ToolTarget based on the provided MeshDescription, and optional material set
Public function EDynamicMeshUpdateResult

UE::ToolTarget::CommitMeshDescriptionUpdateViaDynamicMesh ( UToolTarget* Target,
const UE::Geometry::FDynamicMesh3& UpdatedMesh,
bool bHaveModifiedTopology,
const FCommitMeshParameters& CommitParams
)

 Update the Mesh in a ToolTarget based on the provided MeshDescription, and optional material set
Public function bool FCreateMeshObjectParams::TypeHint is used by the ModelingObjectsCreationAPI to suggest what type of mesh object to create inside various Tools.
Public function UE::Geometry::FDynamicMesh3

UE::ToolTarget::GetDynamicMeshCopy ( UToolTarget* Target,
bool bWantMeshTangents
)

 Fetch a DynamicMesh3 representing the given ToolTarget.
Public function FMeshDescription  
Public function FString  
Public function FTransform3d  
Public function FComponentMaterialSet

UE::ToolTarget::GetMaterialSet ( UToolTarget* Target,
bool bPreferAssetMaterials
)

 Fetch the Material Set on the object underlying a ToolTarget.
Public function const FMeshDescription *  
Public function FMeshDescription Return a copy of the MeshDescription underlying a ToolTarget
Public function TArray< EMeshLODIdentifier >

UE::ToolTarget::GetMeshDescriptionLODs ( UToolTarget* Target,
bool& bOutTargetSupportsLODs,
bool bOnlyReturnDefaultLOD,
bool bExcludeAutoGeneratedLODs
)

  
Public function UBodySetup *  
Public function IInterface_CollisionDataProvider *  
Public function USkeletalMesh *  
Public function UStaticMesh *  
Public function AActor *  
Public function UPrimitiveComponent *  
Public function EMeshLODIdentifier

UE::ToolTarget::GetTargetMeshDescriptionLOD ( UToolTarget* Target,
bool& bOutTargetSupportsLODs
)

 Return identifier for the mesh LOD that a ToolTarget represents, if defined for the given ToolTarget
Public function bool Hide the "Source Object" (eg PrimitiveComponent, Actor, etc) backing a ToolTarget
Public function void Not intended for direct use by tools, just for use by tool target util functions and tool target implementations that may need to do this operation.
Public function bool Show or Hide the "Source Object" (eg PrimitiveComponent, Actor, etc) backing a ToolTarget
Public function bool Show the "Source Object" (eg PrimitiveComponent, Actor, etc) backing a ToolTarget
Public function bool  
Public function void

UE::WeightMaps::FindVertexWeightMaps ( const FMeshDescription* Mesh,
TArray< FName >& PropertyNamesOut
)

 Find the set of per-vertex weight map attributes on a MeshDescription
Public function 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page