ViewportInteraction


Name	ViewportInteraction
Type	Editor
Location	/Engine/Source/Editor/ViewportInteraction/
Module Build Rules	ViewportInteraction.Build.cs

Name	Remarks
ABaseTransformGizmo	Displays measurements along the bounds of selected objects Base class for transform gizmo
FActorViewportTransformable	A transformable actor
FOneEuroFilter	1 Euro filter smoothing algorithm http://cristal.univ-lille.fr/~casiez/1euro/
FViewportInteractionStyle
FViewportTransformable	Represents an object that we're actively interacting with, such as a selected actor
UActorTransformer
UAxisGizmoHandleGroup	Base class for gizmo handles on axis
UGizmoHandleGroup	Base class for gizmo handles
UGizmoHandleMeshComponent
UMouseCursorInteractor	Viewport interactor for a mouse cursor
UPlaneTranslationDragOperation	Gizmo translation on two axes.
URotateOnAngleDragOperation	Rotation around one axis based on input angle.
UScaleDragOperation	Scale on one axis.
UTranslationDragOperation	Gizmo translation on one axis.
UUniformScaleDragOperation	Scale on all axes.
UViewportDragOperation	Base class for interactable drag calculations
UViewportDragOperationComponent	Container component for UViewportDragOperation that can be used by objects in the world that are draggable and implement the ViewportInteractableInterface
UViewportInteractableInterface
UViewportInteractor	Filter mode for GetHitResultFromLaserPointer Represents the interactor in the world
UViewportTransformer
UViewportWorldInteraction
UVISettings	Implements the settings for Viewport Interaction and VR Mode.

Name	Remarks
IViewportInteractableInterface	Interface for custom objects that can be interacted with by a interactor
IViewportInteractionModule	The public interface to this module

