1. Epic GamesDeveloper
  3. UGizmoElementBase

UGizmoElementBase

Base class for 2d and 3d primitive objects intended to be used as part of 3D Gizmos.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

Base class for 2d and 3d primitive objects intended to be used as part of 3D Gizmos. Contains common properties and utility functions. This class does nothing by itself, use subclasses like UGizmoElementCylinder

   
Name UGizmoElementBase
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementBase.h
Include Path #include "BaseGizmos/GizmoElementBase.h"

Syntax

UCLASS (Transient, Abstract, MinimalAPI)  
class UGizmoElementBase : public UObject

Inheritance Hierarchy

Derived Classes

UGizmoElementBase derived class hierarchy

Structs

Name Remarks
FLineTraceOutput Contains information about a line trace, in addition to FInputRayHit.
FLineTraceTraversalState  
FRenderTraversalState Render traversal state structure used to maintain the current render state while rendering.

Constants

Name Type Remarks Include Path
DefaultPartIdentifier uint32   BaseGizmos/GizmoElementBase.h
DefaultViewAlignAngleTol float   BaseGizmos/GizmoElementBase.h
DefaultViewAlignMaxCosAngleTol float   BaseGizmos/GizmoElementBase.h
DefaultViewDependentAngleTol float   BaseGizmos/GizmoElementBase.h
DefaultViewDependentAxialMaxCosAngleTol float   BaseGizmos/GizmoElementBase.h
DefaultViewDependentPlanarMinCosAngleTol float   BaseGizmos/GizmoElementBase.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DrawHUD void virtual Render(IToolsContextRenderAPI *RenderAPI, const FRenderTraversalState &RenderState) PURE_VIRTUAL(UGizmoElementBase voi Render enabled visible element. BaseGizmos/GizmoElementBase.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ViewDepthOffset float Additional view-space offset to apply to the element, affecting both visuals and the hit geometry. BaseGizmos/GizmoElementBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ClearHoverMaterial()

 Clear mesh render state hover material attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearHoverVertexColor()

 Clear mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearInteractMaterial()

 Clear mesh render interact state material attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearInteractVertexColor()

 Clear mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearMaterial()

 Clear mesh render state material attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearSelectMaterial()

 Clear mesh render Select state material attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearSelectVertexColor()

 Clear mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearSubdueMaterial()

 Clear mesh render Subdue state material attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearSubdueVertexColor()

 Clear mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void ClearVertexColor()

 Clear mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual bool DoesHoverMaterialOverrideChildState()

 Get mesh render state hover material attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesHoverVertexColorOverrideChildState()

 Get mesh render state vertex color attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesInteractMaterialOverrideChildState()

 Get mesh render state interact material attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesInteractVertexColorOverrideChildState()

 Get mesh render state vertex color attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesMaterialOverrideChildState()

 Get mesh render state material attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesSelectMaterialOverrideChildState()

 Get mesh render state Select material attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesSelectVertexColorOverrideChildState()

 Get mesh render state vertex color attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesSubdueMaterialOverrideChildState()

 Get mesh render state Subdue material attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesSubdueVertexColorOverrideChildState()

 Get mesh render state vertex color attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual bool DoesVertexColorOverrideChildState()

 Get mesh render state vertex color attribute's override setting. BaseGizmos/GizmoElementBase.h  

virtual UGizmoElementBase * FindPartElement ( const uint32 InPartId
)

 Returns the element associated with the specified part id, or nullptr if not found. BaseGizmos/GizmoElementBase.h  

virtual const UGizmoElementBase * FindPartElement ( const uint32 InPartId
) const

 Returns the element associated with the specified part id, or nullptr if not found. BaseGizmos/GizmoElementBase.h  

virtual EGizmoElementInteractionState GetElementInteractionState()

   BaseGizmos/GizmoElementBase.h  

virtual EGizmoElementState GetElementState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabled()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForDefaultState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForHoveringState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForInteractingState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForPerspectiveProjection()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForSelectedState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForSubduedState()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledInOrthographicProjection()

   BaseGizmos/GizmoElementBase.h  

virtual int32 GetHitPriority()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetHittableState()

   BaseGizmos/GizmoElementBase.h  

virtual const UMaterialInterface * GetHoverMaterial ()

 Get mesh render state hover material attribute's value. BaseGizmos/GizmoElementBase.h  

virtual FLinearColor GetHoverVertexColor()

 Get mesh render state vertex color attribute's value. BaseGizmos/GizmoElementBase.h  

virtual const UMaterialInterface * GetInteractMaterial ()

 Get mesh render state interact material attribute's value. BaseGizmos/GizmoElementBase.h  

virtual FLinearColor GetInteractVertexColor()

 Get mesh render state vertex color attribute's value. BaseGizmos/GizmoElementBase.h  

virtual const UMaterialInterface * GetMaterial ()

 Get mesh render state material attribute's value. BaseGizmos/GizmoElementBase.h  

virtual float GetMinimumPixelHitDistanceThreshold()

   BaseGizmos/GizmoElementBase.h  

virtual TOptional< bool > GetPartHittableState ( uint32 InPartIdentifier
) const

 Get element's hittable state for element associated with the specified gizmo part, if part id was found. BaseGizmos/GizmoElementBase.h  

virtual uint32 GetPartIdentifier ()

   BaseGizmos/GizmoElementBase.h  

virtual uint32 GetPartIdentifier ()

   BaseGizmos/GizmoElementBase.h  

virtual TOptional< EGizmoElementInteractionState > GetPartInteractionState ( uint32 InPartIdentifier
) const

 Get element's interaction state for element associated with the specified gizmo part, if part id was found. BaseGizmos/GizmoElementBase.h  

virtual TOptional< bool > GetPartVisibleState ( uint32 InPartIdentifier
) const

 Get element's visible state for element associated with the specified gizmo part, if part id was found. BaseGizmos/GizmoElementBase.h  

virtual float GetPixelHitDistanceThreshold()

   BaseGizmos/GizmoElementBase.h  

virtual const UMaterialInterface * GetSelectMaterial ()

 Get mesh render state Select material attribute's value. BaseGizmos/GizmoElementBase.h  

virtual FLinearColor GetSelectVertexColor()

 Get mesh render state vertex color attribute's value. BaseGizmos/GizmoElementBase.h  

virtual const UMaterialInterface * GetSubdueMaterial ()

 Get mesh render state Subdue material attribute's value. BaseGizmos/GizmoElementBase.h  

virtual FLinearColor GetSubdueVertexColor()

 Get mesh render state vertex color attribute's value. BaseGizmos/GizmoElementBase.h  

virtual TConstArrayView< TObjectPtr< UGizmoElementBase > > GetSubElements()

 Get the (top-level) sub-elements, if any. BaseGizmos/GizmoElementBase.h  

virtual FLinearColor GetVertexColor()

 Get mesh render state vertex color attribute's value. BaseGizmos/GizmoElementBase.h  

virtual float GetViewAlignAxialAngleTol()

   BaseGizmos/GizmoElementBase.h  

virtual FVector GetViewAlignAxis()

   BaseGizmos/GizmoElementBase.h  

virtual FVector GetViewAlignNormal()

   BaseGizmos/GizmoElementBase.h  

virtual EGizmoElementViewAlignType GetViewAlignType()

   BaseGizmos/GizmoElementBase.h  

virtual float GetViewDependentAngleTol()

   BaseGizmos/GizmoElementBase.h  

virtual FVector GetViewDependentAxis()

   BaseGizmos/GizmoElementBase.h  

virtual EGizmoElementViewDependentType GetViewDependentType()

   BaseGizmos/GizmoElementBase.h  

virtual float GetViewDepthOffset()

   BaseGizmos/GizmoElementBase.h  

virtual bool GetVisibleState()

   BaseGizmos/GizmoElementBase.h  

virtual bool HasHoverVertexColor()

 Returns true, if mesh render state vertex color attribute has been set. BaseGizmos/GizmoElementBase.h  

virtual bool HasInteractVertexColor()

 Returns true, if mesh render state vertex color attribute has been set. BaseGizmos/GizmoElementBase.h  

virtual bool HasSelectVertexColor()

 Returns true, if mesh render state vertex color attribute has been set. BaseGizmos/GizmoElementBase.h  

virtual bool HasSubdueVertexColor()

 Returns true, if mesh render state vertex color attribute has been set. BaseGizmos/GizmoElementBase.h  

virtual bool HasVertexColor()

 Returns true, if mesh render state vertex color attribute has been set. BaseGizmos/GizmoElementBase.h  

virtual FInputRayHit LineTrace ( const UGizmoViewContext* ViewContext,
const FLineTraceTraversalState& LineTraceState,
const FVector& RayOrigin,
const FVector& RayDirection,
FLineTraceOutput& OutLineTraceOutput
)

 Line trace enabled hittable element. BaseGizmos/GizmoElementBase.h  

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

 Line trace enabled hittable element. BaseGizmos/GizmoElementBase.h  

virtual void SetElementInteractionState ( EGizmoElementInteractionState InInteractionState
)

 Object interaction state - None, Hovering, Interacting, Selected or Subdued. BaseGizmos/GizmoElementBase.h  

virtual void SetElementState ( EGizmoElementState InElementState
)

 Object type bitmask indicating whether this object is visible or hittable or both. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabled ( bool bInEnabled
)

 Element enabled flag. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForDefaultState ( bool bInEnabledForDefaultState
)

 Whether element is enabled when element state is default. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForHoveringState ( bool bInEnabledForHoveringState
)

 Whether element is enabled when element state is hovering. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForInteractingState ( bool bInEnabledForInteractingState
)

 Whether element is enabled when element state is interacting. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForPerspectiveProjection ( bool bInEnabledForPerspectiveProjection
)

 Whether element is enabled for perspective projections. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForSelectedState ( bool bInEnabledForSelectedState
)

 Whether element is enabled when element state is selected. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledForSubduedState ( bool bInEnabledForSubduedState
)

 Whether element is enabled when element state is subdued. BaseGizmos/GizmoElementBase.h  

virtual void SetEnabledInOrthographicProjection ( bool bInEnabledForOrthographicProjection
)

 Whether element is enabled for orthographic projections. BaseGizmos/GizmoElementBase.h  

virtual void SetHitPriority ( const int32 InHitPriority
)

 Set/get the hit priority. When hits overlap, higher priority elements will be hit first. If two elements have the same priority, the one that was closest to the hit location will be returned. BaseGizmos/GizmoElementBase.h  

virtual void SetHittableState ( bool bHittable
)

 Set/get the hittable bit in element state. BaseGizmos/GizmoElementBase.h  

virtual void SetHoverMaterial ( TWeakObjectPtr< UMaterialInterface > InHoverMaterial,
bool InOverridesChildState
)

 Set mesh render state hover material attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetHoverVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetInteractMaterial ( TWeakObjectPtr< UMaterialInterface > InInteractMaterial,
bool InOverridesChildState
)

 Set mesh render state interact material attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetInteractVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetMaterial ( TWeakObjectPtr< UMaterialInterface > InMaterial,
bool InOverridesChildState
)

 Methods for managing render state attributes: Material, HoverMaterial, InteractMaterial, SelectMaterial, SubdueMaterial, VertexColor BaseGizmos/GizmoElementBase.h  

virtual void SetMinimumPixelHitDistanceThreshold ( const float InMinimumPixelHitDistanceThreshold
)

 Minimum pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing the "exact" element (useful for pixel-thin elements where an "exact" hit would be otherwise challenging to hit). BaseGizmos/GizmoElementBase.h  

virtual void SetPartIdentifier ( uint32 InPartId,
const bool bInOverrideUnsetChildren,
const bool bInOverrideSet
)

 Sets the part identifier for this element and all of its children whose current ID is 0/Default. BaseGizmos/GizmoElementBase.h  

virtual void SetPartIdentifier ( uint32 InPartId
)

 For an element hierarchy representing multiple parts of a single gizmo, the part identifier establishes a correspondence between a gizmo part and the elements that represent that part. BaseGizmos/GizmoElementBase.h  

virtual void SetPixelHitDistanceThreshold ( float InPixelHitDistanceThreshold
)

 Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing. */. BaseGizmos/GizmoElementBase.h  

virtual void SetSelectMaterial ( TWeakObjectPtr< UMaterialInterface > InSelectMaterial,
bool InOverridesChildState
)

 Set mesh render state Select material attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetSelectVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetSubdueMaterial ( TWeakObjectPtr< UMaterialInterface > InSubdueMaterial,
bool InOverridesChildState
)

 Set mesh render state Subdue material attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetSubdueVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute. BaseGizmos/GizmoElementBase.h  

virtual void SetViewAlignAxialAngleTol ( float InMaxAngleTol
)

 View-align angle tolerance in radians. BaseGizmos/GizmoElementBase.h  

virtual void SetViewAlignAxis ( FVector InAxis
)

 View align axis. BaseGizmos/GizmoElementBase.h  

virtual void SetViewAlignNormal ( FVector InAxis
)

 View align normal. BaseGizmos/GizmoElementBase.h  

virtual void SetViewAlignType ( EGizmoElementViewAlignType InViewAlignType
)

 View align type: None, PointEye, PointOnly, or Axial. BaseGizmos/GizmoElementBase.h  

virtual void SetViewDependentAngleTol ( float InMaxAngleTol
)

 View-dependent angle tolerance in radians For Axis, object is culled when angle between view dependent axis and view direction is less than tolerance angle. BaseGizmos/GizmoElementBase.h  

virtual void SetViewDependentAxis ( FVector InAxis
)

 View-dependent axis or plane normal, based on the view-dependent type. BaseGizmos/GizmoElementBase.h  

virtual void SetViewDependentType ( EGizmoElementViewDependentType ViewDependentType
)

 View-dependent type - None, Axis or Plane. BaseGizmos/GizmoElementBase.h  

virtual void SetViewDepthOffset ( float InViewDepthOffset
)

 Additional view-space offset to apply to the element, affecting both visuals and the hit geometry. BaseGizmos/GizmoElementBase.h  

virtual void SetVisibleState ( bool bVisible
)

 Set/get the visible bit in element state. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartHittableState ( bool bHittable,
uint32 InPartIdentifier
)

 Update element's hittable state if element is associated with the specified gizmo part, return true if part id was found. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartHittableState ( bool bHittable,
uint32 InPartIdentifier,
bool bInAllowMultipleElements
)

 Update element's hittable state if element is associated with the specified gizmo part, return true if part id was found. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartInteractionState ( EGizmoElementInteractionState InInteractionState,
