1. Epic GamesDeveloper
  3. UGizmoElementGroup

UGizmoElementGroup

Simple group object intended to be used as part of 3D Gizmos. Contains multiple gizmo objects.

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos

Inheritance Hierarchy

References

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

Syntax

UCLASS (Transient, MinimalAPI)  
class UGizmoElementGroup : public UGizmoElementLineBase

Remarks

Simple group object intended to be used as part of 3D Gizmos. Contains multiple gizmo objects.

Variables

  Type Name Description
Protected variable UProperty bool bConstantScale When true, maintains view-dependent constant scale for this gizmo object hierarchy.
Protected variable UProperty bool bHitOwner When true, this group is treated as a single element such that when LineTrace is called, if any of its sub-elements is hit, this group will be returned as the owner of the hit.
Protected variable UProperty TArray< TObjectPtr< UGizmoElementBase > > Elements Gizmo elements within this group.

Functions

  Type Name Description
Public function Virtual void

Add ( UGizmoElementBase* InElement
)

 Add object to group.
Protected function Virtual Const void

ApplyUniformConstantScaleToTransform ( double PixelToWorldScale,
FTransform& InOutLocalToWorldTransform
)

 Updates input transform's scale component to have uniform scale and applies constant scale if bConstantScale is true.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual FInputRayHit

LineTrace ( const UGizmoViewContext* ViewContext,
const FLineTraceTraversalState& LineTraceState,
const FVector& RayOrigin,
const FVector& RayDirection
)

  
Public function Virtual void

Remove ( UGizmoElementBase* InElement
)

 Remove object from group, if it exists.
Public function Virtual void

Render ( IToolsContextRenderAPI* RenderAPI,
const FRenderTraversalState& RenderState
)

  
Public function Virtual void

SetConstantScale ( bool InConstantScale
)

 When true, maintains view-dependent constant scale for this gizmo object hierarchy.
Public function 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.

Overridden from UGizmoElementBase

  Type Name Description
Public function Virtual Const TOptional< bool >

GetPartHittableState ( uint32 InPartIdentifier
)

 Get element's hittable state for element associated with the specified gizmo part, if part was found.
Public function Virtual Const TOptional< EGizmoElementInteractionState >

GetPartInteractionState ( uint32 InPartIdentifiero
)

 Get element's interaction state for element associated with the specified gizmo part, if part was found.
Public function Virtual Const TOptional< bool >

GetPartVisibleState ( uint32 InPartIdentifier
)

 Get element's visible state for element associated with the specified gizmo part, if part was found.
Public function Virtual bool

UpdatePartHittableState ( bool bHittable,
uint32 InPartIdentifier
)

 Update group and contained elements' hittable state for elements in specified gizmo parts, return true if part was found.
Public function Virtual bool

UpdatePartInteractionState ( EGizmoElementInteractionState InInteractionState,
uint32 InPartIdentifier
)

 Update group and contained elements' interaction state for elements in specified gizmo parts, return true if part was found.
Public function Virtual bool

UpdatePartVisibleState ( bool bVisible,
uint32 InPartIdentifier
)

 Update group and contained elements' visibility state for elements in specified gizmo parts, return true if part was found.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page