1. Epic GamesDeveloper
  3. FSplineComponentVisualizer

FSplineComponentVisualizer

SplineComponent visualizer/edit functionality

API > API/Editor > API/Editor/ComponentVisualizers

SplineComponent visualizer/edit functionality

   
Name FSplineComponentVisualizer
Type class
Header File /Engine/Source/Editor/ComponentVisualizers/Public/SplineComponentVisualizer.h
Include Path #include "SplineComponentVisualizer.h"

Syntax

class FSplineComponentVisualizer :  
    public FComponentVisualizer,  
    public FGCObject PRAGMA_DISABLE_INTERNAL_WARNINGS,  
    public ISplineDetailsProvider PRAGMA_DISABLE_INTERNAL_WARNINGS

Inheritance Hierarchy

Implements Interfaces

  • ISplineDetailsProvider PRAGMA_DISABLE_INTERNAL_WARNINGS

Constructors

Name Remarks Include Path Unreal Specifiers

FSplineComponentVisualizer()

   SplineComponentVisualizer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FSplineComponentVisualizer()

   SplineComponentVisualizer.h  

Typedefs

Name Type Remarks Include Path
FPDICache UE::SplineComponentVisualizer::FPDICache   SplineComponentVisualizer.h

Constants

Name Type Remarks Include Path
WeakExistingWindow TWeakPtr< SWindow >   SplineComponentVisualizer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
PDICache TMap< TWeakObjectPtr< const USplineComponent >, FPDICache >   SplineComponentVisualizer.h  
SplineGeneratorPanel TSharedPtr< SSplineGeneratorPanel >   SplineComponentVisualizer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   SplineComponentVisualizer.h  

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

 Draw HUD on viewport for the supplied component SplineComponentVisualizer.h  

virtual void EndEditing()

   SplineComponentVisualizer.h  

virtual TSharedPtr< SWidget > GenerateContextMenu()

   SplineComponentVisualizer.h  

virtual void GenerateContextMenuSections ( FMenuBuilder& InMenuBuilder
) const

 Add menu sections to the context menu SplineComponentVisualizer.h  

virtual bool GetCustomInputCoordinateSystem ( const FEditorViewportClient* ViewportClient,
FMatrix& OutMatrix
) const

   SplineComponentVisualizer.h  

virtual UActorComponent * GetEditedComponent()

 Get currently edited component, this is needed to reset the active visualizer after undo/redo SplineComponentVisualizer.h  

virtual USplineComponent * GetEditedSplineComponent()

 Get the spline component we are currently editing SplineComponentVisualizer.h  

virtual const TSet< int32 > & GetSelectedKeys()

   SplineComponentVisualizer.h  

virtual bool GetWidgetLocation ( const FEditorViewportClient* ViewportClient,
FVector& OutLocation
) const

   SplineComponentVisualizer.h  

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

 Handle box select input SplineComponentVisualizer.h  

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

 Handle frustum select input SplineComponentVisualizer.h  

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

   SplineComponentVisualizer.h  

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

   SplineComponentVisualizer.h  

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. SplineComponentVisualizer.h  

virtual bool HandleSelectAllSplinePoints ( USplineComponent* InSplineComponent
)

 Select all spline points, , returns true if the spline component being edited has changed SplineComponentVisualizer.h  

virtual bool HandleSelectFirstLastSplinePoint ( USplineComponent* InSplineComponent,
bool bFirstPoint
)

 Select first or last spline point, returns true if the spline component being edited has changed SplineComponentVisualizer.h  

virtual void HandleSelectPrevNextSplinePoint ( bool bNext,
bool bAddToSelection
)

   SplineComponentVisualizer.h  

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

 Pass snap input to active visualizer SplineComponentVisualizer.h  

virtual bool HasFocusOnSelectionBoundingBox ( FBox& OutBoundingBox
)

 Return whether focus on selection should focus on bounding box defined by active visualizer SplineComponentVisualizer.h  

virtual bool IsVisualizingArchetype()

   SplineComponentVisualizer.h  

virtual void OnRegister()

   SplineComponentVisualizer.h  

void OnSelectPrevNextSplinePoint ( bool bNextPoint,
bool bAddToSelection
)

 Select next or prev spline point, loops when last point is currently selected SplineComponentVisualizer.h  

virtual void SetCachedRotation ( const FQuat& NewRotation
)

 Sets the new cached rotation on the visualizer SplineComponentVisualizer.h  

virtual bool ShouldShowForSelectedSubcomponents ( const UActorComponent* Component
)

   SplineComponentVisualizer.h  

