Struct ColliderBuilder

pub struct ColliderBuilder {

    pub shape: SharedShape,
    pub mass_properties: ColliderMassProps,
    pub friction: f32,
    pub friction_combine_rule: CoefficientCombineRule,
    pub restitution: f32,
    pub restitution_combine_rule: CoefficientCombineRule,
    pub position: Isometry<f32>,
    pub is_sensor: bool,
    pub active_collision_types: ActiveCollisionTypes,
    pub active_hooks: ActiveHooks,
    pub active_events: ActiveEvents,
    pub user_data: u128,
    pub collision_groups: InteractionGroups,
    pub solver_groups: InteractionGroups,
    pub enabled: bool,
    pub contact_force_event_threshold: f32,
    pub contact_skin: f32,
}

A structure responsible for building a new collider.

Fields

shape: SharedShape

The shape of the collider to be built.

mass_properties: ColliderMassProps

Controls the way the collider’s mass-properties are computed.

friction: f32

The friction coefficient of the collider to be built.

friction_combine_rule: CoefficientCombineRule

The rule used to combine two friction coefficients.

restitution: f32

The restitution coefficient of the collider to be built.

restitution_combine_rule: CoefficientCombineRule

The rule used to combine two restitution coefficients.

position: Isometry<f32>

The position of this collider.

is_sensor: bool

Is this collider a sensor?

active_collision_types: ActiveCollisionTypes

Contact pairs enabled for this collider.

active_hooks: ActiveHooks

Physics hooks enabled for this collider.

active_events: ActiveEvents

Events enabled for this collider.

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.

enabled: bool

Will the collider being built be enabled?

contact_force_event_threshold: f32

The total force magnitude beyond which a contact force event can be emitted.

contact_skin: f32

An extra thickness around the collider shape to keep them further apart when colliding.

Implementations

impl ColliderBuilder

pub fn new(shape: SharedShape) -> Self

Initialize a new collider builder with the given shape.

pub fn compound(shapes: Vec<(Isometry<f32>, SharedShape)>) -> Self

Initialize a new collider builder with a compound shape.

pub fn ball(radius: f32) -> Self

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

pub fn halfspace(outward_normal: Unit<Vector<f32>>) -> Self

Initialize a new collider build with a half-space shape defined by the outward normal of its planar boundary.

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

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

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

Initialize a new collider builder with a round cuboid shape defined by its half-extents and border radius.

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

Initialize a new collider builder with a capsule defined from its endpoints.

See also ColliderBuilder::capsule_x, ColliderBuilder::capsule_y, (and ColliderBuilder::capsule_z in 3D only) for a simpler way to build capsules with common orientations.

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 round_triangle( a: Point<f32>, b: Point<f32>, c: Point<f32>, border_radius: f32, ) -> Self

Initializes a collider builder with a triangle shape with round corners.

pub fn polyline( vertices: Vec<Point<f32>>, indices: Option<Vec<[u32; 2]>>, ) -> Self

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

pub fn trimesh( vertices: Vec<Point<f32>>, indices: Vec<[u32; 3]>, ) -> Result<Self, TriMeshBuilderError>

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

pub fn trimesh_with_flags( vertices: Vec<Point<f32>>, indices: Vec<[u32; 3]>, flags: TriMeshFlags, ) -> Result<Self, TriMeshBuilderError>

Initializes a collider builder with a triangle mesh shape defined by its vertex and index buffers and flags controlling its pre-processing.

pub fn converted_trimesh( vertices: Vec<Point<f32>>, indices: Vec<[u32; 3]>, converter: MeshConverter, ) -> Result<Self, MeshConverterError>

Initializes a collider builder with a shape converted from the given triangle mesh index and vertex buffer.

All the conversion variants could be achieved with other constructors of ColliderBuilder but having this specified by an enum can occasionally be easier or more flexible (determined at runtime).

pub fn convex_decomposition( vertices: &[Point<f32>], indices: &[[u32; 2]], ) -> Self

Initializes a collider builder with a compound shape obtained from the decomposition of the given trimesh (in 3D) or polyline (in 2D) into convex parts.

pub fn round_convex_decomposition( vertices: &[Point<f32>], indices: &[[u32; 2]], border_radius: f32, ) -> Self

Initializes a collider builder with a compound shape obtained from the decomposition of the given trimesh (in 3D) or polyline (in 2D) into convex parts dilated with round corners.

pub fn convex_decomposition_with_params( vertices: &[Point<f32>], indices: &[[u32; 2]], params: &VHACDParameters, ) -> Self

