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, Unit<Complex<f32>>, 2>,
    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 contact_force_event_threshold: 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, Unit<Complex<f32>>, 2>

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.

contact_force_event_threshold: f32

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

Implementations

impl ColliderBuilder

pub fn new(shape: SharedShape) -> ColliderBuilder

Initialize a new collider builder with the given shape.

pub fn compound( shapes: Vec<(Isometry<f32, Unit<Complex<f32>>, 2>, SharedShape)>, ) -> ColliderBuilder

Initialize a new collider builder with a compound shape.

pub fn ball(radius: f32) -> ColliderBuilder

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

pub fn halfspace( outward_normal: Unit<Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>>, ) -> ColliderBuilder

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) -> ColliderBuilder

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) -> ColliderBuilder

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

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

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

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

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

pub fn segment( a: OPoint<f32, Const<2>>, b: OPoint<f32, Const<2>>, ) -> ColliderBuilder

Initializes a collider builder with a segment shape.

pub fn triangle( a: OPoint<f32, Const<2>>, b: OPoint<f32, Const<2>>, c: OPoint<f32, Const<2>>, ) -> ColliderBuilder

Initializes a collider builder with a triangle shape.

pub fn round_triangle( a: OPoint<f32, Const<2>>, b: OPoint<f32, Const<2>>, c: OPoint<f32, Const<2>>, border_radius: f32, ) -> ColliderBuilder

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

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

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

pub fn trimesh( vertices: Vec<OPoint<f32, Const<2>>>, indices: Vec<[u32; 3]>, ) -> ColliderBuilder

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

pub fn convex_decomposition( vertices: &[OPoint<f32, Const<2>>], indices: &[[u32; 2]], ) -> ColliderBuilder

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: &[OPoint<f32, Const<2>>], indices: &[[u32; 2]], border_radius: f32, ) -> ColliderBuilder

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: &[OPoint<f32, Const<2>>], indices: &[[u32; 2]], params: &VHACDParameters, ) -> ColliderBuilder

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: &[OPoint<f32, Const<2>>], indices: &[[u32; 2]], params: &VHACDParameters, border_radius: f32, ) -> ColliderBuilder

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: &[OPoint<f32, Const<2>>]) -> Option<ColliderBuilder>

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: &[OPoint<f32, Const<2>>], border_radius: f32, ) -> Option<ColliderBuilder>

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<OPoint<f32, Const<2>>>, ) -> Option<ColliderBuilder>

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<OPoint<f32, Const<2>>>, border_radius: f32, ) -> Option<ColliderBuilder>

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: Matrix<f32, Dynamic, Const<1>, VecStorage<f32, Dynamic, Const<1>>>, scale: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> ColliderBuilder

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) -> ColliderBuilder

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

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

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) -> ColliderBuilder

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) -> ColliderBuilder

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

pub fn active_hooks(self, active_hooks: ActiveHooks) -> ColliderBuilder

The set of physics hooks enabled for this collider.

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

The set of events enabled for this collider.

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

The set of active collision types for this collider.

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

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

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

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

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

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

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

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

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

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) -> ColliderBuilder

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) -> ColliderBuilder

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) -> ColliderBuilder

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

pub fn translation( self, translation: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>, ) -> ColliderBuilder

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: f32) -> ColliderBuilder

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, Unit<Complex<f32>>, 2>, ) -> ColliderBuilder

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, Unit<Complex<f32>>, 2>, ) -> ColliderBuilder

👎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, Unit<Complex<f32>>, 2>, ) -> ColliderBuilder

👎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

fn clone(&self) -> ColliderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Into<Collider> for ColliderBuilder

fn into(self) -> Collider

Converts this type into the (usually inferred) input type.