1. Epic GamesDeveloper
  3. InteractiveToolsFramework

InteractiveToolsFramework

API > API/Runtime

   
Name InteractiveToolsFramework
Type Runtime
Location /Engine/Source/Runtime/InteractiveToolsFramework/
Module Build Rules InteractiveToolsFramework.Build.cs

Classes

Name Remarks
ACombinedTransformGizmoActor ACombinedTransformGizmoActor is an Actor type intended to be used with UCombinedTransformGizmo, as the in-scene visual representation of the Gizmo.
AGizmoActor AGizmoActor is a base class for Actors that would be created to represent Gizmos in the scene.
AInternalToolFrameworkActor AInternalToolFrameworkActor is a base class for internal Actors that the ToolsFramework may spawn (for gizmos, mesh previews, etc).
AIntervalGizmoActor AIntervalGizmoActor is an Actor type intended to be used with UIntervalGizmo, as the in-scene visual representation of the Gizmo.
FActivateToolChange FActivateToolChange is used by UInteractiveToolManager to change the active tool.
FBeginToolChange FBeginToolChange is used by UInteractiveToolManager to back out of a Tool on Undo.
FCombinedTransformGizmoActorFactory FCombinedTransformGizmoActorFactory creates new instances of ACombinedTransformGizmoActor which are used by UCombinedTransformGizmo to implement 3D transformation Gizmos.
FComponentTargetFactory  
FComponentWorldTransformChange FComponentWorldTransformChange represents an undoable change to the world transform of a USceneComponent.
FConstantViewRelativeTransformAdjuster Adjuster that takes the the view frame at the component world location, and applies a constant relative transform to that.
FGizmoElementAccessor A utility class to access GizmoElements that aren't otherwise publicly exposed. Use responsibly.
FInputBehaviorModifierStates FInputBehaviorModifierStates is an object that can be placed in an InputBehavior to allow users of the behavior to request that they be notified about modifier keys/buttons/etc state.
FInteractiveToolActionSet FInteractiveToolActionSet maintains a list of FInteractiveToolAction.
FInteractiveToolsFrameworkModule  
FIntervalGizmoActorFactory FIntervalGizmoActorFactory creates new instances of AIntervalGizmoActor which are used by UIntervalGizmo to implement 3D interval Gizmos.
FPrimitiveComponentTarget Wrapper around a UObject Component that can provide a MeshDescription, and (optionally) bake a modified MeshDescription back to this Component.
FSceneViewWrapper  
FSimpleConstantViewScaleAdjuster Adjuster that maintains same view size but otherwise keeps the component transform.
FSubGizmoTransformAdjuster An adjuster that can do various transformations common for sub gizmos, which are based off of the parent gizmo transform (in addition to the actual component transform).
FToolChangeWrapperChange FToolChangeWrapperChange wraps an FChange emitted by an InteractiveTool, allowing us to Expire the change without each FChange implementation needing to handle this explicitly.
FToolCommandChange FToolCommandChange is a base class for command changes used by the Tools Framework.
FToolCommandChangeSequence This class may be unnecessary, as multiple FChange can be combined in a single transaction.
FToolDataVisualizer FToolDataVisualizer is a utility class for Tool and Gizmo implementations to use to draw 3D lines, points, etc.
FToolTargetTypeRequirements A structure used to specify the requirements of a tool for its target.
FTransformProxyChange FTransformProxyChange tracks a change to the base transform for a TransformProxy
FTransformProxyChangeSource FTransformProxyChangeSource generates FTransformProxyChange instances on Begin/End.
FWatchablePropertySet  
TWrappedToolCommandChange Holds another Change and forwards Apply/Revert to it, with calls to Before/After lambas, allowing client classes to respond to a change without having to intercept it explicitly.
UAnyButtonInputBehavior UAnyButtonInputBehavior is a base behavior that provides a generic interface to a TargetButton on a physical Input Device.
UAssetBackedTarget  
UAxisAngleGizmo  
UAxisAngleGizmoBuilder  
UAxisPositionGizmo UAxisPositionGizmo implements a gizmo interaction where 1D parameter value is manipulated by dragging a point on a 3D line/axis in space.
UAxisPositionGizmoBuilder  
UBaseBrushTool UBaseBrushTool implements standard brush-style functionality for an InteractiveTool.
UBrushAdjusterInputBehavior A behavior that captures a keyboard hotkey to enter a sub-mode "bAdjustingBrush" while the key is pressed.
UBrushBaseProperties Standard properties for a Brush-type Tool
UBrushStampIndicator UBrushStampIndicator is a simple 3D brush indicator.
UBrushStampIndicatorBuilder  
UClickDragInputBehavior UClickDragInputBehavior implements a standard "button-click-drag"-style input behavior.
UClickDragTool UClickDragTool is a base tool that basically just implements IClickDragBehaviorTarget, and on setup registers a UClickDragInputBehavior.
UClickDragToolBuilder Builder for UClickDragTool
UCombinedTransformGizmo UCombinedTransformGizmo provides standard Transformation Gizmo interactions, applied to a UTransformProxy target object.
UCombinedTransformGizmoBuilder  
UCombinedTransformGizmoContextObject UCombinedTransformGizmoContextObject is a utility object that registers a set of Gizmo Builders for UCombinedTransformGizmo and variants.
UComponentBoundTransformProxy A variant of a transform proxy whose transform is always bound to a particular component.
UContextObjectStore A context object store allows tools to get access to arbitrary objects which expose data or APIs to enable additional functionality.
UDoubleClickInputBehavior UDoubleClickInputBehavior implements a standard "button-click"-style input behavior.
UGizmoArrowComponent Simple Component intended to be used as part of 3D Gizmos.
UGizmoAxisIntervalParameterSource UGizmoAxisIntervalParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a 3D translation along a line with origin/direction given by an IGizmoAxisSource.
UGizmoAxisRotationParameterSource UGizmoAxisRotationParameterSource is an IGizmoFloatParameterSource implementation that interprets the float parameter as an angle, and maps this angle to a 3D rotation around an IGizmoAxisSource (ie 3D axis).
UGizmoAxisScaleParameterSource UGizmoAxisScaleParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a scale factor along a line with origin/direction given by an IGizmoAxisSource.
UGizmoAxisSource  
UGizmoAxisTranslationParameterSource Various 1D and 2D ParameterSource converters intended to be used to create 3D transformation gizmos.
UGizmoBaseComponent Base class for simple Components intended to be used as part of 3D Gizmos.
UGizmoBaseComponentInterface  
UGizmoBaseFloatParameterSource UGizmoBaseFloatParameterSource is a base implementation of IGizmoFloatParameterSource, which is not functional but adds an OnParameterChanged delegate for further subclasses.
UGizmoBaseTransformSource UGizmoBaseTransformSource is a base implementation of IGizmoTransformSource that adds an OnTransformChanged delegate.
UGizmoBaseVec2ParameterSource UGizmoBaseVec2ParameterSource is a base implementation of IGizmoVec2ParameterSource, which is not functional but adds an OnParameterChanged delegate for further subclasses.
UGizmoBoxComponent Simple Component intended to be used as part of 3D Gizmos.
UGizmoCircleComponent Simple Component intended to be used as part of 3D Gizmos. Draws a 3D circle based on parameters.
UGizmoClickMultiTarget  
UGizmoClickTarget  
UGizmoComponentAxisSource UGizmoComponentAxisSource is an IGizmoAxisSource implementation that provides one of the X/Y/Z axes of a Component's local coordinate system, mapped to World, based on an integer AxisIndex in range [0,2].
UGizmoComponentHitTarget UGizmoComponentHitTarget is an IGizmoClickTarget implementation that hit-tests a UPrimitiveComponent
UGizmoComponentWorldTransformSource UGizmoComponentWorldTransformSource implements IGizmoTransformSource (via UGizmoBaseTransformSource) based on the internal transform of a USceneComponent.
UGizmoConstantAxisSource UGizmoConstantAxisSource is an IGizmoAxisSource implementation that internally stores the Origin and Direction constants
UGizmoConstantFrameAxisSource UGizmoConstantFrameAxisSource is an IGizmoAxisSource implementation that internally stores the Origin, Direction, and X/Y Tangent constants.
UGizmoElementArc Simple object intended to be used as part of 3D Gizmos. Draws a thick arc based on parameters.
UGizmoElementArrow Simple object intended to be used as part of 3D Gizmos. Draws a 3D arrow based on parameters.
UGizmoElementArrowHead Simple object intended to be used as part of 3D Gizmos. Draws a 3D arrowhead based on parameters.
UGizmoElementBase Base class for 2d and 3d primitive objects intended to be used as part of 3D Gizmos.
UGizmoElementBox Simple object intended to be used as part of 3D Gizmos.
UGizmoElementCircle Simple object intended to be used as part of 3D Gizmos.
UGizmoElementCircleBase Abstract base object for circle, torus and arc.
UGizmoElementCone Simple object intended to be used as part of 3D Gizmos. Draws a solid 3D cone based on parameters.
UGizmoElementCylinder Simple object intended to be used as part of 3D Gizmos.
UGizmoElementGroup Simple group object intended to be used as part of 3D Gizmos. Contains multiple gizmo objects.
UGizmoElementGroupBase Simple group object intended to be used as part of 3D Gizmos. Contains multiple gizmo objects.
UGizmoElementHitMultiTarget UGizmoElementHitMultiTarget is an IGizmoClickMultiTarget implementation that hit-tests any object derived from UGizmoElementBase.
UGizmoElementHitTarget UGizmoElementHitTarget is an IGizmoClickTarget implementation that hit-tests any object derived from UGizmoElementBase This hit target should be used for hitting a whole gizmo element hierarchy.
UGizmoElementLineBase Base class for 2d and 3d primitive objects which support line drawing, intended to be used as part of 3D Gizmos.
UGizmoElementLineStrip Simple object intended to be used as part of 3D Gizmos. Draws a rectangle based on parameters.
UGizmoElementRectangle Simple object intended to be used as part of 3D Gizmos. Draws a rectangle based on parameters.
UGizmoElementSphere Simple object intended to be used as part of 3D Gizmos.
UGizmoElementTorus Simple object intended to be used as part of 3D Gizmos.
UGizmoElementTriangleList Simple object intended to be used as part of 3D Gizmos.
UGizmoFloatParameterSource  
UGizmoLambdaHitTarget UGizmoLambdaHitTarget is an IGizmoClickTarget implementation that forwards the hit-test function to a TFunction
UGizmoLambdaStateTarget UGizmoLambdaStateTarget is an implementation of IGizmoStateTarget that forwards calls to its interface functions to external TFunctions
UGizmoLineHandleComponent Simple Component intended to be used as part of 3D Gizmos.
UGizmoLocalFloatParameterSource UGizmoLocalFloatParameterSource is an implementation of IGizmoFloatParameterSource (by way of UGizmoBaseFloatParameterSource) which locally stores the relevant Parameter and emits update events via the OnParameterChanged delegate.
UGizmoLocalVec2ParameterSource UGizmoBaseVec2ParameterSource is an implementation of IGizmoVec2ParameterSource (by way of UGizmoBaseVec2ParameterSource) which locally stores the relevant Parameter and emits update events via the OnParameterChanged delegate.
UGizmoNilStateTarget UGizmoNilStateTarget is an implementation of IGizmoStateTarget that does nothing
UGizmoObjectModifyStateTarget UGizmoObjectModifyStateTarget is an implementation of IGizmoStateTarget that opens and closes change transactions on a target UObject via a GizmoManager.
UGizmoPlaneScaleParameterSource UGizmoPlaneScaleParameterSource is an UGizmoBaseVec2ParameterSource implementation that maps a 2D parameter delta to a change in a 3D scaling vector, based on the tangent axes of a 3D plane This scale is applied to an IGizmoTransformSource.
UGizmoPlaneTranslationParameterSource UGizmoAxisRotationParameterSource is an IGizmoVec2ParameterSource implementation that interprets the FVector2D parameter as a position in a 2D plane, and maps this position to a 3D translation in a plane with origin/normal given by an IGizmoAxisSource.
UGizmoRectangleComponent Simple Component intended to be used as part of 3D Gizmos.
UGizmoRenderMultiTarget  
UGizmoRenderTarget  
UGizmoScaledAndUnscaledTransformSources A wrapper around two IGizmoTransformSource's that generally forwards transforms to/from its ScaledTransformSource, but also forwards an unscaled version of the transform to UnscaledTransformSource on SetTransform calls.
UGizmoScaledTransformSource Old description: UGizmoScaledTransformSource wraps another IGizmoTransformSource implementation and adds a separate scaling vector to the Transform.
UGizmoStateTarget  
UGizmoTransformChangeStateTarget UGizmoTransformChangeStateTarget is an implementation of IGizmoStateTarget that emits an FComponentWorldTransformChange on a target USceneComponent.
UGizmoTransformProxyTransformSource UGizmoTransformProxyTransformSource implements IGizmoTransformSource (via UGizmoBaseTransformSource) based on the internal transform of a UTransformProxy.
UGizmoTransformSource UInterfaces for the various UObjects used in the Standard Gizmo Library.
UGizmoUniformScaleParameterSource UGizmoUniformScaleParameterSource is an IGizmoVec2ParameterSource implementation that interprets the Vec2 parameter as the position in a 2D plane, and maps this parameter to a change in a uniform scale value.
UGizmoVec2ParameterSource  
UGizmoViewContext A context object that is meant to hold the scene information for the hovered viewport on a game thread, to be used by a gizmo later for hit testing.
UGizmoWorldAxisSource UGizmoWorldAxisSource is an IGizmoAxisSource that provides one of the World axes (ie X/Y/Z axes) based on an integer AxisIndex in range [0,2].
UInputBehavior An InputBehavior implements a state machine for a user interaction.
UInputBehaviorSet UInputBehaviorSet manages a set of UInputBehaviors, and provides various functions to query and forward events to the set.
UInputBehaviorSource UInterface for IInputBehavior.
UInputRouter UInputRouter mediates between a higher-level input event source (eg like an FEdMode) and a set of InputBehaviors that respond to those events.
UInteractionMechanic A UInteractionMechanic implements a "user interaction".
UInteractiveCommand A UInteractiveCommand is an atomic action that can be executed via some user interaction.
UInteractiveCommandArguments UInteractiveCommandArguments are arguments passed to a UInteractiveCommand.
UInteractiveCommandResult UInteractiveCommandResult subclasses are returned from UInteractiveCommands, to allow commands to return custom information.
UInteractiveGizmo UInteractiveGizmo is the base class for all Gizmos in the InteractiveToolsFramework.
UInteractiveGizmoBuilder A UInteractiveGizmoBuilder creates a new instance of an InteractiveGizmo (basically this is a Factory).
UInteractiveGizmoManager UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances.
UInteractiveTool UInteractiveTool is the base class for all Tools in the InteractiveToolsFramework.
UInteractiveToolBuilder A UInteractiveToolBuilder creates a new instance of an InteractiveTool (basically this is a Factory).
UInteractiveToolCameraFocusAPI UInterface for IInteractiveToolCameraFocusAPI.
UInteractiveToolEditorGizmoAPI UInterface for IInteractiveToolEditorGizmoAPI.
UInteractiveToolExclusiveToolAPI UInterface for IInteractiveToolExclusiveToolAPI.
UInteractiveToolManageGeometrySelectionAPI UInterface for IInteractiveToolManageGeometrySelectionAPI.
UInteractiveToolManager UInteractiveToolManager allows users of the tools framework to create and operate Tool instances.
UInteractiveToolNestedAcceptCancelAPI UInterface for IInteractiveToolNestedAcceptCancelAPI.
UInteractiveToolPropertySet A UInteractiveTool contains a set of UObjects that contain "properties" of the Tool, ie the configuration flags, parameters, etc that control the Tool.
UInteractiveToolsContext InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, and ContextStore.
UInteractiveToolShutdownQueryAPI UInterface for IInteractiveToolShutdownQueryAPI.
UInteractiveToolWithToolTargetsBuilder A UInteractiveToolWithToolTargetsBuilder creates a new instance of an InteractiveTool that uses tool targets.
UIntervalGizmo  
UIntervalGizmoBuilder  
UKeyAsModifierInputBehavior UKeyAsModifierInputBehavior converts a specific key press/release into a "Modifier" toggle via the IModifierToggleBehaviorTarget interface.
UKeyInputBehavior UKeyInputBehavior provides a keyboard capturing behavior that works with single or multiple keys.
ULocalClickDragInputBehavior ULocalClickDragInputBehavior is an implementation of UClickDragInputBehavior that also implements IClickDragBehaviorTarget directly, via a set of local lambda functions.
ULocalDoubleClickInputBehavior An implementation of UDoubleClickInputBehavior that also implements IClickBehaviorTarget directly, via a set of local lambda functions.
ULocalInputBehaviorSource An implementation of IInputBehaviorSource that forwards to a user provided-lambda, to allow a tool to supply a behavior source different from the one it is implementing itself.
ULocalMouseHoverBehavior An implementation of UMouseHoverBehavior that also implements IHoverBehaviorTarget directly, via a set of local lambda functions.
ULocalSingleClickInputBehavior An implementation of USingleClickInputBehavior that also implements IClickBehaviorTarget directly, via a set of local lambda functions.
ULocalTwoAxisPropertyEditInputBehavior Variant of the base behavior which allows tools to use lambda functions instead of explicitly defining a behavior target.
UMaterialProvider  
UMeshDescriptionCommitter  
UMeshDescriptionProvider  
UMeshSelectionSet UMeshSelectionSet is an implementation of USelectionSet that represents selections on indexed meshes.
UMeshSurfacePointTool UMeshSurfacePointTool is a base Tool implementation that can be used to implement various "point on surface" interactions.
UMeshSurfacePointToolBuilder  
UMouseButtonAsModifierInputBehavior A version of UKeyAsModifierInputBehavior for mouse buttons
UMouseHoverBehavior Trivial InputBehavior that forwards InputBehavior hover events to a Target object via the IHoverBehaviorTarget interface.
UMouseWheelInputBehavior  
UMouseWheelModifierInputBehavior  
UMultiClickSequenceInputBehavior UMultiClickSequenceInputBehavior implements a generic multi-click-sequence input behavior.
UMultiSelectionTool  
UPhysicsDataSource  
UPlanePositionGizmo UPlanePositionGizmo implements a gizmo interaction where 2D parameter value is manipulated by dragging a point on a 3D plane in space.
UPlanePositionGizmoBuilder  
UPrimitiveComponentBackedTarget  
UPrimitiveComponentToolTarget A tool target to share some reusable code for tool targets that are backed by primitive components.
UPrimitiveComponentToolTargetFactory Factory for UPrimitiveComponentToolTarget to be used by the target manager.
URepositionableTransformGizmo A transform gizmo that also allows the user to reposition it by middle-clicking rotation/translation components.
URepositionableTransformGizmoBuilder  
UScalableSphereGizmo UScalableSphereGizmo provides a sphere that can be scaled in all directions by dragging anywhere on the three axial circles that represent it
UScalableSphereGizmoBuilder  
UScalableSphereGizmoInputBehavior A behavior that forwards clicking and dragging to the gizmo.
USceneComponentBackedTarget  
USceneComponentToolTarget A tool target to share some reusable code for tool targets that are backed by scene components
USceneComponentToolTargetFactory Factory for USceneComponentToolTarget to be used by the target manager.
USceneSnappingManager USceneSnappingManager is intended to be used as a base class for a Snapping implementation stored in the ContextObjectStore of an InteractiveToolsContext.
USelectionSet USelectionSet is a base class for Selection objects.
USimpleLambdaInteractiveGizmoBuilder Gizmo builder that simply calls a particular lambda when building a gizmo.
USimpleSingleClickGizmo Simple gizmo that triggers an OnClicked callback when it is clicked.
USingleClickInputBehavior USingleClickInputBehavior implements a standard "button-click"-style input behavior.
USingleClickOrDragInputBehavior USingleClickOrDragInputBehavior is a combination of a USingleClickBehavior and UClickDragBehavior, and allows for the common UI interaction where a click-and-release does one action, but if the mouse is moved, then a drag interaction is started.
USingleClickTool USingleClickTool is perhaps the simplest possible interactive tool.
USingleClickToolBuilder Builder for USingleClickTool
USingleKeyCaptureBehavior USingleKeyCaptureBehavior captures a key press and routes it to target via the IModifierToggleBehaviorTarget interface.
USingleSelectionTool  
USkeletalMeshBackedTarget  
UStaticMeshBackedTarget  
UToolContextTransactionProvider  
UToolFrameworkComponent UInterface for IToolFrameworkComponent.
UToolsContextCursorAPI Users of the Tools Framework can use UToolsContextCursorAPI to access to setting and retrieving cursor overrides for tool activities.
UToolTarget A tool target is a stand-in object that a tool can operate on.
UToolTargetFactory Base class for factories of tool targets, which let a tool manager build targets out of inputs without knowing anything about the inputs itself, as long as it has a factory registered that is able to process the input.
UToolTargetManager TODO: Do we need more control over factory order to prioritize which gets used if we can make multiple qualifying targets? It should theoretically not matter, but in practice, one target or another could be more efficient for certain tasks.
UTransformProxy UTransformProxy is used to transform a set of sub-objects.
UTwoAxisPropertyEditInputBehavior A behavior that captures a keyboard hotkey to enter a property adjustment sub-mode while the key is pressed.
UViewAdjustedStaticMeshGizmoComponent Version of a static mesh component that only takes the dynamic draw path and has the ability to adjust the transform based on view information.
UWidgetBaseBehavior IWidgetBaseBehavior is an interface for tools that can modify / extend various step of a widget.

