Struct gdnative::api::VehicleWheel

pub struct VehicleWheel { /* fields omitted */ }

core class VehicleWheel inherits Spatial (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

VehicleWheel is a reference-only type. Persistent references can only exist in the unsafe Ref<VehicleWheel> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

VehicleWheel inherits methods from:

• Spatial
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl VehicleWheel

pub fn new() -> Ref<VehicleWheel, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn brake(&self) -> f64

Slows down the wheel by applying a braking force. The wheel is only slowed down if it is in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking.

pub fn damping_compression(&self) -> f64

The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car.

pub fn damping_relaxation(&self) -> f64

The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5.

pub fn engine_force(&self) -> f64

Accelerates the wheel by applying an engine force. The wheel is only speed up if it is in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration.
			[b]Note:[/b] The simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears.
			A negative value will result in the wheel reversing.

pub fn friction_slip(&self) -> f64

This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear.
			It's best to set this to 1.0 when starting out.

pub fn radius(&self) -> f64

The radius of the wheel in meters.

pub fn roll_influence(&self) -> f64

This value affects the roll of your vehicle. If set to 1.0 for all wheels, your vehicle will be prone to rolling over, while a value of 0.0 will resist body roll.

pub fn get_rpm(&self) -> f64

Returns the rotational speed of the wheel in revolutions per minute.

pub fn get_skidinfo(&self) -> f64

Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road).

pub fn steering(&self) -> f64

The steering angle for the wheel. Setting this to a non-zero value will result in the vehicle turning when it's moving.

pub fn suspension_max_force(&self) -> f64

The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number.

pub fn suspension_rest_length(&self) -> f64

This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest.

pub fn suspension_stiffness(&self) -> f64

This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.

pub fn suspension_travel(&self) -> f64

This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car.

pub fn is_in_contact(&self) -> bool

Returns [code]true[/code] if this wheel is in contact with a surface.

pub fn is_used_as_steering(&self) -> bool

If [code]true[/code], this wheel will be turned when the car steers. This value is used in conjunction with [member VehicleBody.steering] and ignored if you are using the per-wheel [member steering] value instead.

pub fn is_used_as_traction(&self) -> bool

If [code]true[/code], this wheel transfers engine force to the ground to propel the vehicle forward. This value is used in conjunction with [member VehicleBody.engine_force] and ignored if you are using the per-wheel [member engine_force] value instead.

pub fn set_brake(&self, brake: f64)

Slows down the wheel by applying a braking force. The wheel is only slowed down if it is in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the [member RigidBody.mass] of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking.

pub fn set_damping_compression(&self, length: f64)

The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car.

pub fn set_damping_relaxation(&self, length: f64)

The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5.

pub fn set_engine_force(&self, engine_force: f64)

Accelerates the wheel by applying an engine force. The wheel is only speed up if it is in contact with a surface. The [member RigidBody.mass] of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration.
			[b]Note:[/b] The simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears.
			A negative value will result in the wheel reversing.

pub fn set_friction_slip(&self, length: f64)

This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear.
			It's best to set this to 1.0 when starting out.

pub fn set_radius(&self, length: f64)

The radius of the wheel in meters.

pub fn set_roll_influence(&self, roll_influence: f64)

This value affects the roll of your vehicle. If set to 1.0 for all wheels, your vehicle will be prone to rolling over, while a value of 0.0 will resist body roll.

pub fn set_steering(&self, steering: f64)

The steering angle for the wheel. Setting this to a non-zero value will result in the vehicle turning when it's moving.

pub fn set_suspension_max_force(&self, length: f64)

The maximum force the spring can resist. This value should be higher than a quarter of the [member RigidBody.mass] of the [VehicleBody] or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number.

pub fn set_suspension_rest_length(&self, length: f64)

This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest.

pub fn set_suspension_stiffness(&self, length: f64)

This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.

pub fn set_suspension_travel(&self, length: f64)

This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car.

pub fn set_use_as_steering(&self, enable: bool)

If [code]true[/code], this wheel will be turned when the car steers. This value is used in conjunction with [member VehicleBody.steering] and ignored if you are using the per-wheel [member steering] value instead.

pub fn set_use_as_traction(&self, enable: bool)

If [code]true[/code], this wheel transfers engine force to the ground to propel the vehicle forward. This value is used in conjunction with [member VehicleBody.engine_force] and ignored if you are using the per-wheel [member engine_force] value instead.

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub fn force_update_transform(&self)

Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.

pub fn gizmo(&self) -> Option<Ref<SpatialGizmo, Shared>>

The [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.

pub fn global_transform(&self) -> Transform

World space (global) [Transform] of this node.

pub fn get_parent_spatial(&self) -> Option<Ref<Spatial, Shared>>

Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial].

