1. Epic GamesDeveloper
  3. FSplineComponentVisualizer

FSplineComponentVisualizer

SplineComponent visualizer/edit functionality

API > API/Editor > API/Editor/ComponentVisualizers

Inheritance Hierarchy

References

   
Module ComponentVisualizers
Header /Engine/Source/Editor/ComponentVisualizers/Public/SplineComponentVisualizer.h
Include #include "SplineComponentVisualizer.h"

Syntax

class FSplineComponentVisualizer :  
    public FComponentVisualizer,  
    public FGCObject

Remarks

SplineComponent visualizer/edit functionality

Variables

  Type Name Description
Protected variable EAxis::Type AddKeyLockedAxis Axis to fix when adding new spline points.
Protected variable bool bAllowDuplication Whether we currently allow duplication when dragging
Protected variable bool bDuplicatingSplineKey Alt-drag: True when in process of duplicating a spline key.
Protected variable bool bIsSnappingToActor Snap: True when in process of snapping to actor which needs to be Ctrl-Selected.
Protected variable bool bUpdatingAddSegment Alt-drag: True when in process of adding end segment.
Protected variable FDelegateHandle DeselectedInEditorDelegateHandle  
Protected variable float DuplicateCacheSplitSegmentParam Alt-drag: Cached segment parameter for split segment at new control point
Protected variable uint32 DuplicateDelay Alt-drag: Delays duplicating control point to accumulate sufficient drag input offset.
Protected variable FVector DuplicateDelayAccumulatedDrag Alt-drag: Accumulates delayed drag offset.
Protected variable TObjectPtr< USplineComponentVisualizerSelectionState > SelectionState Current selection state
Protected variable ESplineComponentSnapMode SnapToActorMode Snap: Snap to actor mode.
Protected variable TSharedPtr< FUICommandList > SplineComponentVisualizerActions Output log commands
Protected variable FProperty * SplineCurvesProperty  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void

AddSegment ( const FVector& InWorldPos,
bool bAppend
)

 Add segment to beginning or end of spline
Protected function Const bool Whether any keys are currently selected
Protected function Const bool Whether a multiple spline keys are currently selected
Protected function Const bool  
Protected function Const bool  
Protected function Const bool

CanResetToAutomaticTangent ( EInterpCurveMode Mode
)

  
Protected function Const bool  
Protected function Const bool  
Protected function Virtual void

ChangeSelectionState ( int32 Index,
bool bIsCtrlHeld
)

 Update the key selection state of the visualizer
Protected function void  
Protected function Virtual bool

DuplicateKeyForAltDrag ( const FVector& InDrag
)

 Alt-drag: duplicates the selected spline key
Protected function Virtual Const float

FindNearest ( const FVector& InLocalPos,
int32 InSegmentStartIndex,
FVector& OutSplinePos,
FVector& OutSplineTangent
)

 Return spline data for point on spline closest to input point
Public function Virtual Const void Add menu sections to the context menu
Protected function Const void Generate the submenu containing the lock axis types
Protected function Const void Generate the submenu containing available selection actions
Protected function Const void Generate the submenu containing the available snap/align actions
Protected function Const void Generate the submenu containing the available point types
Protected function Const void Generate the submenu containing the available auto tangent types
Public function Const USplineComponent * Get the spline component we are currently editing
Public function Const const TSet< int32 > &  
Protected function Virtual Const bool

GetSnapToActorMode ( ESplineComponentSnapMode& OutSnapMode
)

 Snapping: get snap to actor temporary mode
Public function bool Select all spline points, , returns true if the spline component being edited has changed
Public function bool

HandleSelectFirstLastSplinePoint ( USplineComponent* InSplineComponent,
bool bFirstPoint
)

 Select first or last spline point, returns true if the spline component being edited has changed
Protected function Const bool Determine if any selected key index is out of range (perhaps because something external has modified the spline)
Protected function Const bool  
Protected function Const bool  
Protected function Const bool

IsKeyTypeSet ( EInterpCurveMode Mode
)

  
Protected function Const bool  
Protected function Const bool Whether a single spline key is currently selected
Protected function Const bool  
Protected function void  
Protected function void  
Protected function void  
Protected function void Duplicates selected spline keys in place
Protected function void

OnLockAxis ( EAxis::Type InAxis
)

  
Protected function void

OnResetToAutomaticTangent ( EInterpCurveMode Mode
)

  
Protected function void  
Protected function void Select all spline points, if no spline points selected yet the currently edited spline component will be set as well
Protected function void

OnSelectFirstLastSplinePoint ( bool bFirstPoint
)

 Select first or last spline point
Public function void

OnSelectPrevNextSplinePoint ( bool bNextPoint,
bool bAddToSelection
)

 Select next or prev spline point, loops when last point is currently selected
Protected function void  
Protected function void

OnSetKeyType ( EInterpCurveMode Mode
)

  
Protected function void  
Protected function void  
Protected function void

OnSnapKeyToActor ( const ESplineComponentSnapMode InSnapMode
)

  
Protected function void

OnSnapKeyToNearestSplinePoint ( ESplineComponentSnapMode InSnapMode
)

  
Protected function void  
Protected function Virtual void Alt-drag: duplicates the selected spline key
Protected function Virtual void Reset temporary modes after inputs are handled.
Protected function void

