1. Epic GamesDeveloper
  3. UGizmoElementTorus

UGizmoElementTorus

Simple object intended to be used as part of 3D Gizmos.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

Simple object intended to be used as part of 3D Gizmos. Draws a torus based on parameters.

Note: the LineTrace method does not perform a true ray-torus intersection! See comment above LineTrace method below for details of how this intersection is approximated.

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

Syntax

UCLASS (Transient, MinimalAPI)  
class UGizmoElementTorus : public UGizmoElementCircleBase

Inheritance Hierarchy

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool GetEndCaps()

   BaseGizmos/GizmoElementTorus.h  

virtual double GetHoverInnerRadiusMultiplier()

   BaseGizmos/GizmoElementTorus.h  

virtual double GetInnerRadius()

   BaseGizmos/GizmoElementTorus.h  

virtual double GetInteractInnerRadiusMultiplier()

   BaseGizmos/GizmoElementTorus.h  

virtual int32 GetNumInnerSlices()

   BaseGizmos/GizmoElementTorus.h  

virtual double GetSelectInnerRadiusMultiplier()

   BaseGizmos/GizmoElementTorus.h  

virtual double GetSubdueInnerRadiusMultiplier()

   BaseGizmos/GizmoElementTorus.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI,
const FRenderTraversalState& RenderState
)

   BaseGizmos/GizmoElementTorus.h  

virtual void SetEndCaps ( bool InEndCaps
)

 If partial, renders end caps when true. BaseGizmos/GizmoElementTorus.h  

virtual void SetHoverInnerRadiusMultiplier ( double InHoverInnerRadiusMultiplier
)

 Multiplier applied to the inner radius when hovering. BaseGizmos/GizmoElementTorus.h  

virtual void SetInnerRadius ( double InInnerRadius
)

 Inner circles radius. BaseGizmos/GizmoElementTorus.h  

virtual void SetInteractInnerRadiusMultiplier ( double InInteractInnerRadiusMultiplier
)

 Multiplier applied to the inner radius when interacting. BaseGizmos/GizmoElementTorus.h  

virtual void SetNumInnerSlices ( int32 InNumInnerSlices
)

 Number of inner slices for rendering torus. BaseGizmos/GizmoElementTorus.h  

virtual void SetSelectInnerRadiusMultiplier ( double InSelectInnerRadiusMultiplier
)

 Multiplier applied to the inner radius when selected. BaseGizmos/GizmoElementTorus.h  

virtual void SetSubdueInnerRadiusMultiplier ( double InSubdueInnerRadiusMultiplier
)

 Multiplier applied to the inner radius when subdued. BaseGizmos/GizmoElementTorus.h  

Overridden from UGizmoElementBase

Name Remarks Include Path Unreal Specifiers

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

 LineTrace approximates ray-torus intersection by intersecting the ray with the plane in which the torus lies, then determining a hit point closest to the linear circle defined by torus center and torus outer radius. BaseGizmos/GizmoElementTorus.h  

Protected

Name Remarks Include Path Unreal Specifiers

double GetCurrentInnerRadius()

 Returns the current inner radius based on the current interaction state. BaseGizmos/GizmoElementTorus.h  

bool IsGlancingAngle ( const UGizmoViewContext* View,
const FVector& InWorldCenter,
const FVector& InWorldNormal
)

   BaseGizmos/GizmoElementTorus.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page