1. Epic GamesDeveloper
  3. UGizmoElementCircleBase

UGizmoElementCircleBase

Abstract base object for circle, torus and arc.

API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos

Inheritance Hierarchy

References

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

Syntax

class UGizmoElementCircleBase : public UGizmoElementLineBase

Remarks

Abstract base object for circle, torus and arc.

Variables

  Type Name Description
Protected variable FVector Axis0 Axis0 of plane in which circle lies, must perpendicular to normal.
Protected variable FVector Axis1 Axis1 of plane in which circle lies, must perpendicular to Axis0.
Protected variable FVector Center CircleBase center.
Protected variable int32 NumSegments Number of segments for rendering arc.
Protected variable double PartialEndAngle End angle to render for partial torus.
Protected variable double PartialStartAngle Start angle to render for partial torus.
Protected variable EGizmoElementPartialType PartialType True when the arc is not full.
Protected variable double PartialViewDependentMaxCosTol For PartialViewDependent, max cosine of angle between the normal and view direction Within this tolerance, the arc will be rendered as full rather than partial
Protected variable double Radius Radius of main circle, some derived elements have inner radius (e.g. torus and arc)

Functions

  Type Name Description
Public function Virtual Const FVector  
Public function Virtual Const FVector  
Public function Virtual Const FVector  
Public function Virtual Const int32  
Public function Virtual Const double  
Public function Virtual Const double  
Public function Virtual Const EGizmoElementPartialType  
Public function Virtual Const double  
Public function Virtual Const double  
Protected function bool

IsPartial ( const FSceneView* View,
const FVector& InWorldCenter,
const FVector& InWorldNormal
)

 Returns whether element should be partial based on current view.
Protected function bool

IsPartial ( const FVector& InWorldCenter,
const FVector& InWorldNormal,
const FVector& InViewLocation,
const FVector& InViewDirection,
bool bIsPerspectiveProjection
)

 Returns whether element should be partial based on current view.
Protected function bool

IsPartial ( const UGizmoViewContext* ViewContext,
const FVector& InWorldCenter,
const FVector& InWorldNormal
)

 Returns whether element should be partial based on current view.
Public function Virtual void

SetAxis0 ( const FVector& InAxis0
)

 Axis0 of plane in which circle lies, must perpendicular to normal.
Public function Virtual void

SetAxis1 ( const FVector& InAxis0
)

 Axis1 of plane in which circle lies, must perpendicular to Axis0.
Public function Virtual void

SetCenter ( const FVector& InCenter
)

 CircleBase center.
Public function Virtual void

SetNumSegments ( int32 InNumSegments
)

 Number of segments for rendering circle.
Public function Virtual void

SetPartialEndAngle ( double InPartialAngle
)

 Start of arc angle of partial torus in radians, relative to Axis1.
Public function Virtual void

SetPartialStartAngle ( double InPartialAngle
)

 Start of arc angle of partial torus in radians, relative to Axis0.
Public function Virtual void

SetPartialType ( EGizmoElementPartialType InPartial
)

 When Partial, renders partial arc based on angle.
Public function 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
Public function Virtual void

SetRadius ( double InRadius
)

 Circle radius.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page