Structs

Name Remarks
FActiveGizmo  
FBehaviorInfo This is an internal structure used by UInputBehaviorSet.
FBrushStampData Generic Brush Stamp data
FCommitMeshParameters FCommitMeshParameters is used by ToolTarget Interfaces/Implementations that support setting a mesh (eg on a StaticMesh Asset), to allow the client to specify various options
FComponentMaterialSet FComponentMaterialSet is the set of materials assigned to a component (ie Material Slots on a StaticMesh)
FDefaultGizmoMaterialExtraParams  
FDeviceButtonState Current State of a physical device button (mouse, key, etc) at a point in time.
FGetMeshParameters FGetMeshParameters is used by ToolTarget Interfaces/Implementations that support returning a mesh, to allow clients to specify various options like a specific LOD of a mesh, which attributes are required, etc.
FGizmoElementColorAttribute Structs used to store gizmo element render state.
FGizmoElementLineRenderStateAttributes Line render state structure.
FGizmoElementMaterialAttribute Material state attribute struct
FGizmoElementMeshRenderStateAttributes Mesh render state structure.
FGizmoFloatParameterChange FGizmoVec2ParameterChange represents a change in the value of an IGizmoFloatParameterSource.
FGizmoPerStateValueLinearColor Used to store per-state (Linear Color) values for gizmo elements. ie. vertex color.
FGizmoVec2ParameterChange Various implementations of IGizmoVec2ParameterSourceFGizmoVec2ParameterChange represents a change in the value of an IGizmoVec2ParameterSource.
FInitMeshSubGizmoParams Parameter struct for InitializeSubGizmoElementsWithMesh.
FInputCaptureData An active capturing behavior may need to keep track of additional data that cannot be stored within the behavior (for example if the same behavior instance is capturing for Left and Right separately).
FInputCapturePriority Each UInputBehavior provides a priority that is used to help resolve situations when multiple Behaviors want to capture based on the same input event
FInputCaptureRequest UInputBehavior returns an FInputCaptureRequest from WantsCapture() to indicate whether it wants to capture or ignore an input event
FInputCaptureUpdate IInputBehavior returns an FInputCaptureUpdate from BeginCapture() and UpdateCapture(), which indicates to the InputRouter what the Behavior would like to have happen.
FInputDeviceRay FInputDeviceRay represents a 3D ray created based on an input device.
FInputDeviceState Current state of physical input devices at a point in time.
FInputRayHit FInputRayHit is returned by various hit-test interface functions.
FInteractiveToolAction FInteractiveToolAction is returned by a UInteractiveTool to represent an "Action" the Tool can execute.
FInteractiveToolInfo FInteractiveToolInfo provides information about a tool (name, tooltip, etc)
FKeyboardInputDeviceState Current state of active keyboard key at a point in time
FMouseInputDeviceState Current State of a physical Mouse device at a point in time.
FSceneHitQueryRequest Configuration variables for a USceneSnappingManager hit query request.
FSceneHitQueryResult Computed result of a USceneSnappingManager hit query request
FSceneQueryVisibilityFilter  
FSceneSnapQueryRequest Configuration variables for a USceneSnappingManager snap query request.
FSceneSnapQueryResult Computed result of a USceneSnappingManager snap query request
FSelectedObjectsChangeList Represents a change to a set of selected Actors and Components
FSeparateScaleProvider FSeparateScaleProvider provides TFunction-implementable API that sets/gets a Scaling Vector from an external source.
FToolBuilderState FToolBuilderState is a bucket of state information that a ToolBuilder might need to construct a Tool.
FToolContextOptionalToggle FToolContextOptionalToggle is used to store a boolean flag where the value of the boolean may either be set directly, or it may be set by querying some external context.
FToolContextSnappingConfiguration Snapping configuration settings/state
FTransformSubGizmoCommonParams Common parameters needed for initializing a sub gizmo.
FTransformSubGizmoSharedState A struct to hold some objects that can be reused across multiple sub gizmos that operate on the same compound gizmo, to avoid creating redundant objects.
FViewCameraState FViewCameraState is a bucket of state information that a Tool might need to implement interactions that depend on the current scene view.

