Existent Unreal Plugin
v0.0.1
v0.0.1
  • πŸ‘‹Welcome
  • Overview
    • πŸ’‘What we do
    • ✨Features
    • πŸ“•Glossary
    • 🐞Bug Reports & Feature Requests
    • ❓FAQ
    • πŸ—’οΈRelease Notes
      • Existent v0.0.1 Release Notes
  • Learning Existent
    • πŸ“˜High-Level Overview
    • πŸ› οΈHardware Setup
    • πŸ–₯️Getting Started
      • Installing Unreal Engine
      • Installing Existent Plugin
      • Setting Up a New Project
      • Creating your first Map
        • Duplicating the Starter Level
        • Creating and Configuring the Stage
      • Setting up Player Pawns & Animations
      • Running the Experience
    • 🎭Backstage Mode
    • πŸ“ΌSession recording & playback
    • πŸŒ‰RealityBridge
  • GUIDES
    • πŸ‘¨β€πŸ’ΌCustomising Player Avatar
      • Mappings
        • Hand Bone Mappings
        • Body Bone Mappings
        • Tracker Mappings
      • Animation Blueprint
      • Assign assets to Player
    • πŸͺAdding Tracked Objects
      • Using Vive Ultimate Trackers
      • Outside-in (Optitrack/Vicon) Setup
        • Aligning HMDs with outside-in systems
        • 3D-Print an Alignment Tool
      • Creating Digital Twins/Props
  • Resources
    • πŸ”¬Classes/Components
      • ExistentStage
      • ExistentSpace
      • ExistentVehicle
      • ExistentPlayer (Pawn)
      • ExistentPlayerAnimInstance
      • ExistentGameModeBase
      • ExistentTrackerComponent
      • ExistentGrabComponent
      • ExistentGripComponent
      • ExistentHandComponent
      • ExistentTrackingConfidenceComponent
      • ExistentAlignmentComponent
      • IExistentAlignmentSubject
      • ExistentDebugPanelComponent
      • ExistentUMGWindowComponent
    • πŸ“ƒExistent API
  • Tutorials & Examples
    • πŸ“šTutorials
Powered by GitBook
On this page
  • Overview
  • How to use
  • Additional Details
  1. Resources
  2. Classes/Components

ExistentStage

PreviousClasses/ComponentsNextExistentSpace

Last updated 1 year ago

Overview

The ExistentStage class helps create and manage a stage or play area. This class provides a framework for setting up a safe and immersive virtual space by defining the boundaries, incorporating obstacles, and implementing safety features to enhance player safety and immersion.

How to use

Right-click on your content browser and select Existent→Stage. This will create a new Existent Stage object. Open the newly created asset and define the Stage parameters according to your physical area. Then you can either set this as the default stage in project settings or set the stage parameter of each space you create if you want to take advantage of multiple stages in a single project.

The real world origin of your motion tracking system (whether that is Vive Trackers, Optitrack or Vicon) must correspond to the exact centre of the stage boundary you define here. Currently there’s no way to specify a different relationship between your tracking system origin and the stage boundary.

Additional Details

  • Stage Geometry: Supports both rectangular and circular stage shapes, enabling developers to tailor the virtual space to their application's specific requirements.

    • Shape Selection: Utilise the EExistentStageShape enum to select between rectangular or circular stage shapes.

    • Dimensions: Specify the size of a rectangular stage via the Dimensions property, using a FVector2D to represent width and length.

    • Radius: Define the size of a circular stage with the Radius property, determining the circular play area's radius.

  • Safety Features and Obstacles:

    • Min Safe Distance from Edge: The MinSafeDistanceFromEdge property establishes a safety buffer, activating visual warnings when players approach the stage boundary.

    • Obstacles: Incorporate static physical obstacles (e.g., pillars) within the stage using the Obstacles array. For each obstacle you can define its mesh, transform, and enable safety rendering features.

  • Visual Components:

    • Wall Meshes: Employ CubeWallMesh for rectangular stages and CylinderWallMesh for circular stages to visually denote boundaries.

    • Materials: Utilise distinct materials for stage boundaries (BoundaryMat) and obstacles (ObstacleMat) to visually distinguish these elements within the VR environment.

πŸ”¬