Navigation
API > API/Plugins > API/Plugins/LightGizmos
UScalableConeGizmo provides a cone that can be scaled (changing its angle) by dragging the base of the cone outwards/inwards
| Name | UScalableConeGizmo |
| Type | class |
| Header File | /Engine/Plugins/Experimental/GizmoEdMode/Source/LightGizmos/Public/ScalableConeGizmo.h |
| Include Path | #include "ScalableConeGizmo.h" |
Syntax
UCLASS ()
class UScalableConeGizmo :
public UInteractiveGizmo,
public IHoverBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveGizmo → UScalableConeGizmo
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConeColor | FColor | The color of the cone. | ScalableConeGizmo.h | |
| HitErrorThreshold | float | The error threshold for hit detection with the cone. | ScalableConeGizmo.h | |
| MaxAngle | float | The maximum angle the cone can be stretched to. | ScalableConeGizmo.h | |
| MinAngle | float | The minimum angle the cone can be stretched to. | ScalableConeGizmo.h | |
| TransactionDescription | FText | The text that will be used as the transaction description for undo/redo. | ScalableConeGizmo.h | |
| UpdateAngleFunc | TFunction< void(const float)> | Called when the Angle of the cone is changed. Sends new angle as parameter. | ScalableConeGizmo.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveTarget | TObjectPtr< UTransformProxy > | ScalableConeGizmo.h | ||
| Angle | float | ScalableConeGizmo.h | ||
| bIsDragging | bool | Whether the gizmo is being dragged | ScalableConeGizmo.h | |
| bIsHovering | bool | Whether the gizmo is being hovered over | ScalableConeGizmo.h | |
| DragCurrentPositionProjected | FVector | The position the drag is on currently (projected onto the line it is being dragged along) | ScalableConeGizmo.h | |
| DragStartWorldPosition | FVector | Used for calculations when moving the handles | ScalableConeGizmo.h | |
| HitAxis | FVector | ScalableConeGizmo.h | ||
| InteractionStartParameter | float | ScalableConeGizmo.h | ||
| InteractionStartPoint | FVector | ScalableConeGizmo.h | ||
| Length | float | The ConeLength. | ScalableConeGizmo.h | |
| RotationPlaneX | FVector | ScalableConeGizmo.h | ||
| RotationPlaneY | FVector | ScalableConeGizmo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
ScalableConeGizmo.h | ||
float GetAngleDegrees() |
ScalableConeGizmo.h | ||
float GetLength() |
ScalableConeGizmo.h | ||
bool HitTest
(
const FRay& Ray, |
Check if the input ray hits the cone. | ScalableConeGizmo.h | |
virtual void OnBeginDrag
(
const FInputDeviceRay& Ray |
ScalableConeGizmo.h | ||
virtual void OnBeginHover
(
const FInputDeviceRay& DevicePos |
ScalableConeGizmo.h | ||
virtual void OnEndDrag
(
const FInputDeviceRay& Ray |
ScalableConeGizmo.h | ||
virtual void OnEndHover() |
ScalableConeGizmo.h | ||
virtual void OnUpdateDrag
(
const FInputDeviceRay& Ray |
ScalableConeGizmo.h | ||
virtual bool OnUpdateHover
(
const FInputDeviceRay& DevicePos |
ScalableConeGizmo.h | ||
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
ScalableConeGizmo.h | ||
void SetAngleDegrees
(
float InAngle |
Gettors and Settors for the Angle and Length. | ScalableConeGizmo.h | |
void SetLength
(
float InLength |
ScalableConeGizmo.h | ||
virtual void SetTarget
(
UTransformProxy* InTarget |
Set the target to attach the gizmo to. | ScalableConeGizmo.h | |
virtual void Setup() |
ScalableConeGizmo.h |