1. Epic GamesDeveloper
  3. FComponentVisualizer

FComponentVisualizer

Base class for a component visualizer, that draw editor information for a particular component class

API > API/Editor > API/Editor/UnrealEd

Base class for a component visualizer, that draw editor information for a particular component class

   
Name FComponentVisualizer
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/ComponentVisualizer.h
Include Path #include "ComponentVisualizer.h"

Syntax

class FComponentVisualizer : public TSharedFromThis< FComponentVisualizer >

Inheritance Hierarchy

Derived Classes

FComponentVisualizer derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FComponentVisualizer()

   ComponentVisualizer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FComponentVisualizer()

   ComponentVisualizer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Draw visualization for the supplied component ComponentVisualizer.h  

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

 Draw HUD on viewport for the supplied component ComponentVisualizer.h  

virtual void EndEditing()

   ComponentVisualizer.h  

virtual TSharedPtr< SWidget > GenerateContextMenu()

   ComponentVisualizer.h  

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

   ComponentVisualizer.h  

virtual UActorComponent * GetEditedComponent()

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

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

   ComponentVisualizer.h  

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

 Handle box select input ComponentVisualizer.h  

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

 Handle frustum select input ComponentVisualizer.h  

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

   ComponentVisualizer.h  

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

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

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

 Pass snap input to active visualizer ComponentVisualizer.h  

virtual bool HasFocusOnSelectionBoundingBox ( FBox& OutBoundingBox
)

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

virtual bool IsVisualizingArchetype()

   ComponentVisualizer.h  

virtual void OnRegister()

   ComponentVisualizer.h  
Determines whether, if the visualizer returns true from VisProxyHandleClick, the hitproxy element should be automatically selected. ComponentVisualizer.h  

virtual bool ShouldShowForSelectedSubcomponents ( const UActorComponent* Component
)

 Show this visualizer if the component is indirectly selected ComponentVisualizer.h  

virtual void TrackingStarted ( FEditorViewportClient* InViewportClient
)

 Gets called when the mouse tracking has started (dragging behavior) ComponentVisualizer.h  

virtual void TrackingStopped ( FEditorViewportClient* InViewportClient,
bool bInDidMove
)

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

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

   ComponentVisualizer.h  

Static

Name Remarks Include Path Unreal Specifiers

static void NotifyPropertiesModified ( UActorComponent* Component,
const TArray< FProperty* >& Properties,
EPropertyChangeType::Type PropertyChangeType
)

 Notify that many component properties have been modified ComponentVisualizer.h  

static void NotifyPropertyModified ( UActorComponent* Component,
FProperty* Property,
EPropertyChangeType::Type PropertyChangeType
)

 So deprecated code expecting this as an inner class still works Notify that a component property has been modified ComponentVisualizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page