Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
| Name | UIntervalGizmo |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/IntervalGizmo.h |
| Include Path | #include "BaseGizmos/IntervalGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class UIntervalGizmo : public UInteractiveGizmo
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveGizmo → UIntervalGizmo
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FParameterSources | Input parameter sources and related configuration. |
Enums
Public
| Name | Remarks |
|---|---|
| EDefaultParameterRanges |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnBeginIntervalEdit | TMulticastDelegate_OneParam< void, UIntervalGizmo * > | Called when the gizmo is notified about the start of a sequence of interval changes. | BaseGizmos/IntervalGizmo.h |
| FOnEndIntervalEdit | TMulticastDelegate_OneParam< void, UIntervalGizmo * > | Called when the gizmo is notified about the end of a sequence of interval changes. | BaseGizmos/IntervalGizmo.h |
| FOnIntervalChanged | TMulticastDelegate_ThreeParams< void, UIntervalGizmo *, const FVector &, float > | Called when an interval is changed. | BaseGizmos/IntervalGizmo.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GizmoName | FString | BaseGizmos/IntervalGizmo.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnBeginIntervalGizmoEdit | FOnBeginIntervalEdit | BaseGizmos/IntervalGizmo.h | ||
| OnEndIntervalGizmoEdit | FOnEndIntervalEdit | BaseGizmos/IntervalGizmo.h | ||
| OnIntervalChanged | FOnIntervalChanged | BaseGizmos/IntervalGizmo.h | ||
| StateTarget | TObjectPtr< UGizmoTransformChangeStateTarget > | State target is shared across gizmos, and created internally during SetActiveTarget() | BaseGizmos/IntervalGizmo.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackwardIntervalRange | UE::Geometry::FInterval1f | BaseGizmos/IntervalGizmo.h | ||
| DownIntervalRange | UE::Geometry::FInterval1f | BaseGizmos/IntervalGizmo.h | ||
| ForwardIntervalRange | UE::Geometry::FInterval1f | BaseGizmos/IntervalGizmo.h | ||
| LeftIntervalRange | UE::Geometry::FInterval1f | BaseGizmos/IntervalGizmo.h | ||
| RightIntervalRange | UE::Geometry::FInterval1f | BaseGizmos/IntervalGizmo.h | ||
| UpIntervalRange | UE::Geometry::FInterval1f | Valid ranges for intervals. | BaseGizmos/IntervalGizmo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginEditSequence() |
Notifies listeners that a sequence of edits to the gizmo is beginning/ending (at the start/end of a drag). | BaseGizmos/IntervalGizmo.h | |
virtual void ClearActiveTarget() |
Clear the active target object for the Gizmo | BaseGizmos/IntervalGizmo.h | |
virtual void ClearSources() |
Clear the parameter sources for this gizmo | BaseGizmos/IntervalGizmo.h | |
virtual void EndEditSequence() |
BaseGizmos/IntervalGizmo.h | ||
virtual FTransform GetGizmoTransform() |
Gets the location and orientation of the interval gizmo. | BaseGizmos/IntervalGizmo.h | |
virtual void SetActiveTarget
(
UTransformProxy* TransformTargetIn, |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetActiveTarget
(
UTransformProxy* TransformTargetIn, |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetGizmoActorBuilder
(
TSharedPtr< FIntervalGizmoActorFactory > Builder |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetUpdateCoordSystemFunction
(
TFunction< void(UPrimitiveComponent*, EToolContextCoordinateSystem)> CoordSysFunction |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetUpdateHoverFunction
(
TFunction< void(UPrimitiveComponent*, bool)> HoverFunction |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetVisibility
(
bool bVisible |
Set visibility of the Gizmo | BaseGizmos/IntervalGizmo.h | |
virtual void SetWorld
(
UWorld* WorldIn |
BaseGizmos/IntervalGizmo.h | ||
virtual void SetWorldAlignmentFunctions
(
TUniqueFunction< bool()>&& ShouldAlignDestination, |
Sets functions that allow the endpoints of the intervals to be snapped to world geometry when ShouldAlignDestination is true | BaseGizmos/IntervalGizmo.h |
Overridden from UInteractiveGizmo
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Setup() |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called | BaseGizmos/IntervalGizmo.h | |
virtual void Shutdown() |
Called by GizmoManager to shut down the Gizmo | BaseGizmos/IntervalGizmo.h | |
virtual void Tick
(
float DeltaTime |
Allow the Gizmo to do any necessary processing on Tick | BaseGizmos/IntervalGizmo.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UInteractiveGizmo * AddIntervalHandleGizmo
(
USceneComponent* RootComponent, |
BaseGizmos/IntervalGizmo.h |