Initializes a collider builder with a compound shape obtained from the decomposition of the given trimesh (in 3D) or polyline (in 2D) into convex parts.

pub fn round_convex_decomposition_with_params( vertices: &[Point<f32>], indices: &[[u32; 2]], params: &VHACDParameters, border_radius: f32, ) -> Self

Initializes a collider builder with a compound shape obtained from the decomposition of the given trimesh (in 3D) or polyline (in 2D) into convex parts dilated with round corners.

pub fn convex_hull(points: &[Point<f32>]) -> Option<Self>

Initializes a new collider builder with a 2D convex polygon or 3D convex polyhedron obtained after computing the convex-hull of the given points.

pub fn round_convex_hull( points: &[Point<f32>], border_radius: f32, ) -> Option<Self>

Initializes a new collider builder with a round 2D convex polygon or 3D convex polyhedron obtained after computing the convex-hull of the given points. The shape is dilated by a sphere of radius border_radius.

pub fn convex_polyline(points: Vec<Point<f32>>) -> Option<Self>

Creates a new collider builder that is a convex polygon formed by the given polyline assumed to be convex (no convex-hull will be automatically computed).

pub fn round_convex_polyline( points: Vec<Point<f32>>, border_radius: f32, ) -> Option<Self>

Creates a new collider builder that is a round convex polygon formed by the given polyline assumed to be convex (no convex-hull will be automatically computed). The polygon shape is dilated by a sphere of radius border_radius.

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 default_density() -> f32

The default density 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 active_hooks(self, active_hooks: ActiveHooks) -> Self

The set of physics hooks enabled for this collider.

pub fn active_events(self, active_events: ActiveEvents) -> Self

The set of events enabled for this collider.

pub fn active_collision_types( self, active_collision_types: ActiveCollisionTypes, ) -> Self

The set of active collision types for this collider.

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

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

pub fn friction_combine_rule(self, rule: CoefficientCombineRule) -> Self

Sets the rule to be used to combine two friction coefficients in a contact.

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

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

pub fn restitution_combine_rule(self, rule: CoefficientCombineRule) -> Self

Sets the rule to be used to combine two restitution coefficients in a contact.

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

Sets the uniform density of the collider this builder will build.

This will be overridden by a call to Self::mass or Self::mass_properties so it only makes sense to call either Self::density or Self::mass or Self::mass_properties.

The mass and angular inertia of this collider will be computed automatically based on its shape.

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

Sets the mass of the collider this builder will build.

This will be overridden by a call to Self::density or Self::mass_properties so it only makes sense to call either Self::density or Self::mass or Self::mass_properties.

The angular inertia of this collider will be computed automatically based on its shape and this mass value.

pub fn mass_properties(self, mass_properties: MassProperties) -> Self

Sets the mass properties of the collider this builder will build.

This will be overridden by a call to Self::density or Self::mass so it only makes sense to call either Self::density or Self::mass or Self::mass_properties.

pub fn contact_force_event_threshold(self, threshold: f32) -> Self

Sets the total force magnitude beyond which a contact force event can be emitted.

pub fn translation(self, translation: Vector<f32>) -> Self

Sets the initial translation of the collider to be created.

If the collider will be attached to a rigid-body, this sets the translation relative to the rigid-body it will be attached to.

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

Sets the initial orientation of the collider to be created.

If the collider will be attached to a rigid-body, this sets the orientation relative to the rigid-body it will be attached to.

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

Sets the initial position (translation and orientation) of the collider to be created.

If the collider will be attached to a rigid-body, this sets the position relative to the rigid-body it will be attached to.

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

👎Deprecated: Use .position instead.

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 contact_skin(self, skin_thickness: f32) -> Self

Sets the contact skin of the collider.

The contact skin acts as if the collider was enlarged with a skin of width skin_thickness around it, keeping objects further apart when colliding.

A non-zero contact skin can increase performance, and in some cases, stability. However it creates a small gap between colliding object (equal to the sum of their skin). If the skin is sufficiently small, this might not be visually significant or can be hidden by the rendering assets.

pub fn enabled(self, enabled: bool) -> Self

Enable or disable the collider after its creation.

pub fn build(&self) -> Collider

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

Trait Implementations

impl Clone for ColliderBuilder

fn clone(&self) -> ColliderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColliderBuilder

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

Formats the value using the given formatter.

impl Default for ColliderBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<ColliderBuilder> for Collider

fn from(val: ColliderBuilder) -> Collider

Converts to this type from the input type.