SelectSplinePoint ( int32 SelectIndex,
bool bAddToSelection
)

 Select spline point at specified index
Public function void

SetCachedRotation ( const FQuat& NewRotation
)

 Sets the new cached rotation on the visualizer
Protected function void

SetEditedSplineComponent ( const USplineComponent* InSplineComponent
)

 Helper function to set edited component we are currently editing
Protected function Virtual void

SetSnapToActorMode ( const bool bInIsSnappingToActor,
const ESplineComponentSnapMode InSnapMode
)

 Snapping: set snap to actor temporary mode
Protected function Virtual void

SnapKeysToLastSelectedAxisPosition ( const EAxis::Type InAxis,
TArray< int32 > InSnapKeys
)

 Snapping: snap keys to axis position of last selected key
Protected function Virtual void

SnapKeyToActor ( const AActor* InActor,
const ESplineComponentSnapMode SnapMode
)

 Snapping: snap key to selected actor
Protected function Virtual void

SnapKeyToTransform ( const ESplineComponentSnapMode InSnapMode,
const FVector& InWorldPos,
const FVector& InWorldUpVector,
const FVector& InWorldForwardVector,
const FVector& InScale,
const USplineMetadata* InCopySplineMetadata,
const int32 InCopySplineMetadataKey
)

 Snapping: generic method for snapping selected keys to given transform
Protected function Virtual void

SplitSegment ( const FVector& InWorldPos,
int32 InSegmentIndex,
bool bCopyFromSegmentBeginIndex
)

 Split segment using given world position
Protected function bool

TransformSelectedKeys ( EPropertyChangeType::Type InPropertyChangeType,
const FVector& InDeltaTranslate,
const FRotator& InDeltaRotate,
const FVector& InDeltaScale
)

 Transforms selected tangent by given translate, rotate and scale
Protected function bool

TransformSelectedTangent ( EPropertyChangeType::Type InPropertyChangeType,
const FVector& InDeltaTranslate
)

 Transforms selected tangent by given translation
Protected function Virtual void

UpdateAddSegment ( const FVector& InWorldPos
)

 Add segment to beginning or end of spline
Protected function Virtual bool

UpdateDuplicateKeyForAltDrag ( const FVector& InDrag
)

 Alt-drag: updates duplicated selected spline key
Protected function const USplineComponent * Updates the component and selected properties if the component has changed
Protected function Virtual void

UpdateSplitSegment ( const FVector& InDrag
)

 Update split segment based on drag offset

Overridden from FComponentVisualizer

  Type Name Description
Public function Virtual void

DrawVisualization ( const UActorComponent* Component,
const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 Draw visualization for the supplied component
Public function Virtual void

DrawVisualizationHUD ( const UActorComponent* Component,
const FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

 Draw HUD on viewport for the supplied component
Public function Virtual void  
Public function Virtual Const TSharedPtr< SWidget >  
Public function Virtual Const bool

GetCustomInputCoordinateSystem ( const FEditorViewportClient* ViewportClient,
FMatrix& OutMatrix
)

  
Public function Virtual Const UActorComponent * Get currently edited component, this is needed to reset the active visualizer after undo/redo
Public function Virtual Const bool

GetWidgetLocation ( const FEditorViewportClient* ViewportClient,
FVector& OutLocation
)

  
Public function Virtual bool

HandleBoxSelect ( const FBox& InBox,
FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

 Handle box select input
Public function Virtual bool

HandleFrustumSelect ( const FConvexVolume& InFrustum,
FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

 Handle frustum select input
Public function Virtual bool

HandleInputDelta ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FVector& DeltaTranslate,
FRotator& DeltaRotate,
FVector& DeltaScale
)

  
Public function Virtual bool

HandleInputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

  
Public function Virtual bool

HandleModifiedClick ( FEditorViewportClient* InViewportClient,
HHitProxy* HitProxy,
const FViewportClick& Click
)

 Handle click modified by Alt, Ctrl and/or Shift. The input HitProxy may not be on this component.
Public function Virtual bool

HandleSnapTo ( const bool bInAlign,
const bool bInUseLineTrace,
const bool bInUseBounds,
const bool bInUsePivot,
AActor* InDestination
)

 Pass snap input to active visualizer
Public function Virtual bool

HasFocusOnSelectionBoundingBox ( FBox& OutBoundingBox
)

 Return whether focus on selection should focus on bounding box defined by active visualizer
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual bool Show this visualizer if the component is directly is selected
Public function Virtual void

TrackingStopped ( FEditorViewportClient* InViewportClient,
bool bInDidMove
)

 Gets called when the mouse tracking has stopped (dragging behavior)
Public function Virtual bool

VisProxyHandleClick ( FEditorViewportClient* InViewportClient,
HComponentVisProxy* VisProxy,
const FViewportClick& Click
)

  

Overridden from FGCObject

  Type Name Description
Protected function Virtual void Pure virtual that must be overloaded by the inheriting class.
Protected function Virtual Const FString Overload this method to report a name for your referencer

Constants

Name Description
WeakExistingWindow  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page