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 > Runtime > InteractiveToolsFramework > BaseGizmos > UGizmoBaseComponent

Light Theme

Dark Theme

UGizmoBaseComponent

Base class for simple Components intended to be used as part of 3D Gizmos.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UGizmoBaseComponent

	UGizmoArrowComponent
	UGizmoBoxComponent
	UGizmoCircleComponent
	UGizmoLineHandleComponent
	UGizmoRectangleComponent

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseGizmos/GizmoBaseComponent.h
Include	#include "BaseGizmos/GizmoBaseComponent.h"

Syntax

class UGizmoBaseComponent : public UPrimitiveComponent

Remarks

Base class for simple Components intended to be used as part of 3D Gizmos. Contains common properties and utility functions. This class does nothing by itself, use subclasses like UGizmoCircleComponent

Variables

	Name	Description
bool	bHovering	Hover state
bool	bWorld	World/local coordinates state
FLinearColor	Color
float	DynamicPixelToWorldScale	Scale factor between pixel distances and world distances at Gizmo origin
float	HoverSizeMultiplier
float	PixelHitDistanceThreshold

Constructors

	Name	Description
	UGizmoBaseComponent()

Functions

	Name	Description
void	NotifyExternalPropertyUpdates()	Currently this must be called if you change UProps on Base or subclass, to recreate render proxy which has a local copy of those settings
void	UpdateHoverState ( bool bHoveringIn )
void	UpdateWorldLocalState ( bool bWorldIn )

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

Take our survey

Dismiss