Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveGizmo
- UIntervalGizmo
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/IntervalGizmo.h |
| Include | #include "BaseGizmos/IntervalGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class UIntervalGizmo : public UInteractiveGizmo
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
TArray< TObjectPtr< UPrimitiveComponent > > | ActiveComponents | List of current-active child components |
  |
TArray< TObjectPtr< UInteractiveGizmo > > | ActiveGizmos | List of currently-active child gizmos |
  |
TObjectPtr< UGizmoComponentAxisSource > | AxisYSource | Y-axis source is shared across Gizmos, and created internally during SetActiveTarget() |
  |
TObjectPtr< UGizmoComponentAxisSource > | AxisZSource | Z-axis source is shared across Gizmos, and created internally during SetActiveTarget() |
 |
TUniqueFunction< bool(const FRay &, FVector &)> | DestinationAlignmentRayCaster | |
 |
UGizmoLocalFloatParameterSource * | DownIntervalSource | |
 |
UGizmoLocalFloatParameterSource * | ForwardIntervalSource | |
 |
AIntervalGizmoActor * | GizmoActor | |
 |
TSharedPtr< FIntervalGizmoActorFactory > | GizmoActorBuilder | |
 |
FOnBeginIntervalEdit | OnBeginIntervalGizmoEdit | |
 |
FOnEndIntervalEdit | OnEndIntervalGizmoEdit | |
 |
FOnIntervalChanged | OnIntervalChanged | |
 |
TUniqueFunction< bool()> | ShouldAlignDestination | |
  |
TObjectPtr< UGizmoTransformChangeStateTarget > | StateTarget | State target is shared across gizmos, and created internally during SetActiveTarget() |
  |
TObjectPtr< UTransformProxy > | TransformProxy | The gizmo tracks the location and orientation of the transform in this TransformProxy. |
 |
TFunction< void(UPrimitiveComponent *, EToolContextCoordinateSystem)> | UpdateCoordSystemFunction | This function is called on each active GizmoActor Component to update it's coordinate system (eg world/local). |
 |
TFunction< void(UPrimitiveComponent *, bool)> | UpdateHoverFunction | This function is called on each active GizmoActor Component to update it's hover state. |
 |
UGizmoLocalFloatParameterSource * | UpIntervalSource | |
 |
UWorld * | World | GizmoActors will be spawned in this World |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UInteractiveGizmo * | AddIntervalHandleGizmo
(
USceneComponent* RootComponent, |
|
  |
void | Notifies listeners that a sequence of edits to the gizmo is beginning/ending (at the start/end of a drag). | |
  |
void | Clear the active target object for the Gizmo | |
  |
void | ClearSources () |
Clear the parameter sources for this gizmo |
  |
void | ||
   |
FTransform | Gets the location and orientation of the interval gizmo. | |
  |
void | SetActiveTarget
(
UTransformProxy* TransformTargetIn, |
|
  |
void | SetGizmoActorBuilder
(
TSharedPtr< FIntervalGizmoActorFactory > Builder |
|
  |
void | SetUpdateCoordSystemFunction
(
TFunction< void(UPrimitiveComponent*, EToolContextCoordinateSystem)> CoordSysFunction |
|
  |
void | SetUpdateHoverFunction
(
TFunction< void(UPrimitiveComponent*, bool)> HoverFunction |
|
  |
void | SetWorld
(
UWorld* WorldIn |
|
  |
void | SetWorldAlignmentFunctions
(
TUniqueFunction< bool()>&& ShouldAlignDestination, |
Sets functions that allow the endpoints of the intervals to be snapped to world geometry when ShouldAlignDestination is true |
Overridden from UInteractiveGizmo
| Type | Name | Description | |
|---|---|---|---|
  |
void | Setup () |
Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called |
  |
void | Shutdown () |
Called by GizmoManager to shut down the Gizmo |
  |
void | Tick
(
float DeltaTime |
Allow the Gizmo to do any necessary processing on Tick |
Typedefs
| Name | Description |
|---|---|
| FOnBeginIntervalEdit | Called when the gizmo is notified about the start of a sequence of interval changes. |
| FOnEndIntervalEdit | Called when the gizmo is notified about the end of a sequence of interval changes. |
| FOnIntervalChanged | Called when an interval is changed. |
Constants
| Name | Description |
|---|---|
| GizmoName |