ARVRServerSingleton

Server for AR and VR features.

The AR/VR server is the heart of our Advanced and Virtual Reality solution and handles all the processing.

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

Constants
enum Constants
RotationMode
enum RotationMode
TrackerType
enum TrackerType

Functions

centerOnHmd
void centerOnHmd(long rotation_mode, bool keep_height)

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
Ref!ARVRInterface findInterface(String name)

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
Transform getHmdTransform()

Returns the primary interface's transformation.

getInterface
Ref!ARVRInterface getInterface(long idx)

Returns the interface registered at a given index in our list of interfaces.

getInterfaceCount
long 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
Array getInterfaces()

Returns a list of available interfaces the ID and name of each interface.

getLastCommitUsec
long 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
long getLastFrameUsec()

Returns the duration (in μs) of the last frame. This is computed as the difference between getLastCommitUsec and getLastProcessUsec when committing.

getLastProcessUsec
long getLastProcessUsec()

Returns the absolute timestamp (in μs) of the last ARVRServer process callback. The value comes from an internal call to OS.getTicksUsec.

getPrimaryInterface
Ref!ARVRInterface getPrimaryInterface()
getReferenceFrame
Transform getReferenceFrame()

Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces.

getTracker
ARVRPositionalTracker getTracker(long idx)

Returns the positional tracker at the given ID.

getTrackerCount
long getTrackerCount()

Returns the number of trackers currently registered.

getWorldScale
double getWorldScale()
opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(ARVRServerSingleton other)
opEquals
bool opEquals(typeof(null) n)
setPrimaryInterface
void setPrimaryInterface(ARVRInterface _interface)
setWorldScale
void setWorldScale(double arg0)
toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

primaryInterface
ARVRInterface primaryInterface [@property getter]
ARVRInterface primaryInterface [@property setter]

The primary ARVRInterface currently bound to the ARVRServer.

worldScale
double worldScale [@property getter]
double worldScale [@property setter]

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.

Static functions

_new
ARVRServerSingleton _new()

Construct a new instance of ARVRServerSingleton. Note: use memnew!ARVRServerSingleton instead.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

GDNativeClassBinding
struct GDNativeClassBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(To) as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
inout(ToRef) as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta