Struct TrimeshBuilder

pub struct TrimeshBuilder {
    pub shape: SharedShape,
    pub position: Position,
    pub rotation: Rotation,
    pub fail_on_compound_error: bool,
    pub fallback_subdivisions: NonZeroU32,
    pub sphere_subdivisions: Option<(NonZeroU32, NonZeroU32)>,
    pub capsule_subdivision: Option<(NonZeroU32, NonZeroU32)>,
    pub cylinder_subdivisions: Option<NonZeroU32>,
    pub cone_subdivisions: Option<NonZeroU32>,
}

An ergonomic builder for triangle meshes from Colliders.

The builder can configure different subdivision levels for different shapes. If a shape was not explicitly configured, the builder will use Self::fallback_subdivisions.

Shapes with rounded corners such as Collider::round_cuboid will be subdivided as if they were not rounded.

Example

let collider = Collider::sphere(1.0);

// Using default settings
let trimesh = collider.trimesh_builder().build().unwrap();

// Using extra subdivisions
let trimesh = collider
    .trimesh_builder()
    .sphere_subdivisions(20, 20)
    .build()
    .unwrap();

// Setting different subdivisions for different shapes
let trimesh = collider
    .trimesh_builder()
    .sphere_subdivisions(20, 20)
    .capsule_subdivisions(10, 5)
    .fallback_subdivisions(15)
    .build()
    .unwrap();

// Generating the trimesh with a transformation
let trimesh = collider
    .trimesh_builder()
    .translated(Vector::new(1.0, 0.0, 0.0))
    .build()
    .unwrap();

Fields

shape: SharedShape

The shape to be converted into a triangle mesh.

position: Position

The position of the shape. The default is [0, 0, 0].

rotation: Rotation

The rotation of the shape. The default is the identity rotation.

fail_on_compound_error: bool

Whether a failure to trimesh a subshape in a compound shape should fail the entire build process. Default is true.

fallback_subdivisions: NonZeroU32

The number of subdivisions to use for shapes that do not have a specific subdivision count. Default is 16.

sphere_subdivisions: Option<(NonZeroU32, NonZeroU32)>

The number of subdivisions for shapes that derive from a sphere. Default is None.

capsule_subdivision: Option<(NonZeroU32, NonZeroU32)>

The number of subdivisions for shapes that derive from a capsule. Default is None.

cylinder_subdivisions: Option<NonZeroU32>

The number of subdivisions for shapes that derive from a cylinder. Default is None.

cone_subdivisions: Option<NonZeroU32>

The number of subdivisions for shapes that derive from a cone. Default is None.

Implementations

impl TrimeshBuilder

pub fn new(shape: SharedShape) -> Self

Creates a new TrimeshBuilder for the given shape. Usually you’ll want to call Collider::trimesh_builder instead.

pub fn translated(&mut self, position: impl Into<Position>) -> &mut Self

Translates the mesh. Subsequent calls to this method will add to the previous translation.

pub fn rotated(&mut self, rotation: impl Into<Rotation>) -> &mut Self

Rotates the mesh. Subsequent calls to this method will add to the previous rotation.

pub fn fallback_subdivisions( &mut self, subdivisions: impl TryInto<NonZeroU32>, ) -> &mut Self

Sets the fallback subdivision count for shapes that don’t have a specific subdivision count. Default is 16.

pub fn sphere_subdivisions( &mut self, theta: impl TryInto<NonZeroU32>, phi: impl TryInto<NonZeroU32>, ) -> &mut Self

Sets the subdivision count for sphere shapes. theta is the number of subdivisions along the latitude, and phi is the number of subdivisions along the longitude.

pub fn capsule_subdivisions( &mut self, theta: impl TryInto<NonZeroU32>, phi: impl TryInto<NonZeroU32>, ) -> &mut Self

Sets the subdivision count for capsule shapes. theta is the number of subdivisions along the latitude, and phi is the number of subdivisions along the longitude.

pub fn cylinder_subdivisions( &mut self, subdivisions: impl TryInto<NonZeroU32>, ) -> &mut Self

Sets the subdivision count for cylinder shapes.

pub fn cone_subdivisions( &mut self, subdivisions: impl TryInto<NonZeroU32>, ) -> &mut Self

Sets the subdivision count for cone shapes.

pub fn fail_on_compound_error( &mut self, fail_on_compound_error: bool, ) -> &mut Self

Whether a failure to trimesh a subshape in a compound shape should fail the entire build process. Default is true.

pub fn build(&self) -> Result<Trimesh, TrimeshBuilderError>

Builds the trimesh from the configured settings.

Returns an error if the shape is not supported. If the shape is a compound, errors in a subshape will either be ignored or fail the entire build process depending on the value of Self::fail_on_compound_error.

Trait Implementations

impl Clone for TrimeshBuilder

fn clone(&self) -> TrimeshBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrimeshBuilder

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

Formats the value using the given formatter.