UGizmoBaseComponent

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/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

Protected variable

bool

 

bHovering

Hover state

Protected variable

bool

 

bIsViewDependent

True when GizmoViewContext is not null.

Protected variable

bool

 

bWorld

World/local coordinates state

Public variable

FLinearColor

 

Color

Protected variable

TObjectPtr< UGi...

 

GizmoViewContext

Public variable

float

 

HoverSizeMultiplier

Public variable

float

 

PixelHitDistanceThreshold

Constructors

Name Description

Public function

UGizmoBaseComponent()

Functions

Name Description

Public function

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

Public function

void

 

SetGizmoViewContext

(
    UGizmoViewContext* GizmoViewCo...
)

Public function

void

 

UpdateHoverState

(
    bool bHoveringIn
)

Public function

void

 

UpdateWorldLocalState

(
    bool bWorldIn
)