Documentation
¶
Overview ¶
This node can be bound to a specific pose of an XRPositionalTracker and will automatically have its Node3D.Transform updated by the XRServer. Nodes of this type must be added as children of the XROrigin3D node.
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) AsXRNode3D() Instance
- func (self Instance) GetHasTrackingData() bool
- func (self Instance) GetIsActive() bool
- func (self Instance) GetPose() XRPose.Instance
- func (self Instance) ID() ID
- func (self Instance) OnTrackingChanged(cb func(tracking bool), flags ...Signal.Flags)
- func (self Instance) Pose() string
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPose(value string)
- func (self Instance) SetShowWhenTracked(value bool)
- func (self Instance) SetTracker(value string)
- func (self Instance) ShowWhenTracked() bool
- func (self Instance) Tracker() string
- func (self Instance) TriggerHapticPulse(action_name string, frequency Float.X, amplitude Float.X, duration_sec Float.X, ...)
- 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]) 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 ¶
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) AsXRNode3D ¶
func (Instance) GetHasTrackingData ¶
Returns true if the Tracker has current tracking data for the Pose being tracked.
func (Instance) GetIsActive ¶
Returns true if the Tracker has been registered and the Pose is being tracked.
func (Instance) GetPose ¶
Returns the XRPose containing the current state of the pose being tracked. This gives access to additional properties of this pose.
func (Instance) OnTrackingChanged ¶
Emitted when the Tracker starts or stops receiving updated tracking data for the Pose being tracked. The 'tracking' argument indicates whether the tracker is getting updated tracking data.
func (Instance) Pose ¶
The name of the pose we're bound to. Which poses a tracker supports is not known during design time.
Godot defines number of standard pose names such as aim and grip but other may be configured within a given XRInterface.
func (Instance) SetShowWhenTracked ¶
SetShowWhenTracked sets the property returned by [GetShowWhenTracked].
func (Instance) SetTracker ¶
SetTracker sets the property returned by [GetTracker].
func (Instance) ShowWhenTracked ¶
Enables showing the node when tracking starts, and hiding the node when tracking is lost.
func (Instance) Tracker ¶
The name of the tracker we're bound to. Which trackers are available is not known during design time.
Godot defines a number of standard trackers such as left_hand and right_hand but others may be configured within a given XRInterface.
func (Instance) TriggerHapticPulse ¶
func (self Instance) TriggerHapticPulse(action_name string, frequency Float.X, amplitude Float.X, duration_sec Float.X, delay_sec Float.X)
Triggers a haptic pulse on a device associated with this interface.
'action_name' is the name of the action for this pulse.
'frequency' is the frequency of the pulse, set to 0.0 to have the system use a default frequency.
'amplitude' is the amplitude of the pulse between 0.0 and 1.0.
'duration_sec' is the duration of the pulse in seconds.
'delay_sec' is a delay in seconds before the pulse is given.
Source Files