Navigation
API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnlyExp
| Name | UDrawSplineTool |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnlyExp/Public/DrawSplineTool.h |
| Include Path | #include "DrawSplineTool.h" |
Syntax
UCLASS (MinimalAPI)
class UDrawSplineTool :
public UInteractiveTool ,
public IClickBehaviorTarget ,
public IClickDragBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UDrawSplineTool
Implements Interfaces
Classes
| Name | Remarks |
|---|---|
| FSplineChange | Helper class for making undo/redo transactions, to avoid friending all the variations. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDrawTangentForLastPoint | bool | DrawSplineTool.h | ||
| bFreeDrawPlacedPreviewPoint | bool | DrawSplineTool.h | ||
| bNeedToRerunConstructionScript | bool | DrawSplineTool.h | ||
| bPreviousSplineVisibility | bool | DrawSplineTool.h | ||
| CameraState | FViewCameraState | DrawSplineTool.h | ||
| ClickOrDragBehavior | TObjectPtr< USingleClickOrDragInputBehavior > | DrawSplineTool.h | ||
| FreeDrawStrokeStartIndex | int32 | DrawSplineTool.h | ||
| HiddenSpline | TWeakObjectPtr< USplineComponent > | Used to restore visibility of previous spline when switching to a different one. | DrawSplineTool.h | |
| LongTransactions | UE::TransactionUtil::FLongTransactionTracker | DrawSplineTool.h | ||
| PlaneMechanic | TObjectPtr< UConstructionPlaneMechanic > | DrawSplineTool.h | ||
| PreviewActor | TObjectPtr< AActor > | The preview actor is either a APreviewGeometryActor with a spline, or a duplicate of some target blueprint actor so that we can see the effects of the drawn spline immediately. | DrawSplineTool.h | |
| PreviousTargetActor | TObjectPtr< AActor > | Used to restore visibility of previous actor when switching to a different one, and to avoid switching target actors if the new value is invalid (e.g., user clicked the preview actor with the actor picker) | DrawSplineTool.h | |
| PreviousTargetActorVisibility | bool | DrawSplineTool.h | ||
| Settings | TObjectPtr< UDrawSplineToolProperties > | DrawSplineTool.h | ||
| SplineRecaptureIndex | int32 | Used for recapturing the spline when rerunning construction scripts. | DrawSplineTool.h | |
| StartupSelectedActor | TWeakObjectPtr< AActor > | This is only used to initialize TargetActor in the settings object. | DrawSplineTool.h | |
| TargetActorWatcherID | int32 | DrawSplineTool.h | ||
| TargetWorld | TWeakObjectPtr< UWorld > | DrawSplineTool.h | ||
| WorkingSpline | TWeakObjectPtr< USplineComponent > | This is the spline we add points to. | DrawSplineTool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UWorld * GetTargetWorld() |
DrawSplineTool.h | ||
virtual void SetSelectedActor
(
AActor* Actor |
DrawSplineTool.h | ||
virtual void SetWorld
(
UWorld* World |
DrawSplineTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAccept() |
DrawSplineTool.h | ||
virtual bool HasAccept() |
DrawSplineTool.h | ||
virtual bool HasCancel() |
DrawSplineTool.h | ||
| DrawSplineTool.h | |||
virtual void OnTick
(
float DeltaTime |
DrawSplineTool.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
DrawSplineTool.h | ||
virtual void Setup() |
UInteractiveTool. | DrawSplineTool.h | |
virtual void Shutdown
(
EToolShutdownType ShutdownType |
DrawSplineTool.h |
Overridden from IClickBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit IsHitByClick
(
const FInputDeviceRay& ClickPos |
IClickBehaviorTarget. | DrawSplineTool.h | |
virtual void OnClicked
(
const FInputDeviceRay& ClickPos |
DrawSplineTool.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
IClickDragBehaviorTarget. | DrawSplineTool.h | |
virtual void OnClickDrag
(
const FInputDeviceRay& DragPos |
DrawSplineTool.h | ||
virtual void OnClickPress
(
const FInputDeviceRay& PressPos |
DrawSplineTool.h | ||
virtual void OnClickRelease
(
const FInputDeviceRay& ReleasePos |
DrawSplineTool.h | ||
virtual void OnTerminateDragSequence() |
DrawSplineTool.h |