Interfaces

Name Remarks
IAssetBackedTarget  
IClickBehaviorTarget Functions required to apply standard "Click" state machines to a target object.
IClickDragBehaviorTarget Functions required to apply standard "Click-Drag" state machines to a target object.
IClickSequenceBehaviorTarget Target interface used by InputBehaviors that want to implement a multi-click sequence (eg such as drawing a polygon with multiple clicks)
IGizmoAxisSource IGizmoAxisSource is an interface which is used to get information about a 3D Axis.
IGizmoBaseComponentInterface Interface that allows a component to receive various gizmo-specific callbacks while still inheriting from some class other than UGizmoBaseComponent.
IGizmoClickMultiTarget IGizmoClickMultiTarget is an interface used to provide a ray-object hit test against a target which supports hitting parts of the target.
IGizmoClickTarget IGizmoClickTarget is an interface used to provide a ray-object hit test.
IGizmoFloatParameterSource IGizmoFloatParameterSource provides Get and Set for an arbitrary float-valued parameter.
IGizmoRenderMultiTarget IGizmoRenderMultiTarget is an interface used to provide rendering of a target and the ability to specify which part of a target should be visible.
IGizmoRenderTarget UGizmoRenderTarget is an interface used to provide rendering of a target
IGizmoStateTarget IGizmoStateTarget is an interface that is used to pass notifications about significant gizmo state updates
IGizmoTransformSource IGizmoTransformSource is an interface which is used to Get/Set an FTransform.
IGizmoVec2ParameterSource IGizmoVec2ParameterSource provides Get and Set for an arbitrary 2D-vector-valued parameter.
IHoverBehaviorTarget IHoverBehaviorTarget allows Behaviors to notify Tools/etc about device event data in a generic way, without requiring that all Tools know about the concept of Hovering.
IInputBehaviorSource UObjects that implement IInputBehaviorSource have an UInputBehaviorSet that they can provide (to UInputRouter, primarily)
IInteractiveToolCameraFocusAPI IInteractiveToolCameraFocusAPI provides two functions that can be used to extract "Focus" / "Region of Interest" information about an active Tool:
IInteractiveToolEditorGizmoAPI IInteractiveToolEditorGizmoAPI provides an API to indicate whether the standard editor gizmos can be enabled while this tool is active.
IInteractiveToolExclusiveToolAPI IInteractiveToolExclusiveToolAPI provides an API to inform the ToolManager about tool exclusivity.
IInteractiveToolManageGeometrySelectionAPI Provides an API to allow a tool to report how it has affected (updated or invalidated) geometry selections on the tool's targets
IInteractiveToolNestedAcceptCancelAPI IInteractiveToolNestedAcceptCancelAPI provides an API for a Tool to publish intent and ability to Accept or Cancel sub-operations.
IInteractiveToolShutdownQueryAPI Allows an interactive tool to influence the way it is shut down, if the tool host supports that kind of customization.
IKeyInputBehaviorTarget IKeyInputBehaviorTarget is an interface that InputBehaviors can use to notify a target about keyboard buttons toggling states, such as pressed or released.
IMaterialProvider  
IMeshDescriptionCommitter  
IMeshDescriptionProvider  
IModifierToggleBehaviorTarget IModifierToggleBehaviorTarget is an interface that InputBehaviors can use to notify a target about modifier toggle states (like shift key being down, etc).
IMouseWheelBehaviorTarget Functions required to apply mouse wheel behavior
IPhysicsDataSource IPhysicsDataSource is a ToolTarget Interface that provides read/write access to physics-related data structures.
IPrimitiveComponentBackedTarget  
ISceneComponentBackedTarget  
ISceneViewInterface Interface meant to wrap either an FSceneView or UGizmoViewContext so that a user can write one function to handle either one (for rendering and for hit testing).
ISkeletalMeshBackedTarget  
IStaticMeshBackedTarget  
IToolCommandChangeSource IToolCommandChangeSource is a generic interface for generating a change object.
IToolContextTransactionProvider IToolContextTransactionProvider is a UInterface that defines several functions that InteractiveTool code uses to interface with the higher-level transaction system.
IToolFrameworkComponent IToolFrameworkComponent is an interface we can attach to custom Components used in the Tools framework.
IToolsContextQueriesAPI Users of the Tools Framework need to implement IToolsContextQueriesAPI to provide access to scene state information like the current UWorld, active USelections, etc.
IToolsContextRenderAPI Users of the Tools Framework need to implement IToolsContextRenderAPI to allow Tools, Indicators, and Gizmos to make low-level rendering calls for things like line drawing.
IToolsContextTransactionsAPI Users of the Tools Framework need to implement IToolsContextTransactionsAPI so that the Tools have the ability to create Transactions and emit Changes.
IToolStylusStateProviderAPI This is a temporary interface to provide stylus pressure, currently necessary due to limitations in the stylus plugin architecture.
ITwoAxisPropertyEditBehaviorTarget ITwoAxisPropertyEditBehaviorTarget allows tools to expose properties to drag-based property edit behaviors.
IViewBasedTransformAdjuster Interface for a helper that can adjust a component's transform based on view information, used by UViewAdjustedStaticMeshGizmoComponent.
IWidgetBaseBehavior  

