Struct XrHandTracker
#[repr(C)]pub struct XrHandTracker { /* private fields */ }
Expand description
Godot class XRHandTracker.
Inherits XrPositionalTracker
.
Related symbols:
xr_hand_tracker
: sidecar module with related enum/flag typesIXrHandTracker
: virtual methods
See also Godot docs for XRHandTracker
.
§Construction
This class is reference-counted. You can create a new instance using XrHandTracker::new_gd()
.
Implementations§
§impl XrHandTracker
impl XrHandTracker
pub fn set_has_tracking_data(&mut self, has_data: bool)
pub fn get_has_tracking_data(&self) -> bool
pub fn set_hand_tracking_source(&mut self, source: HandTrackingSource)
pub fn get_hand_tracking_source(&self) -> HandTrackingSource
pub fn set_hand_joint_flags(&mut self, joint: HandJoint, flags: HandJointFlags)
pub fn get_hand_joint_flags(&self, joint: HandJoint) -> HandJointFlags
pub fn set_hand_joint_transform( &mut self, joint: HandJoint, transform: Transform3D, )
pub fn get_hand_joint_transform(&self, joint: HandJoint) -> Transform3D
pub fn set_hand_joint_radius(&mut self, joint: HandJoint, radius: f32)
pub fn get_hand_joint_radius(&self, joint: HandJoint) -> f32
pub fn set_hand_joint_linear_velocity( &mut self, joint: HandJoint, linear_velocity: Vector3, )
pub fn get_hand_joint_linear_velocity(&self, joint: HandJoint) -> Vector3
pub fn set_hand_joint_angular_velocity( &mut self, joint: HandJoint, angular_velocity: Vector3, )
pub fn get_hand_joint_angular_velocity(&self, joint: HandJoint) -> Vector3
Methods from Deref<Target = XrPositionalTracker>§
pub fn get_tracker_profile(&self) -> GString
pub fn set_tracker_profile(&mut self, profile: GString)
pub fn get_tracker_hand(&self) -> TrackerHand
pub fn set_tracker_hand(&mut self, hand: TrackerHand)
pub fn has_pose(&self, name: StringName) -> bool
pub fn get_pose(&self, name: StringName) -> Option<Gd<XrPose>>
pub fn invalidate_pose(&mut self, name: StringName)
pub fn set_pose( &mut self, name: StringName, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: TrackingConfidence, )
pub fn get_input(&self, name: StringName) -> Variant
pub fn set_input(&mut self, name: StringName, value: &Variant)
Methods from Deref<Target = XrTracker>§
pub fn get_tracker_type(&self) -> TrackerType
pub fn set_tracker_type(&mut self, type_: TrackerType)
pub fn get_tracker_name(&self) -> StringName
pub fn set_tracker_name(&mut self, name: StringName)
pub fn get_tracker_desc(&self) -> GString
pub fn set_tracker_desc(&mut self, description: GString)
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: GString) -> bool
pub fn set(&mut self, property: StringName, value: &Variant)
pub fn get(&self, property: StringName) -> Variant
pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)
pub fn get_indexed(&self, property_path: NodePath) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: StringName) -> bool
pub fn property_get_revert(&self, property: StringName) -> Variant
pub fn set_script(&mut self, script: &Variant)
pub fn get_script(&self) -> Variant
pub fn set_meta(&mut self, name: StringName, value: &Variant)
pub fn remove_meta(&mut self, name: StringName)
pub fn get_meta(&self, name: StringName) -> Variant
pub fn get_meta(&self, name: StringName) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>
pub fn has_meta(&self, name: StringName) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: GString)
pub fn add_user_signal(&mut self, signal: GString)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: StringName) -> bool
pub fn remove_user_signal(&mut self, signal: StringName)
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: StringName,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred(&mut self, property: StringName, value: &Variant)
pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: StringName) -> bool
pub fn get_method_argument_count(&self, method: StringName) -> i32
pub fn has_signal(&self, signal: StringName) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
To set the default parameters, use Self::connect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>
pub fn disconnect(&mut self, signal: StringName, callable: Callable)
pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: StringName) -> GString
pub fn tr(&self, message: StringName) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>
pub fn tr_n(
&self,
message: StringName,
plural_message: StringName,
n: i32,
) -> GString
pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for XrHandTracker
impl Bounds for XrHandTracker
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for XrHandTracker
impl Debug for XrHandTracker
§impl Deref for XrHandTracker
impl Deref for XrHandTracker
§type Target = XrPositionalTracker
type Target = XrPositionalTracker
§fn deref(&self) -> &<XrHandTracker as Deref>::Target
fn deref(&self) -> &<XrHandTracker as Deref>::Target
§impl DerefMut for XrHandTracker
impl DerefMut for XrHandTracker
§fn deref_mut(&mut self) -> &mut <XrHandTracker as Deref>::Target
fn deref_mut(&mut self) -> &mut <XrHandTracker as Deref>::Target
§impl GodotClass for XrHandTracker
impl GodotClass for XrHandTracker
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§type Base = XrPositionalTracker
type Base = XrPositionalTracker
T
. This is always a Godot engine class.