Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Simple group object intended to be used as part of 3D Gizmos. Contains multiple gizmo objects.
| Name | UGizmoElementGroup |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementGroup.h |
| Include Path | #include "BaseGizmos/GizmoElementGroup.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UGizmoElementGroup : public UGizmoElementLineBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoElementBase → UGizmoElementLineBase → UGizmoElementGroup
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Add
(
UGizmoElementBase* InElement |
Add object to group. | BaseGizmos/GizmoElementGroup.h | |
virtual bool GetConstantScale() |
BaseGizmos/GizmoElementGroup.h | ||
virtual bool GetHitOwner() |
BaseGizmos/GizmoElementGroup.h | ||
virtual FInputRayHit LineTrace
(
const UGizmoViewContext* ViewContext, |
BaseGizmos/GizmoElementGroup.h | ||
virtual void Remove
(
UGizmoElementBase* InElement |
Remove object from group, if it exists. | BaseGizmos/GizmoElementGroup.h | |
virtual void Render
(
IToolsContextRenderAPI* RenderAPI, |
BaseGizmos/GizmoElementGroup.h | ||
virtual void SetConstantScale
(
bool InConstantScale |
When true, maintains view-dependent constant scale for this gizmo object hierarchy. | BaseGizmos/GizmoElementGroup.h | |
virtual void SetHitOwner
(
bool bInHitOwner |
Set whether this group should be treated as a hit owner and its part identifier returned when any of its sub-elements are hit. | BaseGizmos/GizmoElementGroup.h |
Overridden from UGizmoElementBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TOptional< bool > GetPartHittableState
(
uint32 InPartIdentifier |
Get element's hittable state for element associated with the specified gizmo part, if part was found. | BaseGizmos/GizmoElementGroup.h | |
virtual TOptional< EGizmoElementInteractionState > GetPartInteractionState
(
uint32 InPartIdentifiero |
Get element's interaction state for element associated with the specified gizmo part, if part was found. | BaseGizmos/GizmoElementGroup.h | |
virtual TOptional< bool > GetPartVisibleState
(
uint32 InPartIdentifier |
Get element's visible state for element associated with the specified gizmo part, if part was found. | BaseGizmos/GizmoElementGroup.h | |
virtual bool UpdatePartHittableState
(
bool bHittable, |
Update group and contained elements' hittable state for elements in specified gizmo parts, return true if part was found. | BaseGizmos/GizmoElementGroup.h | |
virtual bool UpdatePartInteractionState
(
EGizmoElementInteractionState InInteractionState, |
Update group and contained elements' interaction state for elements in specified gizmo parts, return true if part was found. | BaseGizmos/GizmoElementGroup.h | |
virtual bool UpdatePartVisibleState
(
bool bVisible, |
Update group and contained elements' visibility state for elements in specified gizmo parts, return true if part was found. | BaseGizmos/GizmoElementGroup.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ApplyUniformConstantScaleToTransform
(
double PixelToWorldScale, |
Updates input transform's scale component to have uniform scale and applies constant scale if bConstantScale is true. | BaseGizmos/GizmoElementGroup.h |