Typedefs

Name Type Remarks Include Path
EStaticMeshEditingLOD EMeshLODIdentifier   TargetInterfaces/MeshTargetInterfaceTypes.h
FInteractiveToolPropertySetModifiedSignature TMulticastDelegate_TwoParams< void, UObject *, FProperty * > This delegate is used by UInteractiveToolPropertySet InteractiveTool.h
FSelectedOjectsChangeList FSelectedObjectsChangeList   ToolContextInterfaces.h
FSelectionSetModifiedSignature TMulticastDelegate_OneParam< void, USelectionSet * > This delegate is used by UInteractiveToolPropertySet SelectionSet.h

Enums

Public

Name Remarks
EGizmoElementArrowHeadType  
EGizmoElementDrawType Can be used to specify what visuals should be created for a given element, when multiple are available, ie. Fill and Line.
EGizmoElementPartialType Partial type: render partial element for those elements which support it.
EGizmoElementState Visible/hittable state of gizmo element
EGizmoElementViewAlignType View align type: automatically align gizmo element towards a view.
EGizmoElementViewDependentType View dependent type: automatically cull gizmo element based on view.
EInputCaptureRequestType Used by FInputCaptureRequest to indicate whether the InputBehavior wants to capture or ignore an input event
EInputCaptureSide Input can be captured separately for Left and Right sides (eg for VR controllers) Currently mouse is Left.
EInputCaptureState FInputCaptureUpdate uses this type to indicate what state the capturing Behavior would like to transition to, based on the input event
EInputDevices Input event data can be applicable to many possible input devices.
EMeshLODIdentifier EMeshLODIdentifier is used to identify the LOD of a mesh for reading/writing.
EMeshSelectionElementType  
ESceneSnapQueryTargetResult Describes the result of the attempted snap operation.
ESceneSnapQueryTargetType Types of Snap Targets that a caller may want to run snap queries against.
ESceneSnapQueryType Types of Snap Queries that a USceneSnappingManager may support
ESelectedObjectsModificationType Type of change we want to apply to a selection
EStandardToolActions Standard Actions that can be shared across multiple Tools.
EStandardToolContextMaterials Types of standard materials that Tools may request from Context
EToolChangeTrackingMode UInteractiveToolManager can emit change events for the active tool in various ways.
EToolContextCoordinateSystem Types of coordinate systems that a Tool/Gizmo might use
EToolContextTransformGizmoMode High-level configuration options for a standard 3D translate/rotate/scale Gizmo, like is commonly used in 3D DCC tools, game editors, etc This is meant to be used to convey UI-level settings to Tools/Gizmos, eg like the W/E/R toggles for Rranslate/Rotate/Scale in Maya or UE Editor.
EToolManagerToolSwitchMode Determines how a currently active tool is shutdown when switching to another tool.
EToolMessageLevel Level of severity of messages emitted by Tool framework
EToolShutdownReason Used in various ways by the tool manager and some optional tool interfaces to make shutdown responses configurable.
EToolShutdownType Passed to UInteractiveTool::Shutdown to indicate how Tool should shut itself down
EToolSide A Tool can be activated on a particular input device, currently identified by a "side"
ETransformGizmoSubElements ETransformGizmoSubElements identifies the sub-elements of a standard 3-axis transformation Gizmo.
EViewInteractionState  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GIZMO_TRANSLUCENCY_SORT_PRIORITY const int32 Can be used as TranslucencySortPriority to make gizmo elements show up above other translucent objects. BaseGizmos/GizmoRenderingUtil.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddComponentTargetFactory ( TUniquePtr< FComponentTargetFactory > Factory
)

 Add a factory method to make ComponentTarget from UPrimitiveComponent* ComponentSourceInterfaces.h  

