Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Simple object intended to be used as part of 3D Gizmos. Draws a 3D arrow based on parameters.
| Name | UGizmoElementArrow |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementArrow.h |
| Include Path | #include "BaseGizmos/GizmoElementArrow.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UGizmoElementArrow : public UGizmoElementGroupBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoElementBase → UGizmoElementLineBase → UGizmoElementGroupBase → UGizmoElementArrow
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UGizmoElementArrow() |
BaseGizmos/GizmoElementArrow.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector GetBase() |
BaseGizmos/GizmoElementArrow.h | ||
virtual float GetBodyLength() |
BaseGizmos/GizmoElementArrow.h | ||
virtual float GetBodyRadius() |
BaseGizmos/GizmoElementArrow.h | ||
virtual void GetDashParameters
(
float& OutDashLength, |
BaseGizmos/GizmoElementArrow.h | ||
virtual FVector GetDirection() |
BaseGizmos/GizmoElementArrow.h | ||
virtual bool GetEndCaps() |
BaseGizmos/GizmoElementArrow.h | ||
virtual float GetHeadLength() |
BaseGizmos/GizmoElementArrow.h | ||
virtual float GetHeadRadius() |
BaseGizmos/GizmoElementArrow.h | ||
virtual EGizmoElementArrowHeadType GetHeadType() |
BaseGizmos/GizmoElementArrow.h | ||
virtual int32 GetNumSides() |
BaseGizmos/GizmoElementArrow.h | ||
virtual FVector GetSideDirection() |
BaseGizmos/GizmoElementArrow.h | ||
virtual bool IsDashed() |
BaseGizmos/GizmoElementArrow.h | ||
virtual void SetBase
(
const FVector& InBase |
Location of the base of arrow cylinder. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetBodyLength
(
float InBodyLength |
Arrow body length. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetBodyRadius
(
float InBodyRadius |
Arrow body cylinder radius. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetDashParameters
(
const float InDashLength, |
The dash parameters for the body element, if enabled. If GapLength is not specified, it defaults to half DashLength. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetDirection
(
const FVector& InDirection |
Arrow direction. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetEndCaps
(
bool InEndCaps |
Whether to render and end cap on the base of the arrow head. Applicable when the ArrowHeadType is Cone. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetHeadLength
(
float InHeadLength |
Arrow head length, used for both cone and cube head. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetHeadRadius
(
float InHeadRadius |
Arrow head radius, if cone. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetHeadType
(
EGizmoElementArrowHeadType InHeadType |
Head type cone or cube. | BaseGizmos/GizmoElementArrow.h | |
void SetHitMask
(
const TWeakObjectPtr< UGizmoElementBase >& InHitMask |
Hit Mask Gizmo element used for adaptive pixel hit threshold. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetIsDashed
(
bool bInDashing |
Whether to render the body element with dashing. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetNumSides
(
int32 InNumSides |
Number of sides for cylinder and cone, if relevant. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetSideDirection
(
const FVector& InSideDirection |
Arrow side direction for box head. | BaseGizmos/GizmoElementArrow.h |
Overridden from UGizmoElementGroupBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Render
(
IToolsContextRenderAPI* RenderAPI, |
BaseGizmos/GizmoElementArrow.h |
Overridden from UGizmoElementBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit LineTrace
(
const UGizmoViewContext* ViewContext, |
Line trace enabled hittable element. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetMinimumPixelHitDistanceThreshold
(
float InMinimumPixelHitDistanceThreshold |
Minimum Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing. | BaseGizmos/GizmoElementArrow.h | |
virtual void SetPixelHitDistanceThreshold
(
float InPixelHitDistanceThreshold |
Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing. | BaseGizmos/GizmoElementArrow.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateArrowBody() |
Update arrow cylinder based on parameters. | BaseGizmos/GizmoElementArrow.h | |
virtual void UpdateArrowHead() |
Update arrow cone or box based on parameters. | BaseGizmos/GizmoElementArrow.h |