Struct ARVRServerSingleton
Server for AR and VR features.
struct ARVRServerSingleton
;
The AR/VR server is the heart of our Advanced and Virtual Reality solution and handles all the processing.
Properties
| Name | Type | Description |
primaryInterface[get, set]
|
ARVRInterface | The primary ARVRInterface currently bound to the ARVRServer.
|
worldScale[get, set]
|
double | Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter.
|
Methods
| Name | Description |
centerOnHmd
|
This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently.
For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world.
For platforms that do offer spatial tracking, our origin point depends very much on the system. For OpenVR, our origin point is usually the center of the tracking space, on the ground. For other platforms, it's often the location of the tracking camera.
This method allows you to center your tracker on the location of the HMD. It will take the current location of the HMD and use that to adjust all your tracking data; in essence, realigning the real world to your player's current position in the game world.
For this method to produce usable results, tracking information must be available. This often takes a few frames after starting your game.
You should call this method after a few seconds have passed. For instance, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, or when implementing a teleport mechanism.
|
findInterface
|
Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it.
|
getHmdTransform
|
Returns the primary interface's transformation.
|
getInterface
|
Returns the interface registered at a given index in our list of interfaces.
|
getInterfaceCount
|
Returns the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns true.
|
getInterfaces
|
Returns a list of available interfaces the ID and name of each interface.
|
getLastCommitUsec
|
Returns the absolute timestamp (in μs) of the last ARVRServer commit of the AR/VR eyes to VisualServer. The value comes from an internal call to OS.getTicksUsec.
|
getLastFrameUsec
|
Returns the duration (in μs) of the last frame. This is computed as the difference between getLastCommitUsec and getLastProcessUsec when committing.
|
getLastProcessUsec
|
Returns the absolute timestamp (in μs) of the last ARVRServer process callback. The value comes from an internal call to OS.getTicksUsec.
|
getPrimaryInterface
|
|
getReferenceFrame
|
Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces.
|
getTracker
|
Returns the positional tracker at the given ID.
|
getTrackerCount
|
Returns the number of trackers currently registered.
|
getWorldScale
|
|
setPrimaryInterface
|
|
setWorldScale
|
|