Name	Type	Remarks	Include Path	Unreal Specifiers
bAllowSnap	bool		ViewportDragOperation.h
bDraggingWithGrabberSphere	bool	True if we're dragging using the grabber sphere, or false if we're using the laser (or world movement)	ViewportInteractorData.h
bHitResultIsPriorityType	bool	If the latest hitresult is hovering over a priority type	ViewportInteractorData.h
bIsAxis	bool		ViewportInteractionTypes.h
bIsDrivingVelocityOfSimulatedTransformables	bool	While dragging, true if we're dragging at least one simulated object that we're driving the velocities of.	ViewportInteractorData.h
bIsFirstDragUpdate	bool	True if this is the first update since we started dragging	ViewportInteractorData.h
bIsInputCaptured	bool	True if this action owned by an interactor is "captured" for each possible action type, meaning that only the active captor should handle input events until it is no longer captured.	ViewportInteractionTypes.h
bOutMovedTransformGizmo	bool		ViewportDragOperation.h
bOutRotated	bool		ViewportDragOperation.h
bOutScaled	bool		ViewportDragOperation.h
bOutShouldApplyVelocitiesFromDrag	bool		ViewportDragOperation.h
bOutTranslated	bool		ViewportDragOperation.h
bWasAssistingDrag	bool	True if we were assisting the other hand's drag the last time we did anything.	ViewportInteractorData.h
ClickingOnComponent	TWeakObjectPtr< UActorComponent >	General input True if we're currently holding the 'SelectAndMove' button down after clicking on an actor	ViewportInteractorData.h
ConstrainedDragDelta	FVector		ViewportDragOperation.h
DragDelta	FVector		ViewportDragOperation.h
DragDeltaFromStart	FVector		ViewportDragOperation.h
DraggedTo	FVector		ViewportDragOperation.h
DraggingMode	EViewportInteractionDraggingMode	Object/world movement What we're currently dragging with this hand, if anything	ViewportInteractorData.h
DraggingTransformGizmoComponent	TWeakObjectPtr< class USceneComponent >	The gizmo component we're dragging right now	ViewportInteractorData.h
DragOperationComponent	TWeakObjectPtr< class UViewportDragOperationComponent >	The gizmo interaction we're doing with this hand	ViewportInteractorData.h
DragRayLength	double	Length of the ray that's dragging	ViewportInteractorData.h
DragRayLengthVelocity	double	How fast to adjust ray length every frame for inertial ray length changes	ViewportInteractorData.h
DragTranslationVelocity	FVector	How fast to move selected objects every frame for inertial translation	ViewportInteractorData.h
Event	TEnumAsByte< EInputEvent >	Input event	ViewportInteractionTypes.h	BlueprintReadOnly Category=Action
GizmoCoordinateSpace	ECoordSystem		ViewportDragOperation.h
GizmoInterpolationSnapshotTransform	FTransform	A transform that we're interpolating from, toward the target transform.	ViewportInteractorData.h
GizmoLastTransform	FTransform		ViewportDragOperation.h
GizmoLastTransform	FTransform	Where the gizmo was last frame. This is used for interpolation and smooth snapping	ViewportInteractorData.h
GizmoRotationRadiansSinceDragStarted	float		ViewportInteractorData.h
GizmoScaleSinceDragStarted	float		ViewportInteractorData.h
GizmoSpaceDragDeltaFromStartOffset	FVector	When dragging with an axis/plane constraint applied, this is the difference between the actual "delta from start" and the constrained "delta from start".	ViewportInteractorData.h
GizmoSpaceFirstDragUpdateOffsetAlongAxis	FVector	For a single axis drag, this is the cached local offset where the laser pointer ray intersected the axis line on the first frame of the drag	ViewportInteractorData.h
GizmoStartLocalBounds	FBox	Our gizmo bounds at the start of the interaction, in actor local space.	ViewportInteractorData.h
GizmoStartLocalBounds	FBox		ViewportDragOperation.h
GizmoStartTransform	FTransform		ViewportDragOperation.h
GizmoStartTransform	FTransform	Transform gizmo interaction Where the gizmo was placed at the beginning of the current interaction	ViewportInteractorData.h
GizmoTargetTransform	FTransform	Where the gizmo wants to be right now, with snaps applied.	ViewportInteractorData.h
GizmoUnsnappedTargetTransform	FTransform	Where the gizmo wants to be right now, if no snaps were applied.	ViewportInteractorData.h
GrabberSphereLocationAtDragStart	FVector	Where the grabber sphere center point was when we first started the drag	ViewportInteractorData.h
HoverAlpha	float	Scalar that will advance toward 1.0 over time as we hover over the gizmo handle	VIGizmoHandle.h
HoverHapticCheckLastHoveredGizmoComponent	TWeakObjectPtr< class USceneComponent >	Gizmo handle that we hovered over last (used only for avoiding spamming of hover haptics!)	ViewportInteractorData.h
HoveringOverTransformGizmoComponent	TWeakObjectPtr< class USceneComponent >	Gizmo component that we're hovering over, or nullptr if not hovering over any	ViewportInteractorData.h
HoverLocation	TOptional< FVector >	Position the laser pointer impacted an interactive object at (UI, meshes, etc.)	ViewportInteractorData.h
ImpactLocationAtDragStart	FVector	Grabber sphere or laser pointer impact location at the drag start	ViewportInteractorData.h
InteractorTransformAtDragStart	FTransform	The transform of the interactor when we first started the drag	ViewportInteractorData.h
LaserPointerDirection	FVector		ViewportDragOperation.h
LaserPointerStart	FVector		ViewportDragOperation.h
LastDraggingMode	EViewportInteractionDraggingMode	What we were doing last. Used for inertial movement.	ViewportInteractorData.h
LastDragOperation	UViewportDragOperation *	The last drag operation.	ViewportInteractorData.h
LastDragToLocation	FVector	Location that we dragged to last frame (end point of the ray)	ViewportInteractorData.h
LastHoveredActorComponent	TWeakObjectPtr< class UActorComponent >	The current component hovered by the laser pointer of this hand	ViewportInteractorData.h
LastHoveredWidgetComponent	TWeakObjectPtr< UWidgetComponent >	Hover feedback The widget component we last hovered over.	ViewportInteractorData.h
LastHoverLocationOverUI	FVector	The last location that we hovered over UI at in the world.	ViewportInteractorData.h
LastRoomSpaceTransform	FTransform	Room space hand transform from the previous frame	ViewportInteractorData.h
LastTransform	FTransform	Hand transform in world space from the previous frame	ViewportInteractorData.h
LockedWorldDragMode	ELockedWorldDragMode		ViewportInteractorData.h
OptionalHandlePlacement	TOptional< FTransformGizmoHandlePlacement >	Which handle on the gizmo we're interacting with, if any	ViewportInteractorData.h
OptionalHandlePlacement	TOptional< FTransformGizmoHandlePlacement >		ViewportDragOperation.h
OtherHandDragDelta	FVector		ViewportDragOperation.h
OtherHandDragDeltaFromStart	FVector		ViewportDragOperation.h
OtherHandDraggedTo	FVector		ViewportDragOperation.h
OutGizmoUnsnappedTargetTransform	FTransform		ViewportDragOperation.h
OutUnsnappedDraggedTo	FVector		ViewportDragOperation.h
PassDraggedTo	FVector		ViewportDragOperation.h
PRAGMA_DISABLE_DEPRECATION_WARNINGS			ViewportWorldInteraction.h
PRAGMA_DISABLE_DEPRECATION_WARNINGS		Represents a generic action	ViewportInteractionTypes.h
PRAGMA_DISABLE_DEPRECATION_WARNINGS		Represents a single virtual hand	ViewportInteractorData.h
RoomSpaceTransform	FTransform	Your hand transform, in the local tracking space (unaffected by world scaling)	ViewportInteractorData.h
StartHitLocationToTransformableCenter	FVector	The offset between the hitlocation of the object selected to start dragging and its center.	ViewportInteractorData.h
WorldInteraction	UViewportWorldInteraction *	Data structure that holds all arguments that can be used while dragging a transformable.	ViewportDragOperation.h

Name	Remarks	Include Path
FViewportInteractorData()	Default constructor for FVirtualHand that initializes safe defaults	ViewportInteractorData.h
void GetCenterHandleCountAndFacingAxisIndex ( int32& OutCenterHandleCount, int32& OutFacingAxisIndex, int32& OutCenterAxisIndex ) const	Methods of dragging objects around in VR Directions that a transform handle can face along any given axis Placement of a handle in pivot space Finds the center handle count and facing axis index.	ViewportInteractionTypes.h
uint32 GetTypeHash ( const FViewportActionKeyInput& Input )		ViewportInteractionTypes.h
bool operator== ( const FViewportActionKeyInput& Other ) const		ViewportInteractionTypes.h

Name	Remarks	Include Path	Unreal Specifiers
static const FName Delete ( "Delete" )		ViewportWorldInteraction.h
static const FName Redo ( "Redo" )		ViewportWorldInteraction.h
static const FName SelectAndMove ( "SelectAndMove" )		ViewportWorldInteraction.h
static const FName SelectAndMove_FullyPressed ( "SelectAndMove_FullyPressed" )		ViewportWorldInteraction.h
static const FName Undo ( "Undo" )		ViewportWorldInteraction.h
static const FName WorldMovement ( "WorldMovement" )		ViewportWorldInteraction.h

Navigation

Classes

Interfaces

Variables

Public

Functions

Public

Static