uint32 InPartIdentifier
)

 Update element's interaction state if element is associated with the specified gizmo part, return true if part id was found. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartInteractionState ( EGizmoElementInteractionState InInteractionState,
uint32 InPartIdentifier,
bool bInAllowMultipleElements
)

 Update element's interaction state if element is associated with the specified gizmo part, return true if part id was found. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartVisibleState ( bool bVisible,
uint32 InPartIdentifier
)

 Update element's visibility state if element is associated with the specified gizmo part, return true if part was found. BaseGizmos/GizmoElementBase.h  

virtual bool UpdatePartVisibleState ( bool bVisible,
uint32 InPartIdentifier,
bool bInAllowMultipleElements
)

 Update element's visibility state if element is associated with the specified gizmo part, return true if part was found. BaseGizmos/GizmoElementBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ApplyViewDepthOffset ( const FSceneView* InView,
const double& InViewDepthOffset,
FTransform& InOutTransform
) const

   BaseGizmos/GizmoElementBase.h  

virtual void ApplyViewDepthOffset ( const FVector& InViewLocation,
const FVector& InViewDirection,
const bool bInIsPerspectiveView,
const double& InViewDepthOffset,
FTransform& InOutTransform
) const

   BaseGizmos/GizmoElementBase.h  

virtual void ApplyViewDepthOffset ( const FVector& InViewLocation,
const FVector& InViewDirection,
const bool bInIsPerspectiveView,
FTransform& InOutTransform
) const

   BaseGizmos/GizmoElementBase.h  