virtual void TrackingStopped ( FEditorViewportClient* InViewportClient,
bool bInDidMove
)

 Gets called when the mouse tracking has stopped (dragging behavior) SplineComponentVisualizer.h  

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

   SplineComponentVisualizer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ActivateVisualization()

   SplineComponentVisualizer.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   SplineComponentVisualizer.h  

virtual void AddSegment ( const FVector& InWorldPos,
bool bAppend
)

 Add segment to beginning or end of spline SplineComponentVisualizer.h  

bool AreKeysSelected()

 Whether any keys are currently selected SplineComponentVisualizer.h  

bool AreMultipleKeysSelected()

 Whether a multiple spline keys are currently selected SplineComponentVisualizer.h  

bool CanAddAttributeKey()

   SplineComponentVisualizer.h  

bool CanAddKeyToSegment()

   SplineComponentVisualizer.h  

bool CanDeleteAttributeKey()

   SplineComponentVisualizer.h  

bool CanDeleteKey()

   SplineComponentVisualizer.h  

bool CanResetToAutomaticTangent ( EInterpCurveMode Mode
) const

   SplineComponentVisualizer.h  

bool CanResetToDefault()

   SplineComponentVisualizer.h  

bool CanSelectSplinePoints()

   SplineComponentVisualizer.h  

virtual void ChangeSelectionState ( int32 Index,
bool bIsCtrlHeld
)

 Update the key selection state of the visualizer SplineComponentVisualizer.h  

void CreateSplineGeneratorPanel()

   SplineComponentVisualizer.h  

virtual bool DuplicateKeyForAltDrag ( const FVector& InDrag
)

 Alt-drag: duplicates the selected spline key SplineComponentVisualizer.h  

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

 Return spline data for point on spline closest to input point SplineComponentVisualizer.h  

TSharedPtr< SWidget > GenerateAttributeEditorWidget()

 Generate the attribute editor widget. SplineComponentVisualizer.h  

void GenerateAttributeMenuSection ( FMenuBuilder& InMenuBuilder
) const

 Extends the provided MenuBuilder with an Attribute section SplineComponentVisualizer.h  

TSharedPtr< SWidget > GenerateChannelCreatorWidget()

   SplineComponentVisualizer.h  

TSharedPtr< SWidget > GenerateChannelSelectorWidget()

   SplineComponentVisualizer.h  

TSharedPtr< SWidget > GenerateChannelWidget()

 Generate the channel creator/selector widget. SplineComponentVisualizer.h  

void GenerateLockAxisSubMenu ( FMenuBuilder& MenuBuilder
) const

 Generate the submenu containing the lock axis types SplineComponentVisualizer.h  

void GenerateSelectSplinePointsSubMenu ( FMenuBuilder& MenuBuilder
) const

 Generate the submenu containing available selection actions SplineComponentVisualizer.h  

void GenerateSnapAlignSubMenu ( FMenuBuilder& MenuBuilder
) const

 Generate the submenu containing the available snap/align actions SplineComponentVisualizer.h  

void GenerateSplinePointTypeSubMenu ( FMenuBuilder& MenuBuilder
) const

 Generate the submenu containing the available point types SplineComponentVisualizer.h  

void GenerateTangentTypeSubMenu ( FMenuBuilder& MenuBuilder
) const

 Generate the submenu containing the available auto tangent types SplineComponentVisualizer.h  

virtual FString GetReferencerName()

   SplineComponentVisualizer.h  

virtual bool GetSnapToActorMode ( ESplineComponentSnapMode& OutSnapMode
) const

 Snapping: get snap to actor temporary mode SplineComponentVisualizer.h  

bool IsAnySelectedKeyIndexOutOfRange ( const USplineComponent* Comp
) const

 Determine if any selected key index is out of range (perhaps because something external has modified the spline) SplineComponentVisualizer.h  

bool IsClosedLoop()

   SplineComponentVisualizer.h  

bool IsDiscontinuousSpline()

   SplineComponentVisualizer.h  

bool IsEnabledForSpline ( const USplineComponent* InSplineComponent
) const

   SplineComponentVisualizer.h  

bool IsKeySelectionValid()

   SplineComponentVisualizer.h  

bool IsKeyTypeSet ( EInterpCurveMode Mode
) const

   SplineComponentVisualizer.h  

bool IsLockAxisSet ( EAxis::Type InAxis
) const

   SplineComponentVisualizer.h  

bool IsSingleKeySelected()

 Whether a single spline key is currently selected SplineComponentVisualizer.h  

bool IsSnapTangentAdjustment()

   SplineComponentVisualizer.h  

bool IsVisualizingRollAndScale()

   SplineComponentVisualizer.h  

