UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UGizmoBaseComponent Class Reference

#include <GizmoBaseComponent.h>

+ Inheritance diagram for UGizmoBaseComponent:

Public Member Functions

 UGizmoBaseComponent ()
 
void NotifyExternalPropertyUpdates ()
 
void SetGizmoViewContext (UGizmoViewContext *GizmoViewContextIn)
 
virtual void UpdateHoverState (bool bHoveringIn) override
 
virtual void UpdateWorldLocalState (bool bWorldIn) override
 
- Public Member Functions inherited from IGizmoBaseComponentInterface
virtual void UpdateInteractingState (bool bInteractingIn)
 

Public Attributes

FLinearColor Color = FLinearColor::Red
 
float HoverSizeMultiplier = 2.0f
 
float PixelHitDistanceThreshold = 7.0f
 

Protected Attributes

bool bHovering = false
 
bool bWorld = false
 
TObjectPtr< UGizmoViewContextGizmoViewContext = nullptr
 
bool bIsViewDependent = false
 

Detailed Description

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

Constructor & Destructor Documentation

◆ UGizmoBaseComponent()

UGizmoBaseComponent::UGizmoBaseComponent ( )
inline

Member Function Documentation

◆ NotifyExternalPropertyUpdates()

void UGizmoBaseComponent::NotifyExternalPropertyUpdates ( )
inline

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

◆ SetGizmoViewContext()

void UGizmoBaseComponent::SetGizmoViewContext ( UGizmoViewContext GizmoViewContextIn)
inline

◆ UpdateHoverState()

virtual void UGizmoBaseComponent::UpdateHoverState ( bool  bHoveringIn)
inlineoverridevirtual

Reimplemented from IGizmoBaseComponentInterface.

◆ UpdateWorldLocalState()

virtual void UGizmoBaseComponent::UpdateWorldLocalState ( bool  bWorldIn)
inlineoverridevirtual

Reimplemented from IGizmoBaseComponentInterface.

Member Data Documentation

◆ bHovering

bool UGizmoBaseComponent::bHovering = false
protected

◆ bIsViewDependent

bool UGizmoBaseComponent::bIsViewDependent = false
protected

◆ bWorld

bool UGizmoBaseComponent::bWorld = false
protected

◆ Color

FLinearColor UGizmoBaseComponent::Color = FLinearColor::Red

◆ GizmoViewContext

TObjectPtr<UGizmoViewContext> UGizmoBaseComponent::GizmoViewContext = nullptr
protected

◆ HoverSizeMultiplier

float UGizmoBaseComponent::HoverSizeMultiplier = 2.0f

◆ PixelHitDistanceThreshold

float UGizmoBaseComponent::PixelHitDistanceThreshold = 7.0f

The documentation for this class was generated from the following file: