Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Abstract base object for circle, torus and arc.
| Name | UGizmoElementCircleBase |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementCircleBase.h |
| Include Path | #include "BaseGizmos/GizmoElementCircleBase.h" |
Syntax
UCLASS (Transient, Abstract, MinimalAPI)
class UGizmoElementCircleBase : public UGizmoElementLineBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoElementBase → UGizmoElementLineBase → UGizmoElementCircleBase
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector GetAxis0() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual FVector GetAxis1() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual FVector GetCenter() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetHoverRadiusMultiplier() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetInteractRadiusMultiplier() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual int32 GetNumSegments() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetPartialEndAngle() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetPartialStartAngle() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual EGizmoElementPartialType GetPartialType() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetPartialViewDependentMaxCosTol() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetRadius() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetSelectRadiusMultiplier() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual double GetSubdueRadiusMultiplier() |
BaseGizmos/GizmoElementCircleBase.h | ||
virtual void SetAxis0
(
const FVector& InAxis0 |
Axis0 of plane in which circle lies, must perpendicular to normal. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetAxis1
(
const FVector& InAxis0 |
Axis1 of plane in which circle lies, must perpendicular to Axis0. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetCenter
(
const FVector& InCenter |
CircleBase center. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetHoverRadiusMultiplier
(
double InHoverRadiusMultiplier |
Multiplier applied to the circle radius when hovering. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetInteractRadiusMultiplier
(
double InInteractRadiusMultiplier |
Multiplier applied to the circle radius when interacting. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetNumSegments
(
int32 InNumSegments |
Number of segments for rendering circle. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetPartialEndAngle
(
double InPartialAngle |
Start of arc angle of partial torus in radians, relative to Axis1. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetPartialStartAngle
(
double InPartialAngle |
Start of arc angle of partial torus in radians, relative to Axis0. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetPartialType
(
EGizmoElementPartialType InPartial |
When Partial, renders partial arc based on angle. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetPartialViewDependentMaxCosTol
(
double InPartialViewDependentMaxCosTol |
If partial type is PartialViewDependent, when the cosine of angle between the normal and view direction is within this tolerance, the arc will be rendered as full rather than partial | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetRadius
(
double InRadius |
Circle radius. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetSelectRadiusMultiplier
(
double InSelectRadiusMultiplier |
Multiplier applied to the circle radius when selected. | BaseGizmos/GizmoElementCircleBase.h | |
virtual void SetSubdueRadiusMultiplier
(
double InSubdueRadiusMultiplier |
Multiplier applied to the circle radius when subdued. | BaseGizmos/GizmoElementCircleBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
double GetCurrentRadius() |
Returns the current radius based on the current interaction state. | BaseGizmos/GizmoElementCircleBase.h | |
bool IsPartial
(
const FSceneView* View, |
Returns whether element should be partial based on current view. | BaseGizmos/GizmoElementCircleBase.h | |
bool IsPartial
(
const FVector& InWorldCenter, |
Returns whether element should be partial based on current view. | BaseGizmos/GizmoElementCircleBase.h | |
bool IsPartial
(
const UGizmoViewContext* ViewContext, |
Returns whether element should be partial based on current view. | BaseGizmos/GizmoElementCircleBase.h |