bool CanMakeComponentTarget ( UActorComponent* Component
)

 Determine whether a TargetComponent can be created for the given Component ComponentSourceInterfaces.h  
Interaction state of gizmo element BaseGizmos/GizmoElementShared.h  

ENUM_CLASS_FLAGS(EGizmoElementDrawType) enum class EGizmoElementHitSortType ENUM_CLASS_FLAGS ( EGizmoElementHitSortType
)

 Used to specify the sort criteria when hit testing against multiple elements. BaseGizmos/GizmoElementShared.h  

FComponentTargetFactory * FindComponentTargetFactoryByKey ( int32 Key
)

   ComponentSourceInterfaces.h  

void GizmoMath::ClosetPointOnCircle ( const FVector& QueryPoint,
const FVector& CircleOrigin,
const FVector& CircleNormal,
float CircleRadius,
FVector& ClosestPointOut
)

 Find the closest point to QueryPoint that is on the circle defined by CircleOrigin, CircleNormal, and CircleRadius. BaseGizmos/GizmoMath.h  

float GizmoMath::ComputeAngleInPlane ( const FVector& Point,
const FVector& PlaneOrigin,
const FVector& PlaneNormal,
const FVector& PlaneAxis1,
const FVector& PlaneAxis2
)

 Project the input Point into the plane defined by PlaneOrigin and PlaneNormal, and then measure it's signed angle relative to the in-plane X and Y axes defined by PlaneAxis1 and PlaneAxis2 BaseGizmos/GizmoMath.h  

