| UObjectBase
|
Module |
|
Header |
/Engine/Source/Editor/ViewportInteraction/Public/ViewportWorldInteraction.h |
Include |
#include "ViewportWorldInteraction.h" |
class UViewportWorldInteraction : public UEditorWorldExtension
Name | Description | ||
---|---|---|---|
|
bDraggedSinceLastSelection |
True if we've dragged objects with either hand since the last time we selected something |
|
|
LastDragGizmoStartTransform |
Gizmo start transform of the last drag we did with either hand. |
|
|
TrackingTransaction |
Undo/redoManages saving undo for selected actors while we're dragging them around |
Name | Description | |
---|---|---|
|
UViewportWorldInteraction() |
Name | Description | ||
---|---|---|---|
|
AddActorToExcludeFromHitTests ( |
Adds an actor to the list of actors to never allow an interactor to hit in the scene. |
|
|
AddInteractor ( |
Adds interactor to the worldinteraction |
|
|
AddMouseCursorInteractor() |
Creates an interactor for the mouse cursor. |
|
|
AllowWorldMovement ( |
The ability to move and scale the world |
|
|
ApplyVelocityDamping |
Given a world space velocity vector, applies inertial damping to it to slow it down |
|
|
AreAligningToActors() |
For other systems to check if the Viewport World Interaction system is currently aligning transformables to actors |
|
|
Copy() |
Copies selected objects to the clipboard |
|
|
CycleTransformGizmoCoordinateSpace() |
Switch which transform gizmo coordinate space we're using. |
|
|
DeleteSelectedObjects() |
Deletes all the selected objects |
|
|
Deselect() |
Deselects all the current selected objects |
|
|
Duplicate() |
Duplicates the selected objects |
|
|
FindPlacementPointUnderLaser ( |
Figures out where to place an object when tracing it against the scene using a laser pointer |
|
|
const TArray... |
GetActorsToExcludeFromHitTest() |
|
|
const UViewp... |
GetAssetContainer() |
Gets the container for all the assets of ViewportInteraction. |
|
GetColor ( |
Gets the color from color type |
|
|
float |
GetCurrentDeltaTime() |
Gets the current delta time, so functions that don't get the delta time passed can still get it |
|
EGizmoHandle... |
GetCurrentGizmoType() |
Gets the current Gizmo handle type |
|
FEditorViewp... |
GetDefaultOptionalViewportClient() |
Gets the currently used viewport |
|
GetHeadTransform() |
Gets the transform of the viewport / user's HMD in world space |
|
|
const TArray... |
GetInteractors() |
Gets all the interactors |
|
float |
GetMaxScale() |
Returns the maximum user scale |
|
float |
GetMinScale() |
Returns the minimum user scale |
|
GetMotionControllerID() |
Returns the Unreal controller ID for the motion controllers we're using |
|
|
GetRoomSpaceHeadTransform() |
Gets the transform of the viewport / user's HMD in room space |
|
|
GetRoomTransform() |
Gets the world space transform of the calibrated VR room origin. |
|
|
FTrackingTra... |
GetTrackingTransaction() |
Gets the tracking transactions |
|
GetTransformables() |
Gets a list of all of the objects we're currently interacting with, such as selected actors |
|
|
const UViewp... |
GetTransformer() |
|
|
ABaseTransfo... |
GetTransformGizmoActor() |
Gets the transform gizmo actor, or returns null if we currently don't have one |
|
GetTransformGizmoCoordinateSpace() |
Returns which transform gizmo coordinate space we're using, world or local |
|
|
float |
GetTransformGizmoScale() |
Returns the current transform gizmo scale |
|
float |
GetWorldScaleFactor() |
Gets the world scale factor, which can be multiplied by a scale vector to convert to room space |
|
HasCandidatesSelected() |
For other systems to check if the Viewport World Interaction system currently has candidate actors selected |
|
|
HaveHeadTransform() |
Returns true if we actually are using VR and have a valid head location, meaning a call to GetHeadTransform() is valid |
|
|
InitColors() |
Initialize colors |
|
|
IsInteractableComponent ( |
Checks to see if we're allowed to interact with the specified component |
|
|
IsInVR() |
Get if this world interaction is in VR. |
|
|
IsOtherInteractorHoveringOverComponent ( |
Check if there is another interactor hovering over the component |
|
|
IsTransformGizmoVisible() |
Returns whether the transform gizmo is actually visible right now. |
|
|
const UViewp... |
LoadAssetContainer() |
Static function to load the asset container |
|
FOnFinishedM... |
OnFinishedMovingTransformables() |
|
|
FOnHandleInp... |
OnHandleAxisInput() |
|
|
FOnHandleInp... |
OnHandleKeyInput() |
|
|
FOnViewportW... |
OnPostWorldInteractionTick() |
|
|
FOnPreviewIn... |
OnPreviewInputAction() |
|
|
FOnViewportW... |
OnPreWorldInteractionTick() |
|
|
FOnStartDrag... |
OnStartDragging() |
|
|
FOnStopDragg... |
OnStopDragging() |
|
|
FOnVIHoverUp... |
OnViewportInteractionHoverUpdate() |
|
|
FOnVIActionH... |
OnViewportInteractionInputAction() |
|
|
FOnViewportI... |
OnViewportInteractionInputUnhandled() |
|
|
FOnWorldScal... |
OnWorldScaleChanged() |
|
|
PairInteractors ( |
Pairs to interactors by setting the other interactor for each interactor |
|
|
Paste() |
Pastes the clipboard contents into the scene |
|
|
PlaySound ( |
Plays sound at location. |
|
|
PreprocessedInputAxis |
Handles the axis input from the Input Preprocessor |
|
|
PreprocessedInputKey ( |
Handles the key input from the Input Preprocessor |
|
|
Redo() |
Redoes the last change |
|
|
ReleaseMouseCursorInteractor() |
When you're finished with the mouse cursor interactor, call this to release it. |
|
|
RemoveInteractor ( |
Removes interactor from the worldinteraction and removes the interactor from its paired interactor if any |
|
|
SetDefaultOptionalViewportClient ( |
When using VR, this sets the viewport client that's been "possessed" by the head mounted display. |
|
|
SetDraggedInteractable ( |
Sets the currently dragged interactavle |
|
|
SetDraggedSinceLastSelection ( |
Sets if objects are dragged with either hand since last time selecting something |
|
|
SetForceCursor ( |
||
|
SetGizmoHandleType ( |
Sets the current gizmo handle type |
|
|
SetHeadTransform ( |
Sets a new transform for the room so that the HMD is aligned to the new transform. |
|
|
SetInVR ( |
Set if this world interaction is in VR. |
|
|
SetLastDragGizmoStartTransform ( |
Sets the transform of the gizmo when starting drag |
|
|
SetRoomTransform ( |
Sets a new transform for the room, in world space. |
|
|
SetRoomTransformForNextFrame ( |
||
|
SetSelectionAsCandidates() |
If there are no currently selected candidates, use the currently selected actors as candidates. |
|
|
SetShouldSuppressExistingCursor ( |
Getters and setters for whether or not to show the cursor on the viewport |
|
|
SetTransformables ( |
Sets the list of objects that this system will be responsible for transforming when interacting using the gizmo or directly on the objects |
|
|
SetTransformer ( |
Sets the system that should be used to transform objects in the scene. |
|
|
SetTransformGizmoClass ( |
Changes the transform gizmo class that it will change to next refresh |
|
|
SetTransformGizmoCoordinateSpace ( |
Sets which transform gizmo coordinate space is used |
|
|
SetTransformGizmoScale ( |
Sets how large the transform gizmo is |
|
|
SetTransformGizmoVisible ( |
Sets whether the transform gizmo should be visible at all |
|
|
SetUseInputPreprocessor ( |
Sets whether we should allow input events from the input preprocessor or not |
|
|
SetWorldToMetersScale ( |
Sets GNewWorldToMetersScale |
|
|
ShouldForceCursor() |
Getters and setters for whether or not to show the cursor on the viewport |
|
|
ShouldSuppressExistingCursor() |
Getters and setters for whether or not to show the cursor on the viewport |
|
|
ShouldTransformGizmoBeVisible() |
Returns whether the transform gizmo should be visible |
|
|
SkipInteractiveWorldMovementThisFrame() |
Tells the world interaction system to skip updates of world movement this frame. |
|
|
SnapLocation |
||
|
StartDragging ( |
Starts dragging selected objects around. |
|
|
StopDragging ( |
Called to finish a drag action with the specified interactor |
|
|
Undo() |
Invokes the editor's undo system to undo the last change |
|
|
UseLegacyInteractions() |
Forces the VWI to fall back to standard desktop interactions |
|
|
UseVWInteractions() |
Sets the VWI to use its own interactions |
Name | Description | ||
---|---|---|---|
|
EnteredSimulateInEditor() |
Give child class a chance to act on entering simulate mode |
|
|
Init() |
Initialize extension |
|
|
InputAxis ( |
||
|
InputKey ( |
Input |
|
|
LeftSimulateInEditor ( |
Give child class a chance to act on leaving simulate mode |
|
|
Shutdown() |
Shut down extension when world is destroyed |
|
|
Tick ( |
Give base class the chance to tick |
|
|
TransitionWorld ( |
Reparent actors to a new world |
Name |
Description |
|
---|---|---|
|
FOnFinishedMovingTransformables |
Gets the event for when the current set of transformables has finally stop moving (after a drag, and all inertial effects or snapping interpolation has completed |
|
FOnHandleInputAxis |
To handle raw axis input from the Input Preprocessor |
|
FOnHandleInputKey |
To handle raw key input from the Input Preprocessor |
|
FOnPreviewInputAction |
Gets the event for previewing input actions. |
|
FOnStartDragging |
Gets the event for when an interactor starts dragging |
|
FOnStopDragging |
Gets the event for when an interactor stops dragging |
|
FOnVIActionHandle |
Gets the event for input actions update which is broadcasted for each interactor |
|
FOnViewportInteractionInputUnhandled |
Called when the user clicks on 'nothing' to allow systems to deselect anything that's selected |
|
FOnViewportWorldInteractionTick |
|
|
FOnVIHoverUpdate |
Gets the event for hovering update which is broadcasted for each interactor |
|
FOnWorldScaleChanged |
Name |
Description |
|
---|---|---|
|
EColors |
Colors |
Name |
Description |
---|---|
AssetContainerPath |
The path of the asset container |