Struct rapier2d::geometry::ColliderBuilder

pub struct ColliderBuilder {
    pub shape: ColliderShape,
    pub friction: f32,
    pub restitution: f32,
    pub delta: Isometry<f32>,
    pub is_sensor: bool,
    pub user_data: u128,
    pub collision_groups: InteractionGroups,
    pub solver_groups: InteractionGroups,
    // some fields omitted
}

A structure responsible for building a new collider.

Fields

shape: ColliderShape

The shape of the collider to be built.

friction: f32

The friction coefficient of the collider to be built.

restitution: f32

The restitution coefficient of the collider to be built.

delta: Isometry<f32>

The position of this collider relative to the local frame of the rigid-body it is attached to.

is_sensor: bool

Is this collider a sensor?

user_data: u128

The user-data of the collider being built.

collision_groups: InteractionGroups

The collision groups for the collider being built.

solver_groups: InteractionGroups

The solver groups for the collider being built.

Implementations

impl ColliderBuilder

pub fn new(shape: ColliderShape) -> Self

Initialize a new collider builder with the given shape.

pub fn get_density(&self) -> f32

The density of the collider being built.

pub fn ball(radius: f32) -> Self

Initialize a new collider builder with a ball shape defined by its radius.

pub fn cuboid(hx: f32, hy: f32) -> Self

Initialize a new collider builder with a cuboid shape defined by its half-extents.

pub fn capsule_x(half_height: f32, radius: f32) -> Self

Initialize a new collider builder with a capsule shape aligned with the x axis.

pub fn capsule_y(half_height: f32, radius: f32) -> Self

Initialize a new collider builder with a capsule shape aligned with the y axis.

pub fn segment(a: Point<f32>, b: Point<f32>) -> Self

Initializes a collider builder with a segment shape.

pub fn triangle(a: Point<f32>, b: Point<f32>, c: Point<f32>) -> Self

Initializes a collider builder with a triangle shape.

pub fn trimesh(vertices: Vec<Point<f32>>, indices: Vec<Point3<u32>>) -> Self

Initializes a collider builder with a triangle mesh shape defined by its vertex and index buffers.

pub fn heightfield(heights: DVector<f32>, scale: Vector<f32>) -> Self

Initializes a collider builder with a heightfield shape defined by its set of height and a scale factor along each coordinate axis.

pub fn default_friction() -> f32

The default friction coefficient used by the collider builder.

pub fn user_data(self, data: u128) -> Self

Sets an arbitrary user-defined 128-bit integer associated to the colliders built by this builder.

pub fn collision_groups(self, groups: InteractionGroups) -> Self

Sets the collision groups used by this collider.

Two colliders will interact iff. their collision groups are compatible. See InteractionGroups::test for details.

pub fn solver_groups(self, groups: InteractionGroups) -> Self

Sets the solver groups used by this collider.

Forces between two colliders in contact will be computed iff their solver groups are compatible. See InteractionGroups::test for details.

pub fn sensor(self, is_sensor: bool) -> Self

Sets whether or not the collider built by this builder is a sensor.

pub fn friction(self, friction: f32) -> Self

Sets the friction coefficient of the collider this builder will build.

pub fn restitution(self, restitution: f32) -> Self

Sets the restitution coefficient of the collider this builder will build.

pub fn density(self, density: f32) -> Self

Sets the density of the collider this builder will build.

pub fn translation(self, x: f32, y: f32) -> Self

Sets the initial translation of the collider to be created, relative to the rigid-body it is attached to.

pub fn rotation(self, angle: AngVector<f32>) -> Self

Sets the initial orientation of the collider to be created, relative to the rigid-body it is attached to.

pub fn position(self, pos: Isometry<f32>) -> Self

Sets the initial position (translation and orientation) of the collider to be created, relative to the rigid-body it is attached to.

pub fn delta(self, delta: Isometry<f32>) -> Self

👎 Deprecated:

Use .position instead.

Set the position of this collider in the local-space of the rigid-body it is attached to.

pub fn build(&self) -> Collider

Builds a new collider attached to the given rigid-body.

Trait Implementations

impl Clone for ColliderBuilder

pub fn clone(&self) -> ColliderBuilder

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.