FVector2D GizmoMath::ComputeCoordinatesInPlane ( const FVector& Point,
const FVector& PlaneOrigin,
const FVector& PlaneNormal,
const FVector& PlaneAxis1,
const FVector& PlaneAxis2
)

 Project the input Point into the plane defined by PlaneOrigin and PlaneNormal, and then calculate it's UV coordinates in the space defined by the plane axes PlaneAxis1 and PlaneAxis2 BaseGizmos/GizmoMath.h  

FVector GizmoMath::GetOrthogonalVector ( const FVector& V
)

   BaseGizmos/GizmoMath.h  

void GizmoMath::IntervalIntervalIntersection ( const RealType Interval0,
const RealType Interval1,
int& OutNumIntersections,
RealType& OutResult0,
RealType& OutResult1
)

 Find the intersection of two floating point intervals in which the interval inputs contain pairs of floats sorted in increasing order. BaseGizmos/GizmoMath.h  

void GizmoMath::MakeNormalPlaneBasis ( const FVector& PlaneNormal,
FVector& BasisAxis1Out,
FVector& BasisAxis2Out
)

 Construct two mutually-perpendicular unit vectors BasisAxis1Out and BasisAxis2Out which are orthogonal to PlaneNormal BaseGizmos/GizmoMath.h  