void ForEachSubElement ( const TFunctionRef< void(UGizmoElementBase*)>& InFunc
)

 Iterate over each top-level element (sub-element), excluding the element itself. BaseGizmos/GizmoElementBase.h  

void ForEachSubElementRecursive ( const TFunctionRef< void(UGizmoElementBase*)>& InFunc
) const

 Iterate over each element (sub-element) in the element tree, excluding the element itself. BaseGizmos/GizmoElementBase.h  

void ForEachSubElementRecursive ( const TFunctionRef< void(UGizmoElementBase*)>& InFunc,
const uint32 InPartId
) const

 Iterate over each sub-element with the given Part Id in the element tree, excluding the element itself. BaseGizmos/GizmoElementBase.h  

FQuat GetAlignRotBetweenCoordSpaces ( FVector SourceForward,
FVector SourceRight,
FVector SourceUp,
FVector TargetForward,
FVector TargetRight,
FVector TargetUp
) const

 Helper method for view alignment. BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForInteractionState ( EGizmoElementInteractionState InInteractionState
) const

 Returns whether element is enabled for given interaction state. BaseGizmos/GizmoElementBase.h  

virtual bool GetEnabledForViewProjection ( bool bIsPerspectiveProjection
) const

 Returns whether element is enabled for given view projection type. BaseGizmos/GizmoElementBase.h  

