Navigation
API > API/Editor > API/Editor/VREditor
VR Editor teleport manager and the visual representation of the teleport
| Name | AVREditorTeleporter |
| Type | class |
| Header File | /Engine/Source/Editor/VREditor/Public/Teleporter/VREditorTeleporter.h |
| Include Path | #include "Teleporter/VREditorTeleporter.h" |
Syntax
UCLASS (Blueprintable, BlueprintType)
class AVREditorTeleporter : public AActor
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AVREditorTeleporter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AVREditorTeleporter() |
Default constructor that sets up CDO properties | Teleporter/VREditorTeleporter.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitialTeleportAim | bool | Is this the first time aiming for teleporting, we don't have to smooth movement for initial tick | Teleporter/VREditorTeleporter.h | |
| bPushedFromEndOfLaser | bool | If the teleporter has been pushed by the trackpad | Teleporter/VREditorTeleporter.h | |
| bShouldBeVisible | TOptional< bool > | If the teleporter should fade in | Teleporter/VREditorTeleporter.h | |
| DragRayLength | double | The current length of the laser where the teleport should be at | Teleporter/VREditorTeleporter.h | |
| DragRayLengthVelocity | double | The current drag velocity to push or pull the teleport along the laser | Teleporter/VREditorTeleporter.h | |
| FadeAlpha | float | Fade alpha, for visibility transitions | Teleporter/VREditorTeleporter.h | |
| HMDMeshComponent | TObjectPtr< UStaticMeshComponent > | Visuals for teleport HMD | Teleporter/VREditorTeleporter.h | |
| InteractorTryingTeleport | TObjectPtr< UViewportInteractor > | The interactor that started aiming to teleport | Teleporter/VREditorTeleporter.h | |
| LeftMotionControllerMeshComponent | TObjectPtr< UStaticMeshComponent > | Visuals for teleport left motion controller | Teleporter/VREditorTeleporter.h | |
| OffsetDistance | FVector | When offset between the hoverlocation of the laser and the calculated teleport | Teleporter/VREditorTeleporter.h | |
| RightMotionControllerMeshComponent | TObjectPtr< UStaticMeshComponent > | Visuals for teleport right motion controller | Teleporter/VREditorTeleporter.h | |
| TeleportDirectionMeshComponent | TObjectPtr< UStaticMeshComponent > | Visuals for the feet location of the teleporter with the same direction of the HMD yaw | Teleporter/VREditorTeleporter.h | |
| TeleportGoalLocation | FVector | The calculated goal location in StartTeleport to move the Roomspace to | Teleporter/VREditorTeleporter.h | |
| TeleportGoalScale | float | The goal world to meters scale. | Teleporter/VREditorTeleporter.h | |
| TeleportingState | EState | The current teleport state | Teleporter/VREditorTeleporter.h | |
| TeleportLerpAlpha | float | The current lerp of the teleport between the TeleportStartLocation and the TeleportGoalLocation | Teleporter/VREditorTeleporter.h | |
| TeleportMID | TObjectPtr< UMaterialInstanceDynamic > | Dynamic material for teleport visuals | Teleporter/VREditorTeleporter.h | |
| TeleportStartLocation | FVector | Set on the current Roomspace location in the world in StartTeleport before doing the actual teleporting | Teleporter/VREditorTeleporter.h | |
| TeleportTickDelay | uint32 | Delay to start the actual moving to the end location | Teleporter/VREditorTeleporter.h | |
| VRMode | TObjectPtr< UVREditorMode > | The owning VR mode | Teleporter/VREditorTeleporter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetSlideDelta
(
UVREditorInteractor* Interactor, |
Get slide delta to push/pull or scale the teleporter | Teleporter/VREditorTeleporter.h |
|
UVREditorMode * GetVRMode() |
Teleporter/VREditorTeleporter.h |
|
|
void Init
(
UVREditorMode* InMode |
Initializes the teleporter | Teleporter/VREditorTeleporter.h |
|
bool IsAiming() |
Whether we are currently aiming to teleport. | Teleporter/VREditorTeleporter.h |
|
bool IsTeleporting() |
Teleporter/VREditorTeleporter.h |
|
|
void SetColor
(
const FLinearColor& Color |
Sets the color for the teleporter visuals | Teleporter/VREditorTeleporter.h |
|
void SetVisibility
(
const bool bVisible |
Hide or show the teleporter visuals | Teleporter/VREditorTeleporter.h |
|
void Shutdown() |
Shuts down the teleporter | Teleporter/VREditorTeleporter.h |
|
void StartTeleport() |
Start teleporting, does a ray trace with the hand passed and calculates the locations for lerp movement in Teleport | Teleporter/VREditorTeleporter.h |
|
void TeleportDone() |
Called when teleport is done for cleanup | Teleporter/VREditorTeleporter.h |
|