void OnAddAttributeKey()

   SplineComponentVisualizer.h  

void OnAddKeyToSegment()

   SplineComponentVisualizer.h  

void OnDeleteAttributeKey()

   SplineComponentVisualizer.h  

void OnDeleteKey()

   SplineComponentVisualizer.h  

void OnDeselectedInEditor ( TObjectPtr< USplineComponent > SplineComponent
)

   SplineComponentVisualizer.h  

void OnDuplicateKey()

 Duplicates selected spline keys in place SplineComponentVisualizer.h  

void OnLockAxis ( EAxis::Type InAxis
)

   SplineComponentVisualizer.h  

void OnResetToAutomaticTangent ( EInterpCurveMode Mode
)

   SplineComponentVisualizer.h  

void OnResetToDefault()

   SplineComponentVisualizer.h  

void OnSelectAllSplinePoints()

 Select all spline points, if no spline points selected yet the currently edited spline component will be set as well SplineComponentVisualizer.h  

void OnSelectFirstLastSplinePoint ( bool bFirstPoint
)

 Select first or last spline point SplineComponentVisualizer.h  

void OnSetDiscontinuousSpline()

   SplineComponentVisualizer.h  

void OnSetKeyType ( EInterpCurveMode Mode
)

   SplineComponentVisualizer.h  

void OnSetVisualizeRollAndScale()

   SplineComponentVisualizer.h  

void OnSnapAllToAxis ( EAxis::Type InAxis
)

   SplineComponentVisualizer.h  

void OnSnapKeyToActor ( const ESplineComponentSnapMode InSnapMode
)

   SplineComponentVisualizer.h  

void OnSnapKeyToNearestSplinePoint ( ESplineComponentSnapMode InSnapMode
)

   SplineComponentVisualizer.h  

void OnSnapSelectedToAxis ( EAxis::Type InAxis
)

   SplineComponentVisualizer.h  

void OnStraightenKey ( int32 Direction
)

   SplineComponentVisualizer.h  

void OnToggleClosedLoop()

   SplineComponentVisualizer.h  

void OnToggleSnapTangentAdjustment()

   SplineComponentVisualizer.h  

virtual void ResetAllowDuplication()

 Alt-drag: duplicates the selected spline key SplineComponentVisualizer.h  

virtual void ResetTempModes()

 Reset temporary modes after inputs are handled. SplineComponentVisualizer.h  

void SelectSplinePoint ( int32 SelectIndex,
bool bAddToSelection
)

 Select spline point at specified index SplineComponentVisualizer.h  

void SetEditedSplineComponent ( const USplineComponent* InSplineComponent
)

 Helper function to set edited component we are currently editing SplineComponentVisualizer.h  

virtual void SetSnapToActorMode ( const bool bInIsSnappingToActor,
const ESplineComponentSnapMode InSnapMode
)

 Snapping: set snap to actor temporary mode SplineComponentVisualizer.h  

bool ShouldUseForSpline ( const USplineComponent* SplineComponent
) const

   SplineComponentVisualizer.h  

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

 Snapping: snap keys to axis position of last selected key SplineComponentVisualizer.h  

virtual void SnapKeyToActor ( const AActor* InActor,
const ESplineComponentSnapMode SnapMode
)

 Snapping: snap key to selected actor SplineComponentVisualizer.h  

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 SplineComponentVisualizer.h  

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

 Split segment using given world position SplineComponentVisualizer.h  

void StraightenKey ( int32 KeyToStraighten,
int32 KeyToStraightenToward
)

   SplineComponentVisualizer.h  

bool TransformSelectedAttribute ( EPropertyChangeType::Type InPropertyChangeType,
const FVector& InDeltaTranslate
)

 Transforms selected attribute by given translation SplineComponentVisualizer.h  

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

 Transforms selected tangent by given translate, rotate and scale SplineComponentVisualizer.h  

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

 Transforms selected tangent by given translation SplineComponentVisualizer.h  

virtual void UpdateAddSegment ( const FVector& InWorldPos
)

 Add segment to beginning or end of spline SplineComponentVisualizer.h  

virtual bool UpdateDuplicateKeyForAltDrag ( const FVector& InDrag
)

 Alt-drag: updates duplicated selected spline key SplineComponentVisualizer.h  

const USplineComponent * UpdateSelectedSplineComponent ( HComponentVisProxy* VisProxy
)

 Updates the component and selected properties if the component has changed SplineComponentVisualizer.h  

void UpdateSharedAttributeNames()

   SplineComponentVisualizer.h  

virtual void UpdateSplitSegment ( const FVector& InDrag
)

 Update split segment based on drag offset SplineComponentVisualizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page