void GizmoMath::NearestPointOnLine ( const FVector& LineOrigin,
const FVector& LineDirection,
const FVector& QueryPoint,
FVector& NearestPointOut,
float& LineParameterOut
)

 Find the nearest point to QueryPoint on the line defined by LineOrigin and LineDirection. BaseGizmos/GizmoMath.h  

void GizmoMath::NearestPointOnLineToRay ( const FVector& LineOrigin,
const FVector& LineDirection,
const FVector& RayOrigin,
const FVector& RayDirection,
FVector& NearestLinePointOut,
float& LineParameterOut,
FVector& NearestRayPointOut,
float& RayParameterOut
)

 Find the closest pair of points on a 3D line and 3D ray. BaseGizmos/GizmoMath.h  

FVector GizmoMath::ProjectPointOntoLine ( const FVector& Point,
const FVector& LineOrigin,
const FVector& LineDirection
)

 Project a point onto the line defined by LineOrigin and LineDirection BaseGizmos/GizmoMath.h  

FVector GizmoMath::ProjectPointOntoPlane ( const FVector& Point,
const FVector& PlaneOrigin,
const FVector& PlaneNormal
)

 Project the input Point onto the plane defined by PlaneOrigin and PlaneNormal, BaseGizmos/GizmoMath.h  

void GizmoMath::RayConeIntersection ( const FVector& ConeCenter,
const FVector& ConeDirection,
RealType ConeCosAngle,
RealType ConeHeight,
const FVector& RayOrigin,
const FVector& RayDirection,
bool& bIntersectsOut,
RealType& OutHitDepth
)

 Find the intersection of the ray defined by RayOrigin and RayDirection with the cone defined by ConeCenter, ConeDirection, ConeCosAngle, and ConeHeight. BaseGizmos/GizmoMath.h  

void GizmoMath::RayCylinderIntersection ( const FVector& CylinderCenter,
const FVector& CylinderAxis,
RealType CylinderRadius,
RealType CylinderHeight,
const FVector& RayOrigin,
const FVector& RayDirection,
bool& bIntersectsOut,
RealType& OutHitDepth
)

 Find the intersection of the ray defined by RayOrigin and RayDirection with the cylinder defined by CylinderCenter, CylinderAxis, CylinderRadius, and CylinderHeight. BaseGizmos/GizmoMath.h  

void GizmoMath::RayPlaneIntersectionPoint ( const FVector& PlaneOrigin,
const FVector& PlaneNormal,
const FVector& RayOrigin,
const FVector& RayDirection,
bool& bIntersectsOut,
FVector& PlaneIntersectionPointOut
)

 Find the intersection of the ray defined by RayOrigin and RayDirection with the plane defined by PlaneOrigin and PlaneNormal. BaseGizmos/GizmoMath.h  

void GizmoMath::RaySphereIntersection ( const FVector& SphereOrigin,
const float SphereRadius,
const FVector& RayOrigin,
const FVector& RayDirection,
bool& bIntersectsOut,
FVector& SphereIntersectionPointOut
)

 Find the intersection of the ray defined by RayOrigin and RayDirection with the sphere defined by SphereOrigin and SphereRadius. BaseGizmos/GizmoMath.h  

RealType GizmoMath::SnapToIncrement ( RealType Value,
RealType Increment
)

 Round Value to nearest step of Increment BaseGizmos/GizmoMath.h  

float GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const FSceneView* View,
const FVector& Location
)

   BaseGizmos/GizmoRenderingUtil.h  

float GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const UGizmoViewContext* ViewContext,
const FVector& Location
)

   BaseGizmos/GizmoRenderingUtil.h  

float GizmoRenderingUtil::CalculateViewDependentScaleAndFlatten ( const FSceneView* View,
const FVector& Location,
const float Scale,
FVector& OutWorldFlattenScale
)

   BaseGizmos/GizmoRenderingUtil.h  

TUniquePtr< FPrimitiveComponentTarget > MakeComponentTarget ( UPrimitiveComponent* Component
)

 Create a TargetComponent for the given Component ComponentSourceInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  
  InputState.h  
  InteractiveGizmo.h  
  SceneQueries/SceneSnappingManager.h  
  ToolContextInterfaces.h  

void RemoveAllComponentTargetFactoryies()

 Remove all registered ComponentTargetFactory objects ComponentSourceInterfaces.h  

bool RemoveComponentTargetFactoryByKey ( int32 Key
)

   ComponentSourceInterfaces.h  

INTERACTIVETOOLSFRAMEWORK_API bool ToolBuilderUtil::ComponentTypeCouldHaveUVs ( const UActorComponent& Component
)

 Determine if component support UVs. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_APIint32 ToolBuilderUtil::CountActors ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 Count number of selected Actors that pass predicate. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_API int ToolBuilderUtil::CountComponents ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 Count number of selected components that pass predicate. ToolBuilderUtil.h  

int ToolBuilderUtil::CountSelectedActorsOfType ( const FToolBuilderState& InputState
)

 Count number of selected Actors of given type. ToolBuilderUtil.h  
Count number of components of given type. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_API void ToolBuilderUtil::EnumerateComponents ( const FToolBuilderState& InputState,
TFunctionRef< void(UActorComponent*)> ComponentFunc
)

   ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_APITArray< AActor * > ToolBuilderUtil::FindAllActors ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 First all Actors that pass predicate. Searches Actors selection list. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_APITArray< UActorComponent * > ToolBuilderUtil::FindAllComponents ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 First all components that passes predicate. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_API AActor * ToolBuilderUtil::FindFirstActor ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 First first available Actor that passes predicate. Searches Actors selection list. ToolBuilderUtil.h  

ActorType * ToolBuilderUtil::FindFirstActorOfType ( const FToolBuilderState& InputState
)

 Find first first available Actor of given type, or return nullptr if not found ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_API UActorComponent * ToolBuilderUtil::FindFirstComponent ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 First first available component that passes predicate. ToolBuilderUtil.h  

