Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > FComponentVisualizer

Light Theme

Dark Theme

FComponentVisualizer

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

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
	FComponentVisualizer()

Destructors

	Name	Description
	~FComponentVisualizer()

Functions

	Name	Description
void	DrawVisualization ( const UActorComponent* Compone..., const FSceneView* View, FPrimitiveDrawInterface* PDI )	Draw visualization for the supplied component
void	DrawVisualizationHUD ( const UActorComponent* Compone..., const FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )	Draw HUD on viewport for the supplied component
void	EndEditing()
TSharedPtr< ...	GenerateContextMenu()
bool	GetCustomInputCoordinateSystem ( const FEditorViewportClient* V..., FMatrix& OutMatrix )
UActorCompon...	GetEditedComponent()	Get currently edited component, this is needed to reset the active visualizer after undo/redo
bool	GetWidgetLocation ( const FEditorViewportClient* V..., FVector& OutLocation )
bool	HandleBoxSelect ( const FBox& InBox, FEditorViewportClient* InViewp..., FViewport* InViewport )	Handle box select input
bool	HandleFrustumSelect ( const FConvexVolume& InFrustum, FEditorViewportClient* InViewp..., FViewport* InViewport )	Handle frustum select input
bool	HandleInputDelta ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FVector& DeltaTranslate, FRotator& DeltaRotate, FVector& DeltaScale )
bool	HandleInputKey ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FKey Key, EInputEvent Event )
bool	HandleModifiedClick ( FEditorViewportClient* InViewp..., HHitProxy* HitProxy, const FViewportClick& Click )	Handle click modified by Alt, Ctrl and/or Shift. The input HitProxy may not be on this component.
bool	HandleSnapTo ( const bool bInAlign, const bool bInUseLineTrace, const bool bInUseBounds, const bool bInUsePivot, AActor* InDestination )	Pass snap input to active visualizer
bool	HasFocusOnSelectionBoundingBox ( FBox& OutBoundingBox )	Return whether focus on selection should focus on bounding box defined by active visualizer
bool	IsVisualizingArchetype()
void	NotifyPropertiesModified ( UActorComponent* Component, const TArray< FProperty* >& P..., EPropertyChangeType::Type PropertyC... )	Notify that many component properties have been modified
void	NotifyPropertyModified ( UActorComponent* Component, FProperty* Property, EPropertyChangeType::Type PropertyC... )	Notify that a component property has been modified
void	OnRegister()
bool	ShouldShowForSelectedSubcomponents ( const UActorComponent* Compone... )	Show this visualizer if the component is directly is selected
bool	ShowWhenSelected()	Only show this visualizer if the actor is selected
void	TrackingStarted ( FEditorViewportClient* InViewp... )	Gets called when the mouse tracking has started (dragging behavior)
void	TrackingStopped ( FEditorViewportClient* InViewp..., bool bInDidMove )	Gets called when the mouse tracking has stopped (dragging behavior)
bool	VisProxyHandleClick ( FEditorViewportClient* InViewp..., HComponentVisProxy* VisProxy, const FViewportClick& Click )

Typedefs

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

Deprecated Functions

		Name	Description
	UActorCompon...	GetComponentFromPropertyName ( const AActor* CompOwner, const FPropertyNameAndIndex& Prope... )	Please use the FComponentPropertyPath::GetComponent() to retrieve a component pointer from a property name path.
	FPropertyNam...	GetComponentPropertyName ( const UActorComponent* Compone... )	Please use the FComponentPropertyPath class to build property name paths for components.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel