Struct OpenXrPlaneTracker 

pub struct OpenXrPlaneTracker { /* private fields */ }

Godot class OpenXRPlaneTracker.

Inherits OpenXrSpatialEntityTracker.

Related symbols:

• open_xr_plane_tracker: sidecar module with related enum/flag types
• IOpenXrPlaneTracker: virtual methods
• SignalsOfOpenXrPlaneTracker: signal collection

See also Godot docs for OpenXRPlaneTracker.

Construction

This class is reference-counted. You can create a new instance using OpenXrPlaneTracker::new_gd().

Implementations

impl OpenXrPlaneTracker

pub fn set_bounds_size(&mut self, bounds_size: Vector2)

pub fn get_bounds_size(&self) -> Vector2

pub fn set_plane_alignment(&mut self, plane_alignment: PlaneAlignment)

pub fn get_plane_alignment(&self) -> PlaneAlignment

pub fn set_plane_label(&mut self, plane_label: impl AsArg<GString>)

pub fn get_plane_label(&self) -> GString

pub fn set_mesh_data( &mut self, origin: Transform3D, vertices: &PackedArray<Vector2>, )

To set the default parameters, use Self::set_mesh_data_ex and its builder methods. See the book for detailed usage instructions.

pub fn set_mesh_data_ex<'ex>( &'ex mut self, origin: Transform3D, vertices: &'ex PackedArray<Vector2>, ) -> ExSetMeshData<'ex>

pub fn clear_mesh_data(&mut self)

pub fn get_mesh_offset(&self) -> Transform3D

pub fn get_mesh(&self) -> Option<Gd<Mesh>>

pub fn get_shape(&self) -> Option<Gd<Shape3D>>

To set the default parameters, use Self::get_shape_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_shape_ex<'ex>(&'ex self) -> ExGetShape<'ex>

Methods from Deref<Target = OpenXrSpatialEntityTracker>

pub fn set_entity(&mut self, entity: Rid)

pub fn get_entity(&self) -> Rid

pub fn set_spatial_tracking_state( &mut self, spatial_tracking_state: EntityTrackingState, )

pub fn get_spatial_tracking_state(&self) -> EntityTrackingState

Methods from Deref<Target = XrPositionalTracker>

pub fn get_tracker_profile(&self) -> GString

pub fn set_tracker_profile(&mut self, profile: impl AsArg<GString>)

pub fn get_tracker_hand(&self) -> TrackerHand

pub fn set_tracker_hand(&mut self, hand: TrackerHand)

pub fn has_pose(&self, name: impl AsArg<StringName>) -> bool

pub fn get_pose(&self, name: impl AsArg<StringName>) -> Option<Gd<XrPose>>

pub fn invalidate_pose(&mut self, name: impl AsArg<StringName>)

pub fn set_pose( &mut self, name: impl AsArg<StringName>, transform: Transform3D, linear_velocity: Vector3, angular_velocity: Vector3, tracking_confidence: TrackingConfidence, )

pub fn get_input(&self, name: impl AsArg<StringName>) -> Variant

pub fn set_input(&mut self, name: impl AsArg<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: impl AsArg<StringName>)

pub fn get_tracker_desc(&self) -> GString

pub fn set_tracker_desc(&mut self, description: impl AsArg<GString>)

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<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<'ex>( &'ex self, name: impl AsArg<StringName> + 'ex, ) -> ExGetMeta<'ex>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<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<'ex>( &'ex mut self, signal: impl AsArg<GString> + 'ex, ) -> ExAddUserSignal<'ex>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &AnyArray, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary<Variant, Variant>>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary<Variant, Variant>>

pub fn get_incoming_connections(&self) -> Array<Dictionary<Variant, Variant>>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> 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: impl AsArg<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<'ex>(&'ex self, message: impl AsArg<StringName> + 'ex) -> ExTr<'ex>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<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<'ex>( &'ex self, message: impl AsArg<StringName> + 'ex, plural_message: impl AsArg<StringName> + 'ex, n: i32, ) -> ExTrN<'ex>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

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)

⚠️ 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 OpenXrPlaneTracker

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for OpenXrPlaneTracker

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for OpenXrPlaneTracker

type Target = OpenXrSpatialEntityTracker

The resulting type after dereferencing.

fn deref(&self) -> &<OpenXrPlaneTracker as Deref>::Target

Dereferences the value.

impl DerefMut for OpenXrPlaneTracker

fn deref_mut(&mut self) -> &mut <OpenXrPlaneTracker as Deref>::Target

Mutably dereferences the value.

impl GodotClass for OpenXrPlaneTracker

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = OpenXrSpatialEntityTracker

The immediate superclass of T. This is always a Godot engine class.

fn class_id() -> ClassId

Globally unique class ID, linked to the name under which the class is registered in Godot.

fn inherits<Base>() -> bool

where Base: GodotClass,

Returns whether Self inherits from Base.

impl Inherits<Object> for OpenXrPlaneTracker

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<OpenXrSpatialEntityTracker> for OpenXrPlaneTracker

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<RefCounted> for OpenXrPlaneTracker

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<XrPositionalTracker> for OpenXrPlaneTracker

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<XrTracker> for OpenXrPlaneTracker

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl WithSignals for OpenXrPlaneTracker

type SignalCollection<'c, C: WithSignals> = SignalsOfOpenXrPlaneTracker<'c, C>

The associated struct listing all signals of this class.

impl GodotDefault for OpenXrPlaneTracker