XRTracker

Documentation

Overview

This object is the base of all XR trackers.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
  • func (self *Extension[T]) AsXRTracker() Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsXRTracker() Instance
  • func (self Instance) Description() string
  • func (self Instance) ID() ID
  • func (self Instance) Name() string
  • func (self Instance) SetDescription(value string)
  • func (self Instance) SetName(value string)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetType(value Type)
  • func (self Instance) Type() Type
  • func (self Instance) Virtual(name string) reflect.Value
• type Type

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsXRTracker() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsXRTracker

func (self *Extension[T]) AsXRTracker() Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.XRTracker

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsXRTracker

func (self Instance) AsXRTracker() Instance

func (Instance) Description

func (self Instance) Description() string

The description of this tracker.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Name

func (self Instance) Name() string

The unique name of this tracker. The trackers that are available differ between various XR runtimes and can often be configured by the user. Godot maintains a number of reserved names that it expects the XRInterface to implement if applicable:

- "head" identifies the XRPositionalTracker of the player's head

- "left_hand" identifies the XRControllerTracker in the player's left hand

- "right_hand" identifies the XRControllerTracker in the player's right hand

- "/user/hand_tracker/left" identifies the XRHandTracker for the player's left hand

- "/user/hand_tracker/right" identifies the XRHandTracker for the player's right hand

- "/user/body_tracker" identifies the XRBodyTracker for the player's body

- "/user/face_tracker" identifies the XRFaceTracker for the player's face

func (Instance) SetDescription

func (self Instance) SetDescription(value string)

SetDescription sets the property returned by [GetTrackerDesc].

func (Instance) SetName

func (self Instance) SetName(value string)

SetName sets the property returned by [GetTrackerName].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetType

func (self Instance) SetType(value Type)

SetType sets the property returned by [GetTrackerType].

func (Instance) Type

func (self Instance) Type() Type

The type of tracker.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Type

type Type int //gd:XRServer.TrackerType

const (
	// The tracker tracks the location of the player's head. This is usually a location centered between the player's eyes. Note that for handheld AR devices this can be the current location of the device.
	TrackerHead Type = 1
	// The tracker tracks the location of a controller.
	TrackerController Type = 2
	// The tracker tracks the location of a base station.
	TrackerBasestation Type = 4
	// The tracker tracks the location and size of an AR anchor.
	TrackerAnchor Type = 8
	// The tracker tracks the location and joints of a hand.
	TrackerHand Type = 16
	// The tracker tracks the location and joints of a body.
	TrackerBody Type = 32
	// The tracker tracks the expressions of a face.
	TrackerFace Type = 64
	// Used internally to filter trackers of any known type.
	TrackerAnyKnown Type = 127
	// Used internally if we haven't set the tracker type yet.
	TrackerUnknown Type = 128
	// Used internally to select all trackers.
	TrackerAny Type = 255
)