| UObjectBase
|
Module |
|
Header |
/Engine/Source/Editor/ViewportInteraction/Public/ViewportInteractor.h |
Include |
#include "ViewportInteractor.h" |
class UViewportInteractor : public UObject
Represents the interactor in the world
Name | Description | ||
---|---|---|---|
|
bAllowGrabberSphere |
True if this interactor supports 'grabber sphere' interaction. Usually disabled for mouse cursors |
|
|
bCanCarry |
True if this interactor can 'carry' objects in VR, that is, translation and rotation of the interactor is inherited by the object, instead of just translation |
|
|
FViewportIntera... |
InteractorData |
All the private data for the interactor |
|
KeyToActionMap |
Mapping of raw keys to actions |
|
|
OtherInteractor |
The paired interactor by the world interaction |
|
|
SavedHitResult |
Store the last hitresult from the laser, to use that when calling GetHitResultFromLaserPointer multiple times in a tick. |
|
|
SavedHitResultFilterMode |
Store the last hitresult from the laser, to use that when calling GetHitResultFromLaserPointer multiple times in a tick. |
|
|
SavedLaserPointerEnd |
Store end of the laser pointer. |
|
|
WorldInteraction |
The owning world interaction |
Name | Description | |
---|---|---|
|
UViewportInteractor() |
Default constructor |
Name | Description | ||
---|---|---|---|
|
AddKeyAction ( |
Adds a new action to the KeyToActionMap |
|
|
AllowLaserSmoothing() |
If this interactors allows to smooth the laser. Default is true. |
|
|
CalculateDragRay ( |
Needs to be implemented by the base to calculate drag ray length and the velocity for the ray |
|
|
CanCarry() |
Gets if the interactor can carry an object |
|
|
FViewportAct... |
GetActionWithName ( |
Gets a certain action by iterating through the map looking for the same ActionType |
|
EViewportInt... |
GetDraggingMode() |
Gets the current interactor data dragging mode |
|
float |
GetDragHapticFeedbackStrength() |
Gets the drag haptic feedback strength console variable |
|
GetDragTranslationVelocity() |
Gets the interactor data drag velocity |
|
|
GetGrabberSphere |
Gets a sphere on this interactor that can be used to interact with objects in close proximity |
|
|
GetHitResultFromLaserPointer |
Traces along the laser pointer vector and returns what it first hits in the world |
|
|
EHitResultGi... |
GetHitResultGizmoFilterMode() |
Gets current gizmo filter mode used for Interaction |
|
GetHoverLocation() |
Gets the interactor laser hover location |
|
|
FViewportInt... |
GetInteractorData() |
Gets the private data for this interactor |
|
const FViewp... |
GetInteractorData() |
Gets the private data for this interactor (const) |
|
GetIsLaserBlocked() |
To be overridden by base class. |
|
|
GetLaserPointer |
Gets the start and end point of the laser pointer for the specified hand |
|
|
float |
GetLaserPointerMaxLength() |
Gets the maximum length of a laser pointer |
|
EViewportInt... |
GetLastDraggingMode() |
Gets the interactor data previous dragging mode |
|
UActorCompon... |
GetLastHoverComponent() |
Gets the last component hovered on by the interactor laser. |
|
GetLastRoomSpaceTransform() |
Gets the last hand transform of the interactor, in the local tracking space |
|
|
GetLastTransform() |
Gets the last world transform of this interactor |
|
|
UViewportInt... |
GetOtherInteractor() |
Gets the paired interactor assigned by the world interaction, can return null when there is no other interactor |
|
GetRoomSpaceTransform() |
Gets the hand transform of the interactor, in the local tracking space |
|
|
GetTransform() |
Gets the world transform of this interactor |
|
|
GetTransformAndForwardVector ( |
Creates a hand transform and forward vector for a laser pointer for a given hand |
|
|
UViewportWor... |
GetWorldInteraction() |
Gets the world interaction |
|
HandleInputAxis ( |
To be overridden. Called by HandleInputAxis before delegates and default input implementation |
|
|
HandleInputAxis ( |
Handles axis input and translates it to actions C++ Child classes are expected to to call there super versions of this. |
|
|
HandleInputAxis_BP ( |
To be overridden. Called by HandleInputAxis before delegates and default input implementation |
|
|
HandleInputKey ( |
To be overridden. Called by HandleInputKey before delegates and default input implementation |
|
|
HandleInputKey ( |
Handles key input and translates it actions C++ Child classes are expected to to call there super versions of this. |
|
|
HandleInputKey_BP ( |
To be overridden. Called by HandleInputKey before delegates and default input implementation |
|
|
IsHovering() |
If the interactor laser is currently hovering |
|
|
IsHoveringOverGizmo() |
If the interactor laser is currently hovering over a gizmo handle |
|
|
IsHoveringOverPriorityType() |
If this interactor is hovering over a type that has priority from GetHitResultFromLaserPointer |
|
|
IsHoveringOverSelectedActor() |
Returns true if currently hovering over selected actor |
|
|
IsModifierPressed() |
||
|
OnStartDragging |
Called by StartDragging in world interaction to give the interactor a chance of acting upon starting a drag operation |
|
|
PlayHapticEffect ( |
Triggers a force feedback effect on device if possible |
|
|
PollInput() |
Base classes need to implement getting the input for the input devices for that interactor |
|
|
PreviewInputAxis ( |
To be overridden. Called by HandleInputAxis before delegates and default input implementation |
|
|
PreviewInputKey ( |
To be overridden. Called by HandleInputKey before delegates and default input implementation |
|
|
RemoveKeyAction ( |
Removes an action from the KeyToActionMap |
|
|
RemoveOtherInteractor() |
Removes the other interactor reference for this interactor |
|
|
ResetHoverState() |
Reset the values before checking the hover actions |
|
|
ResetLaserEnd() |
Reset the stored laser end location at the end of tick |
|
|
SetCanCarry ( |
Sets if the interactor can carry an object |
|
|
SetDraggingMode ( |
Sets the current dragging mode for this interactor |
|
|
SetHitResultGizmoFilterMode ( |
Sets the current gizmo filter mode used for Interaction |
|
|
SetHoverLocation ( |
Sets the hover location |
|
|
SetOtherInteractor ( |
Sets the other interactor |
|
|
SetWorldInteraction ( |
Sets the world interaction |
|
|
Shutdown() |
Whenever the ViewportWorldInteraction is shut down, the interacts will shut down as well |
|
|
Tick ( |
Update for this interactor called by the ViewportWorldInteraction |
Name | Description | ||
---|---|---|---|
|
GetHitResultFromLaserPointer |
bool bIgnoreGizmos replaced with EHitResultGizmoFilterMode GizmoFilterMode |