Navigation
API > API/Plugins > API/Plugins/MeshModelingToolsExp
| Name | UDrawPolyPathTool |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsExp/Public/DrawPolyPathTool.h |
| Include Path | #include "DrawPolyPathTool.h" |
Syntax
UCLASS (MinimalAPI)
class UDrawPolyPathTool :
public UInteractiveTool ,
public IClickBehaviorTarget ,
public IHoverBehaviorTarget ,
public IInteractiveToolManageGeometrySelectionAPI
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UDrawPolyPathTool
Implements Interfaces
- IClickBehaviorTarget
- IModifierToggleBehaviorTarget
- IHoverBehaviorTarget
- IInputBehaviorSource
- IInteractiveToolManageGeometrySelectionAPI
Enums
Protected
| Name | Remarks |
|---|---|
| EState |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ShiftModifierID | const int | DrawPolyPathTool.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bRestoreInputSelection | bool | If the drawn path is incomplete upon 'Accept' of the tool, no mesh should be created and the previous mesh element selection from before entering the tool should be restored | DrawPolyPathTool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HitTest
(
const FRay& Ray, |
DrawPolyPathTool.h | ||
void SetInitialDrawFrame
(
UE::Geometry::FFrame3d Frame |
DrawPolyPathTool.h | ||
virtual void SetWorld
(
UWorld* World |
DrawPolyPathTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAccept() |
DrawPolyPathTool.h | ||
virtual bool HasAccept() |
DrawPolyPathTool.h | ||
virtual bool HasCancel() |
DrawPolyPathTool.h | ||
| DrawPolyPathTool.h | |||
virtual void OnTick
(
float DeltaTime |
DrawPolyPathTool.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
DrawPolyPathTool.h | ||
virtual void Setup() |
DrawPolyPathTool.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
DrawPolyPathTool.h |
Overridden from IClickBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit IsHitByClick
(
const FInputDeviceRay& ClickPos |
IClickBehaviorTarget API. | DrawPolyPathTool.h | |
virtual void OnClicked
(
const FInputDeviceRay& ClickPos |
DrawPolyPathTool.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
IModifierToggleBehaviorTarget. | DrawPolyPathTool.h |
Overridden from IHoverBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
IHoverBehaviorTarget API. | DrawPolyPathTool.h | |
virtual void OnBeginHover
(
const FInputDeviceRay& DevicePos |
DrawPolyPathTool.h | ||
virtual void OnEndHover() |
DrawPolyPathTool.h | ||
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
DrawPolyPathTool.h |
Overridden from IInteractiveToolManageGeometrySelectionAPI
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsInputSelectionValidOnOutput() |
IInteractiveToolManageGeometrySelectionAPI - enables restoration of previous selection when applicable. | DrawPolyPathTool.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginConstantExtrudeHeight() |
DrawPolyPathTool.h | ||
void BeginInteractiveExtrudeHeight() |
DrawPolyPathTool.h | ||
void BeginSettingHeight() |
DrawPolyPathTool.h | ||
void BeginSettingRadius() |
DrawPolyPathTool.h | ||
void BeginSettingWidth() |
DrawPolyPathTool.h | ||
bool CanUpdateDrawPlane() |
DrawPolyPathTool.h | ||
bool CheckInCurve
(
int32 Timestamp |
DrawPolyPathTool.h | ||
void ClearPreview() |
DrawPolyPathTool.h | ||
void EmitNewObject() |
DrawPolyPathTool.h | ||
void GenerateExtrudeMesh
(
UE::Geometry::FDynamicMesh3& PathMesh |
DrawPolyPathTool.h | ||
FVector3d GeneratePathMesh
(
UE::Geometry::FDynamicMesh3& Mesh |
DrawPolyPathTool.h | ||
void InitializeNewSurfacePath() |
DrawPolyPathTool.h | ||
void InitializePreviewMesh() |
DrawPolyPathTool.h | ||
void OnCompleteExtrudeHeight() |
DrawPolyPathTool.h | ||
void OnCompleteRadius() |
DrawPolyPathTool.h | ||
void OnCompleteSurfacePath() |
DrawPolyPathTool.h | ||
void OnCompleteWidth() |
DrawPolyPathTool.h | ||
void ShowExtrudeMessage() |
DrawPolyPathTool.h | ||
void ShowOffsetMessage() |
DrawPolyPathTool.h | ||
void ShowStartupMessage() |
User feedback messages | DrawPolyPathTool.h | |
void UndoCurrentOperation
(
EState DestinationState |
DrawPolyPathTool.h | ||
void UpdateExtrudePreview() |
DrawPolyPathTool.h | ||
void UpdatePathPreview() |
DrawPolyPathTool.h | ||
void UpdateSurfacePathPlane() |
DrawPolyPathTool.h |