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 > API/Runtime/InteractiveToolsFramework/BaseGizmos

Inheritance Hierarchy

References

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

Syntax

class UGizmoElementBase : public UObject

Remarks

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

Variables

  Type Name Description
Protected variable bool bEnabled Whether element is enabled. Render and LineTrace only occur when bEnabled is true.
Protected variable bool bEnabledForDefaultState Whether element is enabled when element state is default.
Protected variable bool bEnabledForHoveringState Whether element is enabled when element state is hovering.
Protected variable bool bEnabledForInteractingState Whether element is enabled when element state is interacting.
Protected variable bool bEnabledForOrthographicProjection Whether element is enabled for orthographic projection.
Protected variable bool bEnabledForPerspectiveProjection Whether element is enabled for perspective projection.
Protected variable EGizmoElementInteractionState ElementInteractionState Current element interaction state - None, Hovering or Interacting.
Protected variable EGizmoElementState ElementState Element state - indicates whether object is visible or hittable.
Public variable void virtual Render(IToolsContextRenderAPI *RenderAPI, const FRenderTraversalState &RenderState)... LineTrace Render enabled visible element.
Protected variable FGizmoElementMeshRenderStateAttributes MeshRenderAttributes Mesh render state attributes for this element.
Protected variable uint32 PartIdentifier Part identifier.
Protected variable float PixelHitDistanceThreshold Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing.
Protected variable float ViewAlignAxialAngleTol Axial view alignment angle tolerance in radians, based on angle between align normal and view direction.
Protected variable float ViewAlignAxialMaxCosAngleTol Axial view alignment minimum cos angle tolerance, computed based on ViewAlignAxialAngleTol.
Protected variable FVector ViewAlignAxis View align axis.
Protected variable FVector ViewAlignNormal View align normal.
Protected variable EGizmoElementViewAlignType ViewAlignType View align type: None, PointEye, or PointWorld.
Protected variable float ViewDependentAngleTol View-dependent angle tolerance based on : For Axis, minimum radians between view dependent axis and view direction.
Protected variable float ViewDependentAxialMaxCosAngleTol Axial view alignment minimum cos angle tolerance, computed based on ViewDependentAngleTol.
Protected variable FVector ViewDependentAxis View-dependent axis or plane normal, based on the view-dependent type.
Protected variable float ViewDependentPlanarMinCosAngleTol Planar view alignment minimum cos angle tolerance, computed based on ViewDependentAngleTol.
Protected variable EGizmoElementViewDependentType ViewDependentType View-dependent type - None, Axis or Plane.

Functions

  Type Name Description
Public function Virtual void Clear mesh render state hover material attribute.
Public function Virtual void Clear mesh render state vertex color attribute.
Public function Virtual void Clear mesh render interact state material attribute.
Public function Virtual void Clear mesh render state vertex color attribute.
Public function Virtual void Clear mesh render state material attribute.
Public function Virtual void Clear mesh render state vertex color attribute.
Public function Virtual Const bool Get mesh render state hover material attribute's override setting.
Public function Virtual Const bool Get mesh render state vertex color attribute's override setting.
Public function Virtual Const bool Get mesh render state interact material attribute's override setting.
Public function Virtual Const bool Get mesh render state vertex color attribute's override setting.
Public function Virtual Const bool Get mesh render state material attribute's override setting.
Public function Virtual Const bool Get mesh render state vertex color attribute's override setting.
Protected function Const FQuat

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

 Helper method for view alignment.
Public function Virtual Const EGizmoElementInteractionState  
Public function Virtual Const EGizmoElementState  
Public function Virtual Const bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Protected function Virtual Const bool

GetEnabledForInteractionState ( EGizmoElementInteractionState InInteractionState
)

 Returns whether element is enabled for given interaction state.
Public function Virtual bool  
Protected function Virtual Const bool

GetEnabledForViewProjection ( bool bIsPerspectiveProjection
)

 Returns whether element is enabled for given view projection type.
Public function Virtual bool  
Public function Virtual Const bool  
Public function Virtual Const const UMaterialInterface * Get mesh render state hover material attribute's value.
Public function Virtual Const FLinearColor Get mesh render state vertex color attribute's value.
Public function Virtual Const const UMaterialInterface * Get mesh render state interact material attribute's value.
Public function Virtual Const FLinearColor Get mesh render state vertex color attribute's value.
Public function Virtual Const const UMaterialInterface * Get mesh render state material attribute's value.
Public function Virtual Const TOptional< bool >

GetPartHittableState ( uint32 InPartIdentifier
)

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

GetPartInteractionState ( uint32 InPartIdentifier
)

 Get element's interaction state for element associated with the specified gizmo part, if part id 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 id was found.
Public function Virtual Const float  
Public function Virtual Const FLinearColor Get mesh render state vertex color attribute's value.
Public function Virtual Const float  
Public function Virtual Const FVector  
Public function Virtual Const FVector  
Protected function Virtual Const bool

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

 Return whether this element has a view alignment rotation based on input view parameters and view-dependent alignment settings.
Protected function Virtual Const bool

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

 Return whether this element has a view alignment rotation based on input gizmo view context and view-dependent alignment settings.