UMaterialInterface * GetHoverMaterial ()

 Get mesh render state hover material attribute's value. BaseGizmos/GizmoElementBase.h  

UMaterialInterface * GetInteractMaterial ()

 Get mesh render state interact material attribute's value. BaseGizmos/GizmoElementBase.h  

UMaterialInterface * GetMaterial ()

 Get mesh render state material attribute's value. BaseGizmos/GizmoElementBase.h  

UMaterialInterface * GetSelectMaterial ()

 Get mesh render state Select material attribute's value. BaseGizmos/GizmoElementBase.h  

UMaterialInterface * GetSubdueMaterial ()

 Get mesh render state Subdue material attribute's value. BaseGizmos/GizmoElementBase.h  

bool GetSubElementsRecursive ( TArray< TObjectPtr< UGizmoElementBase > >& OutElements,
const uint32 InPartId
) const

 Get all sub-elements with the given Part Id for the element tree, if any. Returns true if any sub-elements were found. BaseGizmos/GizmoElementBase.h  

bool GetSubElementsRecursive ( TArray< TObjectPtr< UGizmoElementBase > >& OutElements
) const

 Get all sub-elements for the element tree, if any. Returns true if any sub-elements were found. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewAlignRot ( const FSceneView* View,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter,
FQuat& OutAlignRot
) const

 Return whether this element has a view alignment rotation based on input FSceneView and view-dependent alignment settings. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewAlignRot ( const FVector& InViewLocation,
const FVector& InViewDirection,
const FVector& InViewUp,
bool bInPerspectiveView,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter,
FQuat& OutAlignRot
) const

 Return whether this element has a view alignment rotation based on input view parameters and view-dependent alignment settings. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewAlignRot ( const UGizmoViewContext* View,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter,
FQuat& OutAlignRot
) const

 Return whether this element has a view alignment rotation based on input gizmo view context and view-dependent alignment settings. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewDependentVisibility ( const UGizmoViewContext* View,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter
) const

 Returns whether object is visible in input gizmo view context based on view-dependent visibility settings. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewDependentVisibility ( const FVector& InViewLocation,
const FVector& InViewDirection,
bool bInPerspectiveView,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter
) const

 Returns whether object is visible based on view-dependent visibility settings. BaseGizmos/GizmoElementBase.h  

