Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoElementBase
- UGizmoElementLineBase
- UGizmoElementCircleBase
- UGizmoElementTorus
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementTorus.h |
| Include | #include "BaseGizmos/GizmoElementTorus.h" |
Syntax
class UGizmoElementTorus : public UGizmoElementCircleBase
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bEndCaps | Whether to render end caps on a partial torus. |
 |
double | InnerRadius | Torus inner radius. |
 |
int32 | NumInnerSlices | Number of slices to render in each torus segment. |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
bool | GetEndCaps () |
|
   |
double | ||
   |
int32 | ||
 |
bool | IsGlancingAngle
(
const UGizmoViewContext* View, |
|
  |
FInputRayHit | LineTrace
(
const UGizmoViewContext* ViewContext, |
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. |
  |
void | Render
(
IToolsContextRenderAPI* RenderAPI, |
|
  |
void | SetEndCaps
(
bool InEndCaps |
If partial, renders end caps when true. |
  |
void | SetInnerRadius
(
double InInnerRadius |
Inner circles radius. |
  |
void | SetNumInnerSlices
(
int32 InNumInnerSlices |
Number of inner slices for rendering torus. |