UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | List of all members
FGizmoElementAccessor Class Reference

#include <GizmoUtil.h>

Public Member Functions

INTERACTIVETOOLSFRAMEWORK_API bool UpdateRenderState (UGizmoElementBase &InGizmoElement, IToolsContextRenderAPI *InRenderAPI, const FVector &InLocalCenter, UGizmoElementBase::FRenderTraversalState &InOutRenderState) const
 
INTERACTIVETOOLSFRAMEWORK_API bool UpdateRenderState (UGizmoElementBase &InGizmoElement, IToolsContextRenderAPI *InRenderAPI, const FVector &InLocalCenter, UGizmoElementBase::FRenderTraversalState &InOutRenderState, bool &bOutHasAlignRot, FQuat &OutAlignRot) const
 

Static Public Member Functions

static INTERACTIVETOOLSFRAMEWORK_API TConstArrayView< TObjectPtr< UGizmoElementBase > > GetSubElements (const UGizmoElementBase &InGizmoElement)
 
static INTERACTIVETOOLSFRAMEWORK_API void GetSubElementsRecursive (const UGizmoElementBase &InGizmoElement, TArray< TObjectPtr< UGizmoElementBase > > &OutElements)
 
static INTERACTIVETOOLSFRAMEWORK_API bool GetSubElementsRecursive (const UGizmoElementBase &InGizmoElement, TArray< TObjectPtr< UGizmoElementBase > > &OutElements, const uint32 InPartId)
 
static INTERACTIVETOOLSFRAMEWORK_API bool IsEnabledForInteractionState (const UGizmoElementBase &InGizmoElement, const TOptional< EGizmoElementInteractionState > &InInteractionState={})
 
static INTERACTIVETOOLSFRAMEWORK_API bool IsPartial (UGizmoElementCircleBase &InGizmoElement, const FVector &InWorldCenter, const FVector &InWorldNormal, const FVector &InViewLocation, const FVector &InViewDirection, const bool bIsPerspectiveProjection)
 

Detailed Description

A utility class to access GizmoElements that aren't otherwise publicly exposed. Use responsibly.

Member Function Documentation

◆ GetSubElements()

TConstArrayView< TObjectPtr< UGizmoElementBase > > FGizmoElementAccessor::GetSubElements ( const UGizmoElementBase &  InGizmoElement)
static

◆ GetSubElementsRecursive() [1/2]

void FGizmoElementAccessor::GetSubElementsRecursive ( const UGizmoElementBase &  InGizmoElement,
TArray< TObjectPtr< UGizmoElementBase > > &  OutElements 
)
static

◆ GetSubElementsRecursive() [2/2]

bool FGizmoElementAccessor::GetSubElementsRecursive ( const UGizmoElementBase &  InGizmoElement,
TArray< TObjectPtr< UGizmoElementBase > > &  OutElements,
const uint32  InPartId 
)
static

◆ IsEnabledForInteractionState()

bool FGizmoElementAccessor::IsEnabledForInteractionState ( const UGizmoElementBase &  InGizmoElement,
const TOptional< EGizmoElementInteractionState > &  InInteractionState = {} 
)
static

Returns whether element is enabled for given interaction state. If the provided interaction state isn't set, it will use the currently applied state to the given element.

◆ IsPartial()

bool FGizmoElementAccessor::IsPartial ( UGizmoElementCircleBase &  InGizmoElement,
const FVector &  InWorldCenter,
const FVector &  InWorldNormal,
const FVector &  InViewLocation,
const FVector &  InViewDirection,
const bool  bIsPerspectiveProjection 
)
static

◆ UpdateRenderState() [1/2]

bool FGizmoElementAccessor::UpdateRenderState ( UGizmoElementBase &  InGizmoElement,
IToolsContextRenderAPI *  InRenderAPI,
const FVector &  InLocalCenter,
UGizmoElementBase::FRenderTraversalState &  InOutRenderState 
) const

Updates the given render state from the given GizmoElement.

◆ UpdateRenderState() [2/2]

bool FGizmoElementAccessor::UpdateRenderState ( UGizmoElementBase &  InGizmoElement,
IToolsContextRenderAPI *  InRenderAPI,
const FVector &  InLocalCenter,
UGizmoElementBase::FRenderTraversalState &  InOutRenderState,
bool &  bOutHasAlignRot,
FQuat &  OutAlignRot 
) const

Updates the given render state from the given GizmoElement.

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