Documentation
¶
Overview ¶
This is a helper 3D node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers.
Controllers are linked by their ID. You can create controller nodes before the controllers are available. If your game always uses two controllers (one for each hand), you can predefine the controllers with ID 1 and 2; they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add XRController3D nodes to your scene.
The position of the controller node is automatically updated by the XRServer. This makes this node ideal to add child nodes to visualize the controller.
The current XRInterface defines the names of inputs. In the case of OpenXR, these are the names of actions in the current action set from the OpenXR action map.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsXRController3D() Instance
- func (self Instance) AsXRNode3D() XRNode3D.Instance
- func (self Instance) GetFloat(name string) Float.X
- func (self Instance) GetInput(name string) any
- func (self Instance) GetTrackerHand() XRPositionalTracker.TrackerHand
- func (self Instance) GetVector2(name string) Vector2.XY
- func (self Instance) ID() ID
- func (self Instance) IsButtonPressed(name string) bool
- func (self Instance) OnButtonPressed(cb func(name string), flags ...Signal.Flags)
- func (self Instance) OnButtonReleased(cb func(name string), flags ...Signal.Flags)
- func (self Instance) OnInputFloatChanged(cb func(name string, value Float.X), flags ...Signal.Flags)
- func (self Instance) OnInputVector2Changed(cb func(name string, value Vector2.XY), flags ...Signal.Flags)
- func (self Instance) OnProfileChanged(cb func(role string), flags ...Signal.Flags)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
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]) AsXRController3D ¶
func (*Extension[T]) AsXRNode3D ¶
type 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.
type Instance ¶
type Instance [1]gdclass.XRController3D
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 (Instance) AsXRController3D ¶
func (Instance) AsXRNode3D ¶
func (Instance) GetFloat ¶
Returns a numeric value for the input with the given 'name'. This is used for triggers and grip sensors.
Note: The current XRInterface defines the 'name' for each input. In the case of OpenXR, these are the names of actions in the current action set.
func (Instance) GetInput ¶
Returns a any for the input with the given 'name'. This works for any input type, the variant will be typed according to the actions configuration.
Note: The current XRInterface defines the 'name' for each input. In the case of OpenXR, these are the names of actions in the current action set.
func (Instance) GetTrackerHand ¶
func (self Instance) GetTrackerHand() XRPositionalTracker.TrackerHand
Returns the hand holding this controller, if known.
func (Instance) GetVector2 ¶
Returns a Vector2.XY for the input with the given 'name'. This is used for thumbsticks and thumbpads found on many controllers.
Note: The current XRInterface defines the 'name' for each input. In the case of OpenXR, these are the names of actions in the current action set.
func (Instance) IsButtonPressed ¶
Returns true if the button with the given 'name' is pressed.
Note: The current XRInterface defines the 'name' for each input. In the case of OpenXR, these are the names of actions in the current action set.
Source Files