Protected function Virtual Const bool

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

 Return whether this element has a view alignment rotation based on input FSceneView and view-dependent alignment settings.
Public function Virtual Const EGizmoElementViewAlignType  
Public function Virtual Const float  
Public function Virtual Const FVector  
Public function Virtual Const EGizmoElementViewDependentType  
Protected function Virtual Const bool

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

 Returns whether object is visible based on view-dependent visibility settings.
Protected function Virtual Const bool

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

 Returns whether object is visible in input gizmo view context based on view-dependent visibility settings.
Protected function Virtual Const bool

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

 Returns whether object is visible in input FSceneView based on view-dependent visibility settings.
Public function Virtual Const bool  
Public function Virtual Const bool Returns true, if mesh render state vertex color attribute has been set.
Public function Virtual Const bool Returns true, if mesh render state vertex color attribute has been set.
Public function Virtual Const bool Returns true, if mesh render state vertex color attribute has been set.
Protected function Virtual Const bool

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

 Return whether element is currently hittable.
Protected function Virtual Const bool

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

 Return whether element is currently visible.
Public function Virtual void

SetElementInteractionState ( EGizmoElementInteractionState InInteractionState
)

 Object interaction state - None, Hovering or Interacting.
Public function Virtual void

SetElementState ( EGizmoElementState InElementState
)

 Object type bitmask indicating whether this object is visible or hittable or both.
Public function Virtual void

SetEnabled ( bool bInEnabled
)

 Element enabled flag.
Public function Virtual void

SetEnabledForDefaultState ( bool bInEnabledForDefaultState
)

 Whether element is enabled when element state is default.
Public function Virtual void

SetEnabledForHoveringState ( bool bInEnabledForHoveringState
)

 Whether element is enabled when element state is hovering.
Public function Virtual void

SetEnabledForInteractingState ( bool bInEnabledForInteractingState
)

 Whether element is enabled when element state is interacting.
Public function Virtual void

SetEnabledForPerspectiveProjection ( bool bInEnabledForPerspectiveProjection
)

 Whether element is enabled for perspective projections.
Public function Virtual void

SetEnabledInOrthographicProjection ( bool bInEnabledForOrthographicProjection
)

 Whether element is enabled for orthographic projections.
Public function Virtual void

SetHittableState ( bool bHittable
)

 Set/get the hittable bit in element state.
Public function Virtual void

SetHoverMaterial ( TWeakObjectPtr< UMaterialInterface > InHoverMaterial,
bool InOverridesChildState
)

 Set mesh render state hover material attribute.
Public function Virtual void

SetHoverVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute.
Public function Virtual void

SetInteractMaterial ( TWeakObjectPtr< UMaterialInterface > InInteractMaterial,
bool InOverridesChildState
)

 Set mesh render state interact material attribute.
Public function Virtual void

SetInteractVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute.
Public function Virtual void

SetMaterial ( TWeakObjectPtr< UMaterialInterface > InMaterial,
bool InOverridesChildState
)

 Methods for managing render state attributes: Material, HoverMaterial, InteractMaterial, VertexColor
Public function 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.
Public function Virtual void

SetPixelHitDistanceThreshold ( float InPixelHitDistanceThreshold
)

 Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing. */.
Public function Virtual void

SetVertexColor ( FLinearColor InVertexColor,
bool InOverridesChildState
)

 Set mesh render state vertex color attribute.
Public function Virtual void

SetViewAlignAxialAngleTol ( float InMaxAngleTol
)

 View-align angle tolerance in radians.
Public function Virtual void

SetViewAlignAxis ( FVector InAxis
)

 View align axis.
Public function Virtual void

SetViewAlignNormal ( FVector InAxis
)

 View align normal.
Public function Virtual void

SetViewAlignType ( EGizmoElementViewAlignType InViewAlignType
)

 View align type: None, PointEye, PointOnly, or Axial.
Public function 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.
Public function Virtual void

SetViewDependentAxis ( FVector InAxis
)

 View-dependent axis or plane normal, based on the view-dependent type.
Public function Virtual void

SetViewDependentType ( EGizmoElementViewDependentType ViewDependentType
)

 View-dependent type - None, Axis or Plane.
Public function Virtual void

SetVisibleState ( bool bVisible
)

 Set/get the visible bit in element state.
Protected function 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
Protected function 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:
Public function 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.
Public function 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.
Public function 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.
Protected function Virtual bool

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

 Update render state during render traversal, determines the current render state for this element
Protected function 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:
Protected function Const bool

VerifyUniformScale ( const FVector& Scale
)

 Helper method to verify scale is uniform.

Classes

  Type Name Description
Public struct FLineTraceTraversalState    
Public struct FRenderTraversalState Render traversal state structure used to maintain the current render state while rendering.  

Constants

Name Description
DefaultPartIdentifier  
DefaultViewAlignAngleTol  
DefaultViewAlignMaxCosAngleTol  
DefaultViewDependentAngleTol  
DefaultViewDependentAxialMaxCosAngleTol  
DefaultViewDependentPlanarMinCosAngleTol  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page