Navigation
API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Mechanics
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UInteractionMechanic
- UCollectSurfacePathMechanic
References
| Module | ModelingComponents |
| Header | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Mechanics/CollectSurfacePathMechanic.h |
| Include | #include "Mechanics/CollectSurfacePathMechanic.h" |
Syntax
UCLASS&40;&41;
class UCollectSurfacePathMechanic : public UInteractionMechanic
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bCurrentPreviewWillComplete | ||
| bool | bDrawPath | ||
| bool | bGeometricCloseOccurred | ||
| bool | bHaveTargetPlane | ||
| bool | bLoopWasClosed | ||
| bool | bPreviewPathPointValid | ||
| bool | bSnapToTargetMeshVertices | ||
| bool | bSnapToWorldGrid | ||
| double | ConstantSnapDistance | ||
| ECollectSurfacePathDoneMode | DoneMode | ||
| int32 | FixedPointTargetCount | ||
| TArray< FFrame3d > | HitPath | ||
| TUniqueFunction< bool()> | IsDoneFunc | ||
| FLinearColor | PathColor | ||
| FLinearColor | PathCompleteColor | ||
| FToolDataVisualizer | PathDrawer | ||
| FLinearColor | PreviewColor | ||
| FFrame3d | PreviewPathPoint | ||
| TUniqueFunction< bool(FVector3d, FVector3d)> | SpatialSnapPointsFunc | ||
| FFrame3d | TargetPlane | ||
| FDynamicMesh3 | TargetSurface | ||
| UE::Geometry::FDynamicMeshAABBTree3 | TargetSurfaceAABB |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | CheckGeometricClosure
(
const FFrame3d& Point, |
||
| void | InitializeMeshSurface
(
FDynamicMesh3&& TargetSurfaceMesh |
Set the hit target mesh. | |
| void | InitializePlaneSurface
(
const FFrame3d& TargetPlane |
||
| bool | IsDone () |
||
| bool | IsHitByRay
(
const FRay3d& Ray, |
||
| bool | Whether the path was finished by the user clicking on the first point | ||
| bool | PopLastPoint () |
||
| bool | RayToPathPoint
(
const FRay3d& Ray, |
||
| void | |||
| void | |||
| void | |||
| void | SetFixedNumPointsMode
(
int32 NumPoints |
||
| bool | TryAddPointFromRay
(
const FRay3d& Ray |
||
| bool | UpdatePreviewPoint
(
const FRay3d& Ray |
Overridden from UInteractionMechanic
| Type | Name | Description | |
|---|---|---|---|
| void | Render
(
IToolsContextRenderAPI* RenderAPI |
Allow the Mechanic to do any custom drawing (ie via PDI/RHI) | |
| void | Setup
(
UInteractiveTool* ParentTool |
Called to initialize the InteractionMechanic | |
| void | Shutdown () |
Called to clean up the InteractionMechanic |
Typedefs
| Name | Description |
|---|---|
| FFrame3d |