Struct gdnative::api::SoftBody

pub struct SoftBody { /* fields omitted */ }

core class SoftBody inherits MeshInstance (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.

SoftBody is a reference-only type. Persistent references can only exist in the unsafe Ref<SoftBody> 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

SoftBody inherits methods from:

• MeshInstance
• GeometryInstance
• VisualInstance
• 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 SoftBody

pub fn new() -> Ref<SoftBody, 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 add_collision_exception_with(&self, body: impl AsArg<Node>)

Adds a body to the list of bodies that this body can't collide with.

pub fn areaAngular_stiffness(&self) -> f64

pub fn get_collision_exceptions(&self) -> VariantArray<Shared>

Returns an array of nodes that were added as collision exceptions for this body.

pub fn collision_layer(&self) -> i64

The physics layers this SoftBody is in.
			Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.
			A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn get_collision_layer_bit(&self, bit: i64) -> bool

Returns an individual bit on the collision mask.

pub fn collision_mask(&self) -> i64

The physics layers this SoftBody scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn get_collision_mask_bit(&self, bit: i64) -> bool

Returns an individual bit on the collision mask.

pub fn damping_coefficient(&self) -> f64

pub fn drag_coefficient(&self) -> f64

pub fn linear_stiffness(&self) -> f64

pub fn parent_collision_ignore(&self) -> NodePath

[NodePath] to a [CollisionObject] this SoftBody should avoid clipping.

pub fn pose_matching_coefficient(&self) -> f64

pub fn pressure_coefficient(&self) -> f64

pub fn simulation_precision(&self) -> i64

Increasing this value will improve the resulting simulation, but can affect performance. Use with care.

pub fn total_mass(&self) -> f64

The SoftBody's mass.

pub fn volume_stiffness(&self) -> f64

pub fn is_ray_pickable(&self) -> bool

If [code]true[/code], the [SoftBody] will respond to [RayCast]s.

pub fn remove_collision_exception_with(&self, body: impl AsArg<Node>)

Removes a body from the list of bodies that this body can't collide with.

pub fn set_areaAngular_stiffness(&self, areaAngular_stiffness: f64)

pub fn set_collision_layer(&self, collision_layer: i64)

The physics layers this SoftBody is in.
			Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.
			A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn set_collision_layer_bit(&self, bit: i64, value: bool)

Sets individual bits on the layer mask. Use this if you only need to change one layer's value.

pub fn set_collision_mask(&self, collision_mask: i64)

The physics layers this SoftBody scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn set_collision_mask_bit(&self, bit: i64, value: bool)

Sets individual bits on the collision mask. Use this if you only need to change one layer's value.

pub fn set_damping_coefficient(&self, damping_coefficient: f64)

pub fn set_drag_coefficient(&self, drag_coefficient: f64)

pub fn set_linear_stiffness(&self, linear_stiffness: f64)

pub fn set_parent_collision_ignore(
    &self,
    parent_collision_ignore: impl Into<NodePath>
)

[NodePath] to a [CollisionObject] this SoftBody should avoid clipping.

pub fn set_pose_matching_coefficient(&self, pose_matching_coefficient: f64)

pub fn set_pressure_coefficient(&self, pressure_coefficient: f64)

pub fn set_ray_pickable(&self, ray_pickable: bool)

If [code]true[/code], the [SoftBody] will respond to [RayCast]s.

pub fn set_simulation_precision(&self, simulation_precision: i64)

Increasing this value will improve the resulting simulation, but can affect performance. Use with care.

pub fn set_total_mass(&self, mass: f64)

The SoftBody's mass.

pub fn set_volume_stiffness(&self, volume_stiffness: f64)

Methods from Deref<Target = MeshInstance>

pub fn create_convex_collision(&self)

This helper creates a [StaticBody] child node with a [ConvexPolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing.

pub fn create_debug_tangents(&self)

This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.

pub fn create_trimesh_collision(&self)

This helper creates a [StaticBody] child node with a [ConcavePolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing.

pub fn mesh(&self) -> Option<Ref<Mesh, Shared>>

The [Mesh] resource for the instance.

pub fn skeleton_path(&self) -> NodePath

[NodePath] to the [Skeleton] associated with the instance.

pub fn skin(&self) -> Option<Ref<Skin, Shared>>

Sets the skin to be used by this instance.

pub fn get_surface_material(
    &self,
    surface: i64
) -> Option<Ref<Material, Shared>>

Returns the [Material] for a surface of the [Mesh] resource.

pub fn get_surface_material_count(&self) -> i64

Returns the number of surface materials.

pub fn set_mesh(&self, mesh: impl AsArg<Mesh>)

The [Mesh] resource for the instance.

pub fn set_skeleton_path(&self, skeleton_path: impl Into<NodePath>)

[NodePath] to the [Skeleton] associated with the instance.

pub fn set_skin(&self, skin: impl AsArg<Skin>)

Sets the skin to be used by this instance.

pub fn set_surface_material(&self, surface: i64, material: impl AsArg<Material>)

Sets the [Material] for a surface of the [Mesh] resource.

Trait Implementations

impl Debug for SoftBody

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

Formats the value using the given formatter.

impl Deref for SoftBody

type Target = MeshInstance

The resulting type after dereferencing.

fn deref(&self) -> &MeshInstance

Dereferences the value.

impl DerefMut for SoftBody

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

Mutably dereferences the value.

impl GodotObject for SoftBody

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 SoftBody

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

impl QueueFree for SoftBody

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for SoftBody

impl SubClass<MeshInstance> for SoftBody

impl SubClass<Node> for SoftBody

impl SubClass<Object> for SoftBody

impl SubClass<Spatial> for SoftBody

impl SubClass<VisualInstance> for SoftBody