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

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/ComponentVisualizer.h
Include #include "ComponentVisualizer.h"

Syntax

class FComponentVisualizer : public TSharedFromThis< FComponentVisualizer >

Remarks

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  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 Static void

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

 Notify that many component properties have been modified
Public function Static void

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

 Notify that a component property has been modified
Public function Virtual void  
Public function Virtual bool Show this visualizer if the component is directly is selected
Public function Virtual bool Only show this visualizer if the actor is selected
Public function Virtual void

TrackingStarted ( FEditorViewportClient* InViewportClient
)

 Gets called when the mouse tracking has started (dragging behavior)
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
)

  

Typedefs

Name Description
FPropertyNameAndIndex So deprecated code expecting this as an inner class still works.

Deprecated Functions

  Type Name Description
Public function Static UActorComponent *

GetComponentFromPropertyName ( const AActor* CompOwner,
const FPropertyNameAndIndex& Property
)

 Please use the FComponentPropertyPath::GetComponent() to retrieve a component pointer from a property name path.
Public function Static FPropertyNameAndIndex Please use the FComponentPropertyPath class to build property name paths for components.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page