1. Epic GamesDeveloper
  3. UDrawSplineTool

UDrawSplineTool

API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnlyExp

Inheritance Hierarchy

References

   
Module MeshModelingToolsEditorOnlyExp
Header /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnlyExp/Public/DrawSplineTool.h
Include #include "DrawSplineTool.h"

Syntax

UCLASS ()  
class UDrawSplineTool :  
    public UInteractiveTool ,  
    public IClickBehaviorTarget ,  
    public IClickDragBehaviorTarget

Variables

  Type Name Description
Protected variable bool bDrawTangentForLastPoint  
Protected variable bool bFreeDrawPlacedPreviewPoint  
Protected variable bool bNeedToRerunConstructionScript  
Protected variable bool bPreviousSplineVisibility  
Protected variable FViewCameraState CameraState  
Protected variable UProperty TObjectPtr< USingleClickOrDragInputBehavior > ClickOrDragBehavior  
Protected variable int32 FreeDrawStrokeStartIndex  
Protected variable TWeakObjectPtr< USplineComponent > HiddenSpline Used to restore visibility of previous spline when switching to a different one.
Protected variable UProperty TObjectPtr< UConstructionPlaneMechanic > PlaneMechanic  
Protected variable UProperty TObjectPtr< AActor > PreviewActor The preview actor may be a duplicate of some target blueprint actor so that we can see the effects of the drawn spline immediately
Protected variable UProperty TObjectPtr< APreviewGeometryActor > PreviewRootActor PreviewRootActor either holds WorkingSpline inside it directly, or has some preview actor attached to it (so that the preview actor is hidden from outliner, like APreviewGeometryActor is).
Protected variable UProperty TObjectPtr< AActor > PreviousTargetActor Used to restore visibility of previous actor when switching to a different one.
Protected variable UProperty bool PreviousTargetActorVisibility  
Protected variable TWeakObjectPtr< AActor > SelectedActor This is only used to initialize TargetActor in the settings object.
Protected variable UProperty TObjectPtr< UDrawSplineToolProperties > Settings  
Protected variable int32 SplineRecaptureIndex Used for recapturing the spline when rerunning construction scripts.
Protected variable TWeakObjectPtr< UWorld > TargetWorld  
Protected variable TWeakObjectPtr< USplineComponent > WorkingSpline This is the spline we add points to.

Functions

  Type Name Description
Protected function void

AddSplinePoint ( const FVector3d& HitLocation,
const FVector3d& UpVector
)

  
Protected function void  
Public function Virtual UWorld *  
Protected function FVector3d

GetUpVectorToUse ( const FVector3d& HitLocation,
const FVector3d& HitNormal,
int32 NumSplinePointsBeforehand
)

  
Protected function bool

Raycast ( const FRay& WorldRay,
FVector3d& HitLocationOut,
FVector3d& HitNormalOut,
double& HitTOut
)

  
Public function Virtual void  
Public function Virtual void

SetWorld ( UWorld* World
)

  
Protected function void  

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

 Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
Public function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 UInteractiveTool.
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IClickBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& ClickPos
)

 IClickBehaviorTarget.
Public function Virtual void

OnClicked ( const FInputDeviceRay& ClickPos
)

 Notify Target that click ocurred

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IClickDragBehaviorTarget.
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& DragPos
)

 Notify Target that input position has changed
Public function Virtual void

OnClickPress ( const FInputDeviceRay& PressPos
)

 Notify Target that click press ocurred
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& ReleasePos
)

 Notify Target that click release occurred
Public function Virtual void Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Classes

  Type Name Description
Public class FSplineChange Helper class for making undo/redo transactions, to avoid friending all the variations.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page