Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoElementBase
- UGizmoElementArrow
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoElementArrow.h |
| Include | #include "BaseGizmos/GizmoElementArrow.h" |
Syntax
class UGizmoElementArrow : public UGizmoElementBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| FVector | Base | Location of center of arrow base circle. | |
| float | BodyLength | Arrow body length. | |
| float | BodyRadius | Radius of arrow cylinder. | |
| TObjectPtr< UGizmoElementBox > | BoxElement | Arrow box head. | |
| bool | bUpdateArrowBody | Flag indicating body properties need to be updated prior to render. | |
| bool | bUpdateArrowHead | Flag indicating head properties need to be updated prior to render. | |
| TObjectPtr< UGizmoElementCone > | ConeElement | Arrow cone head. | |
| TObjectPtr< UGizmoElementCylinder > | CylinderElement | Arrow cylinder body. | |
| FVector | Direction | Direction of arrow axis. | |
| float | HeadLength | Length of head, cone or box. | |
| float | HeadRadius | Radius of head cone. | |
| EGizmoElementArrowHeadType | HeadType | Head type. | |
| int32 | NumSides | Number of sides for tessellating cone and cylinder. | |
| FVector | SideDirection | Side direction for box head. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FVector | GetBase () |
||
| float | |||
| float | |||
| FVector | GetDirection () |
||
| float | |||
| float | |||
| EGizmoElementArrowHeadType | GetHeadType () |
||
| int32 | GetNumSides () |
||
| FVector | |||
| FInputRayHit | LineTrace
(
const UGizmoViewContext* ViewContext, |
||
| void | Render
(
IToolsContextRenderAPI* RenderAPI, |
||
| void | SetBase
(
const FVector& InBase |
Location of base of arrow cylinder. | |
| void | SetBodyLength
(
float InBodyLength |
Arrow body length. | |
| void | SetBodyRadius
(
float InBodyRadius |
Arrow body cylinder radius. | |
| void | SetDirection
(
const FVector& InDirection |
Arrow direction. | |
| void | SetHeadLength
(
float InHeadLength |
Arrow head length, used for both cone and cube head. | |
| void | SetHeadRadius
(
float InHeadRadius |
Arrow head radius, if cone. | |
| void | SetHeadType
(
EGizmoElementArrowHeadType InHeadType |
Head type cone or cube. | |
| void | SetNumSides
(
int32 InNumSides |
Number of sides for cylinder and cone, if relevant. | |
| void | SetSideDirection
(
const FVector& InSideDirection |
Arrow side direction for box head. | |
| void | Update arrow cylinder based on parameters. | ||
| void | Update arrow cone or box based on parameters. |
Overridden from UGizmoElementBase
| Type | Name | Description | |
|---|---|---|---|
| void | SetPixelHitDistanceThreshold
(
float InPixelHitDistanceThreshold |
Pixel hit distance threshold, element will be scaled enough to add this threshold when line-tracing. |