FComponentVisualizer

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

Windows
MacOS
Linux

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

Name Description

Public function

FComponentVisualizer()

Destructors

Name Description

Public function Virtual

~FComponentVisualizer()

Functions

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

 

EndEditing()

Public function Virtual Const

TSharedPtr< SWidget >

 

GenerateContextMenu()

Public function Virtual Const

bool

 

GetCustomInputCoordinateSystem

(
    const FEditorViewportClient* ViewportClient,
    FMatrix& OutMatrix
)

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& DeltalRotate,
    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

 

IsVisualizingArchetype()

Public function Static

void

 

NotifyPropertiesModified

(
    UActorComponent* Component,
    const TArray< UProperty* >& Properties
)

Notify that many component properties have been modified

Public function Static

void

 

NotifyPropertyModified

(
    UActorComponent* Component,
    UProperty* Property
)

Notify that a component property has been modified

Public function Virtual

void

 

OnRegister()

Public function Virtual

bool

 

VisProxyHandleClick

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

Classes

Name

Description

Public struct

FPropertyNameAndIndex

Deprecated Functions

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

 

GetComponentPropertyName

(
    const UActorComponent* Component
)

Please use the FComponentPropertyPath class to build property name paths for components.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback