Navigation
API > API/Plugins > API/Plugins/ModelingComponents
| Name | UCollectSurfacePathMechanic |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Mechanics/CollectSurfacePathMechanic.h |
| Include Path | #include "Mechanics/CollectSurfacePathMechanic.h" |
Syntax
UCLASS (MinimalAPI)
class UCollectSurfacePathMechanic : public UInteractionMechanic
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractionMechanic → UCollectSurfacePathMechanic
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCollectSurfacePathMechanic() |
Mechanics/CollectSurfacePathMechanic.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFrame3d | UE::Geometry::FFrame3d | Mechanics/CollectSurfacePathMechanic.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDrawPath | bool | Mechanics/CollectSurfacePathMechanic.h | ||
| bPreviewPathPointValid | bool | Mechanics/CollectSurfacePathMechanic.h | ||
| bSnapToTargetMeshVertices | bool | Mechanics/CollectSurfacePathMechanic.h | ||
| bSnapToWorldGrid | bool | Mechanics/CollectSurfacePathMechanic.h | ||
| ConstantSnapDistance | double | Mechanics/CollectSurfacePathMechanic.h | ||
| HitPath | TArray< FFrame3d > | Mechanics/CollectSurfacePathMechanic.h | ||
| IsDoneFunc | TUniqueFunction< bool()> | Mechanics/CollectSurfacePathMechanic.h | ||
| PathColor | FLinearColor | Mechanics/CollectSurfacePathMechanic.h | ||
| PathCompleteColor | FLinearColor | Mechanics/CollectSurfacePathMechanic.h | ||
| PathDrawer | FToolDataVisualizer | Mechanics/CollectSurfacePathMechanic.h | ||
| PreviewColor | FLinearColor | Mechanics/CollectSurfacePathMechanic.h | ||
| PreviewPathPoint | FFrame3d | Mechanics/CollectSurfacePathMechanic.h | ||
| SpatialSnapPointsFunc | TUniqueFunction< bool(FVector3d, FVector3d)> | Mechanics/CollectSurfacePathMechanic.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void InitializeMeshSurface
(
FDynamicMesh3&& TargetSurfaceMesh |
Set the hit target mesh. | Mechanics/CollectSurfacePathMechanic.h | |
virtual void InitializePlaneSurface
(
const FFrame3d& TargetPlane |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual bool IsDone() |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual bool IsHitByRay
(
const FRay3d& Ray, |
Mechanics/CollectSurfacePathMechanic.h | ||
bool LoopWasClosed() |
Whether the path was finished by the user clicking on the first point | Mechanics/CollectSurfacePathMechanic.h | |
virtual bool PopLastPoint() |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void SetCloseWithLambdaMode() |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void SetDoubleClickOrCloseLoopMode() |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void SetDrawClosedLoopMode() |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void SetFixedNumPointsMode
(
int32 NumPoints |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual bool TryAddPointFromRay
(
const FRay3d& Ray |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual bool UpdatePreviewPoint
(
const FRay3d& Ray |
Mechanics/CollectSurfacePathMechanic.h |
Overridden from UInteractionMechanic
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void Setup
(
UInteractiveTool* ParentTool |
Mechanics/CollectSurfacePathMechanic.h | ||
virtual void Shutdown() |
Mechanics/CollectSurfacePathMechanic.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CheckGeometricClosure
(
const FFrame3d& Point, |
Mechanics/CollectSurfacePathMechanic.h | ||
bool RayToPathPoint
(
const FRay3d& Ray, |
Mechanics/CollectSurfacePathMechanic.h |