ARVRServerSingleton

This is our AR/VR Server.

The AR/VR Server is the heart of our AR/VR 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 a really 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 its often the location of the tracking camera. This method allows you to center our tracker on the location of the HMD, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world. For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game. You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.

findInterface
Ref!ARVRInterface findInterface(StringArg0 name)

Find an interface by its name. Say that you're making a game that uses specific 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)

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

getInterfaceCount
long getInterfaceCount()

Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look through the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.

getInterfaces
Array getInterfaces()

Returns a list of available interfaces with both id and name of the interface.

getLastCommitUsec
long getLastCommitUsec()
getLastFrameUsec
long getLastFrameUsec()
getLastProcessUsec
long getLastProcessUsec()
getPrimaryInterface
Ref!ARVRInterface getPrimaryInterface()
getReferenceFrame
Transform getReferenceFrame()

Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.

getTracker
ARVRPositionalTracker getTracker(long idx)

Get the positional tracker at the given ID.

getTrackerCount
long getTrackerCount()

Get the number of trackers currently registered.

getWorldScale
double getWorldScale()
opAssign
ARVRServerSingleton opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(ARVRServerSingleton other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
setPrimaryInterface
void setPrimaryInterface(ARVRInterface _interface)
setWorldScale
void setWorldScale(double arg0)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

primaryInterface
ARVRInterface primaryInterface [@property setter]
primaryInterface
ARVRInterface primaryInterface [@property getter]
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 meter in the real world.

Static functions

_new
ARVRServerSingleton _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
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
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
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