pub fn rotation(&self) -> Vector3D<f32, UnknownUnit>

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).
			[b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

pub fn rotation_degrees(&self) -> Vector3D<f32, UnknownUnit>

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

pub fn scale(&self) -> Vector3D<f32, UnknownUnit>

Scale part of the local transformation.

pub fn transform(&self) -> Transform

Local space [Transform] of this node, with respect to the parent node.

pub fn translation(&self) -> Vector3D<f32, UnknownUnit>

Local translation of this node.

pub fn get_world(&self) -> Option<Ref<World, Shared>>

Returns the current [World] resource this [Spatial] node is registered to.

pub fn global_rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system.

pub fn global_scale(&self, scale: Vector3D<f32, UnknownUnit>)

Scales the global (world) transformation by the given [Vector3] scale factors.

pub fn global_translate(&self, offset: Vector3D<f32, UnknownUnit>)

Moves the global (world) transformation by [Vector3] offset. The offset is in global coordinate system.

pub fn hide(&self)

Disables rendering of this node. Changes [member visible] to [code]false[/code].

pub fn is_local_transform_notification_enabled(&self) -> bool

Returns whether node notifies about its local transformation changes. [Spatial] will not propagate this by default.

pub fn is_scale_disabled(&self) -> bool

Returns whether this node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale.

pub fn is_set_as_toplevel(&self) -> bool

Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.

pub fn is_transform_notification_enabled(&self) -> bool

Returns whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default.

pub fn is_visible(&self) -> bool

If [code]true[/code], this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).

pub fn is_visible_in_tree(&self) -> bool

Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.

pub fn look_at(
    &self,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

Rotates itself so that the local -Z axis points towards the [code]target[/code] position.
				The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors.
				Operations take place in global space.

pub fn look_at_from_position(
    &self,
    position: Vector3D<f32, UnknownUnit>,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space.

pub fn orthonormalize(&self)

Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's [Transform].

pub fn rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians.

pub fn rotate_object_local(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system.

pub fn rotate_x(&self, angle: f64)

Rotates the local transformation around the X axis by angle in radians.

pub fn rotate_y(&self, angle: f64)

Rotates the local transformation around the Y axis by angle in radians.

pub fn rotate_z(&self, angle: f64)

Rotates the local transformation around the Z axis by angle in radians.

pub fn scale_object_local(&self, scale: Vector3D<f32, UnknownUnit>)

Scales the local transformation by given 3D scale factors in object-local coordinate system.

pub fn set_as_toplevel(&self, enable: bool)

Makes the node ignore its parents transformations. Node transformations are only in global space.

pub fn set_disable_scale(&self, disable: bool)

Sets whether the node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. Changes to the local transformation scale are preserved.

pub fn set_gizmo(&self, gizmo: impl AsArg<SpatialGizmo>)

The [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.

pub fn set_global_transform(&self, global: Transform)

World space (global) [Transform] of this node.

pub fn set_identity(&self)

Reset all transformations for this node (sets its [Transform] to the identity matrix).

pub fn set_ignore_transform_notification(&self, enabled: bool)

Sets whether the node ignores notification that its transformation (global or local) changed.

pub fn set_notify_local_transform(&self, enable: bool)

Sets whether the node notifies about its local transformation changes. [Spatial] will not propagate this by default.

pub fn set_notify_transform(&self, enable: bool)

Sets whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default.

pub fn set_rotation(&self, euler: Vector3D<f32, UnknownUnit>)

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).
			[b]Note:[/b] In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

pub fn set_rotation_degrees(&self, euler_degrees: Vector3D<f32, UnknownUnit>)

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

pub fn set_scale(&self, scale: Vector3D<f32, UnknownUnit>)

Scale part of the local transformation.

pub fn set_transform(&self, local: Transform)

Local space [Transform] of this node, with respect to the parent node.

pub fn set_translation(&self, translation: Vector3D<f32, UnknownUnit>)

Local translation of this node.

pub fn set_visible(&self, visible: bool)

If [code]true[/code], this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).

pub fn show(&self)

Enables rendering of this node. Changes [member visible] to [code]true[/code].

pub fn to_global(
    &self,
    local_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

Transforms [code]local_point[/code] from this node's local space to world space.

pub fn to_local(
    &self,
    global_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

Transforms [code]global_point[/code] from world space to this node's local space.

pub fn translate(&self, offset: Vector3D<f32, UnknownUnit>)

Changes the node's position by the given offset [Vector3].
				Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate.

pub fn translate_object_local(&self, offset: Vector3D<f32, UnknownUnit>)

Changes the node's position by the given offset [Vector3] in local space.

pub fn update_gizmo(&self)

Updates the [SpatialGizmo] of this node.

Trait Implementations

impl Debug for VehicleWheel

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

Formats the value using the given formatter.

impl Deref for VehicleWheel

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for VehicleWheel

fn deref_mut(&mut self) -> &mut Spatial

Mutably dereferences the value.

impl GodotObject for VehicleWheel

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for VehicleWheel

fn construct() -> Ref<VehicleWheel, Unique>

impl QueueFree for VehicleWheel

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Node> for VehicleWheel

impl SubClass<Object> for VehicleWheel

impl SubClass<Spatial> for VehicleWheel