ComponentType * ToolBuilderUtil::FindFirstComponentOfType ( const FToolBuilderState& InputState
)

 First first available component of given type. ToolBuilderUtil.h  

INTERACTIVETOOLSFRAMEWORK_API bool ToolBuilderUtil::IsVolume ( const UActorComponent& Component
)

 Determine if component is a volume or not. ToolBuilderUtil.h  

float UE::GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const FSceneView* View,
const FVector& Location,
const double InDPIScale
)

 This is a local estimate and is increasingly incorrect as the 3D point gets further from Location BaseGizmos/GizmoRenderingUtil.h  

float UE::GizmoRenderingUtil::CalculateLocalPixelToWorldScale ( const UE::GizmoRenderingUtil::ISceneViewInterface* View,
const FVector& Location,
const bool bInWithDPIScale,
const TOptional< double >& InDPIScale
)

 : if bInWithDPIScale is true, we use ISceneViewInterface::DPIScale or the provided InDPIScale when set. BaseGizmos/GizmoRenderingUtil.h  

float UE::GizmoRenderingUtil::CalculateViewDependentScaleAndFlatten ( const UE::GizmoRenderingUtil::ISceneViewInterface* View,
const FVector& Location,
const float Scale,
FVector& OutWorldFlattenScale
)

   BaseGizmos/GizmoRenderingUtil.h  

float UE::GizmoRenderingUtil::CalculateViewDependentScaleAndFlatten ( const FSceneView* View,
const FVector& Location,
const float Scale,
FVector& OutWorldFlattenScale
)

   BaseGizmos/GizmoRenderingUtil.h  

UViewAdjustedStaticMeshGizmoComponent * UE::GizmoRenderingUtil::CreateDefaultMaterialGizmoMeshComponent ( UStaticMesh* Mesh,
UGizmoViewContext* GizmoViewContext,
UObject* OwnerComponentOrActor,
const FLinearColor& Color,
bool bAddHoverMaterial
)

 Helper that creates a component with the default gizmo material and sets up the component-side properties that are needed for it to properly work (translucency sort priority, etc). BaseGizmos/GizmoRenderingUtil.h  

UViewAdjustedStaticMeshGizmoComponent * UE::GizmoRenderingUtil::CreateDefaultMaterialGizmoMeshComponent ( UStaticMesh* Mesh,
UInteractiveGizmoManager* GizmoManager,
UObject* OwnerComponentOrActor,
const FLinearColor& Color,
bool bAddHoverMaterial
)

 Overload that takes a gizmo manager to get the view context from that. BaseGizmos/GizmoRenderingUtil.h  

FLinearColor UE::GizmoRenderingUtil::GetDefaultAxisColor ( EAxis::Type Axis
)

 Gets a red/green/blue color based on the axis (X, Y, or Z). BaseGizmos/GizmoRenderingUtil.h  

UMaterialInterface * UE::GizmoRenderingUtil::GetDefaultGizmoComponentMaterial ( const FLinearColor& Color,
UObject* Outer
)

 Gets a custom material suitable to use for gizmo components. BaseGizmos/GizmoRenderingUtil.h  
Like the other overload, but with additional parameters. BaseGizmos/GizmoRenderingUtil.h  

GizmoClass * UE::GizmoUtil::CreateGizmoViaSimpleBuilder ( UInteractiveGizmoManager* GizmoManager,
const FString& InstanceIdentifier,
void* GizmoOwner
)

 Template version of CreateGizmoViaSimpleBuilder that does a cast on return. BaseGizmos/GizmoUtil.h  

UInteractiveGizmo * UE::GizmoUtil::CreateGizmoViaSimpleBuilder ( UInteractiveGizmoManager* GizmoManager,
TSubclassOf< UInteractiveGizmo > GizmoClass,
const FString& InstanceIdentifier,
void* Owner
)

 Uses the gizmo manager to create a gizmo of the given class (assuming that the gizmo type does not need any special setup beyond instantiation) without having to register a custom builder for that class ahead of time. BaseGizmos/GizmoUtil.h  

FTransform UE::GizmoUtil::GetRotatedBasisTransform ( const FTransform& TransformIn,
EAxis::Type AxisToBeX
)

 Rotates a transform such that its basis still lies along the cardinal axes but rotated in such a way that the given axis is in the X direction. BaseGizmos/TransformSubGizmoUtil.h  

void UE::GizmoUtil::InitializeSubGizmoElementsWithMesh ( const FInitMeshSubGizmoParams& Params,
TArray< TPair< ETransformGizmoSubElements, UViewAdjustedStaticMeshGizmoComponent* > >* Ele...
)

 Given a UCombinedTransformGizmo, swaps selected elements with custom meshes. BaseGizmos/TransformSubGizmoUtil.h  
Spawn a new standard 3-axis Transform gizmo (see UCombinedTransformGizmoContextObject::Create3AxisTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  
Spawn a new standard 3-axis Transform gizmo (see UCombinedTransformGizmoContextObject::Create3AxisTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  
Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  
Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomRepositionableTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  
Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) GizmoManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  
Spawn a new custom Transform gizmo (see UCombinedTransformGizmoContextObject::CreateCustomTransformGizmo for details) ToolManager's ToolsContext must have a UCombinedTransformGizmoContextObject registered (see UCombinedTransformGizmoContextObject for details) BaseGizmos/TransformGizmoUtil.h  

bool UE::TransformGizmoUtil::DeregisterTransformGizmoContextObject ( UInteractiveToolsContext* ToolsContext
)

 Remove any existing UCombinedTransformGizmoContextObject from the ToolsContext's ContextObjectStore BaseGizmos/TransformGizmoUtil.h  

bool UE::TransformGizmoUtil::RegisterTransformGizmoContextObject ( UInteractiveToolsContext* ToolsContext
)

 The functions below are helper functions that simplify usage of a UCombinedTransformGizmoContextObject that is registered as a ContextStoreObject in an InteractiveToolsContext If one does not already exist, create a new instance of UCombinedTransformGizmoContextObject and add it to the ToolsContext's ContextObjectStore BaseGizmos/TransformGizmoUtil.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page