1. Epic GamesDeveloper
  3. FViewportInteractorData

FViewportInteractorData

Represents a single virtual hand

Unreal Engine C++ API Reference > Editor > ViewportInteraction

References

   
Module ViewportInteraction
Header /Engine/Source/Editor/ViewportInteraction/Public/ViewportInteractorData.h
Include #include "ViewportInteractorData.h"

Syntax

struct FViewportInteractorData

Remarks

Represents a single virtual hand

Variables

  Type Name Description
Public variable bool bDraggingWithGrabberSphere True if we're dragging using the grabber sphere, or false if we're using the laser (or world movement)
Public variable bool bHitResultIsPriorityType If the latest hitresult is hovering over a priority type
Public variable bool bIsDrivingVelocityOfSimulatedTransformables While dragging, true if we're dragging at least one simulated object that we're driving the velocities of.
Public variable bool bIsFirstDragUpdate True if this is the first update since we started dragging
Public variable bool bWasAssistingDrag True if we were assisting the other hand's drag the last time we did anything.
Public variable TWeakObjectPtr< UActorComponent > ClickingOnComponent General inputTrue if we're currently holding the 'SelectAndMove' button down after clicking on an actor
Public variable EViewportInteractionDraggingMode DraggingMode Object/world movementWhat we're currently dragging with this hand, if anything
Public variable TWeakObjectPtr< class USceneComponent > DraggingTransformGizmoComponent The gizmo component we're dragging right now
Public variable TWeakObjectPtr< class UViewportDragOperationComponent > DragOperationComponent The gizmo interaction we're doing with this hand
Public variable double DragRayLength Length of the ray that's dragging
Public variable double DragRayLengthVelocity How fast to adjust ray length every frame for inertial ray length changes
Public variable FVector DragTranslationVelocity How fast to move selected objects every frame for inertial translation
Public variable FTransform GizmoInterpolationSnapshotTransform A transform that we're interpolating from, toward the target transform.
Public variable FTransform GizmoLastTransform Where the gizmo was last frame. This is used for interpolation and smooth snapping
Public variable float GizmoRotationRadiansSinceDragStarted  
Public variable float GizmoScaleSinceDragStarted  
Public variable FVector GizmoSpaceDragDeltaFromStartOffset When dragging with an axis/plane constraint applied, this is the difference between the actual "delta from start" and the constrained "delta from start".
Public variable FVector GizmoSpaceFirstDragUpdateOffsetAlongAxis 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
Public variable FBox GizmoStartLocalBounds Our gizmo bounds at the start of the interaction, in actor local space.
Public variable FTransform GizmoStartTransform Transform gizmo interactionWhere the gizmo was placed at the beginning of the current interaction
Public variable FTransform GizmoTargetTransform Where the gizmo wants to be right now, with snaps applied.
Public variable FTransform GizmoUnsnappedTargetTransform Where the gizmo wants to be right now, if no snaps were applied.
Public variable FVector GrabberSphereLocationAtDragStart Where the grabber sphere center point was when we first started the drag
Public variable TWeakObjectPtr< class USceneComponent > HoverHapticCheckLastHoveredGizmoComponent Gizmo handle that we hovered over last (used only for avoiding spamming of hover haptics!)
Public variable TWeakObjectPtr< class USceneComponent > HoveringOverTransformGizmoComponent Gizmo component that we're hovering over, or nullptr if not hovering over any
Public variable TOptional< FVector > HoverLocation Position the laser pointer impacted an interactive object at (UI, meshes, etc.)
Public variable FVector ImpactLocationAtDragStart Grabber sphere or laser pointer impact location at the drag start
Public variable FTransform InteractorTransformAtDragStart The transform of the interactor when we first started the drag
Public variable EViewportInteractionDraggingMode LastDraggingMode What we were doing last. Used for inertial movement.
Public variable UViewportDragOperation * LastDragOperation The last drag operation.
Public variable FVector LastDragToLocation Location that we dragged to last frame (end point of the ray)
Public variable TWeakObjectPtr< class UActorComponent > LastHoveredActorComponent The current component hovered by the laser pointer of this hand
Public variable TWeakObjectPtr< UWidgetComponent > LastHoveredWidgetComponent Hover feedbackThe widget component we last hovered over.
Public variable FVector LastHoverLocationOverUI The last location that we hovered over UI at in the world.
Public variable FTransform LastRoomSpaceTransform Room space hand transform from the previous frame
Public variable FTransform LastTransform Hand transform in world space from the previous frame
Public variable ELockedWorldDragMode LockedWorldDragMode  
Public variable TOptional< FTransformGizmoHandlePlacement > OptionalHandlePlacement Which handle on the gizmo we're interacting with, if any
Public variable FTransform RoomSpaceTransform Your hand transform, in the local tracking space (unaffected by world scaling)
Public variable FVector StartHitLocationToTransformableCenter The offset between the hitlocation of the object selected to start dragging and its center.
Public variable FTransform Transform Positional dataYour hand (laser origin) in the virtual world in world space, usually driven by VR motion controllers

Constructors

  Type Name Description
Public function   Default constructor for FVirtualHand that initializes safe defaults

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page