virtual bool GetViewDependentVisibility ( const FSceneView* View,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter
) const

 Returns whether object is visible in input FSceneView based on view-dependent visibility settings. BaseGizmos/GizmoElementBase.h  

virtual bool IsHittable ( const UGizmoViewContext* ViewContext,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter
) const

 Return whether element is currently hittable. BaseGizmos/GizmoElementBase.h  

virtual bool IsVisible ( const FSceneView* View,
EGizmoElementInteractionState InCurrentInteractionState,
const FTransform& InLocalToWorldTransform,
const FVector& InLocalCenter
) const

 Return whether element is currently visible. BaseGizmos/GizmoElementBase.h  

virtual FInputRayHit MakeRayHit ( const double InHitDepth,
FLineTraceOutput& OutLineTraceOutput
)

 Initialize ray hit for this element, injecting the Part Identifier, Hit Priority, etc. BaseGizmos/GizmoElementBase.h  

virtual bool UpdateLineTraceState ( const UGizmoViewContext* ViewContext,
const FVector& InLocalCenter,
FLineTraceTraversalState& InOutLineTraceState
)

 Update line trace state during line trace traversal, determines the current state for this element BaseGizmos/GizmoElementBase.h  

virtual bool UpdateLineTraceState ( const UGizmoViewContext* ViewContext,
const FVector& InLocalCenter,
FLineTraceTraversalState& InOutRenderState,
bool& bOutHasAlignRot,
FQuat& OutAlignRot
)

 Update line trace state during line trace traversal, determines the current state for this element Same parameters as UpdateLineTraceState above plus two output parameters: BaseGizmos/GizmoElementBase.h  

virtual bool UpdateRenderState ( IToolsContextRenderAPI* RenderAPI,
const FVector& InLocalCenter,
FRenderTraversalState& InOutRenderState
)

 Update render state during render traversal, determines the current render state for this element BaseGizmos/GizmoElementBase.h  

virtual bool UpdateRenderState ( IToolsContextRenderAPI* RenderAPI,
const FVector& InLocalCenter,
FRenderTraversalState& InOutRenderState,
bool& bOutHasAlignRot,
FQuat& OutAlignRot
)

 Update render state during render traversal, determines the current render state for this element Same parameters as UpdateRenderState above plus two output parameters: BaseGizmos/GizmoElementBase.h  

bool VerifyUniformScale ( const FVector& Scale
) const

 Helper method to verify scale is uniform. BaseGizmos/GizmoElementBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page