Struct parry3d::shape::HeightField

source ·
#[repr(C)]
pub struct HeightField { /* private fields */ }
Expand description

A 3D heightfield.

Implementations§

source§

impl HeightField

source

pub fn aabb(&self, pos: &Isometry<Real>) -> Aabb

Computes the world-space Aabb of this heightfield, transformed by pos.

source

pub fn local_aabb(&self) -> Aabb

Computes the local-space Aabb of this heightfield.

source§

impl HeightField

source

pub fn bounding_sphere(&self, pos: &Isometry<Real>) -> BoundingSphere

Computes the world-space bounding sphere of this height-field, transformed by pos.

source

pub fn local_bounding_sphere(&self) -> BoundingSphere

Computes the local-space bounding sphere of this height-field.

source§

impl HeightField

source

pub fn new(heights: DMatrix<Real>, scale: Vector<Real>) -> Self

Initializes a new heightfield with the given heights, scaling factor, and flags.

source

pub fn with_flags( heights: DMatrix<Real>, scale: Vector<Real>, flags: HeightFieldFlags ) -> Self

Initializes a new heightfield with the given heights and a scaling factor.

source§

impl HeightField

source

pub fn nrows(&self) -> usize

The number of rows of this heightfield.

source

pub fn ncols(&self) -> usize

The number of columns of this heightfield.

source

pub fn closest_cell_at_point(&self, pt: &Point3<Real>) -> (usize, usize)

The pair of index of the cell containing the vertical projection of the given point.

source

pub fn cell_at_point(&self, pt: &Point3<Real>) -> Option<(usize, usize)>

The pair of index of the cell containing the vertical projection of the given point.

source

pub fn unclamped_cell_at_point(&self, pt: &Point3<Real>) -> (isize, isize)

The pair of index of the cell containing the vertical projection of the given point.

source

pub fn x_at(&self, j: usize) -> Real

The smallest x coordinate of the j-th column of this heightfield.

source

pub fn z_at(&self, i: usize) -> Real

The smallest z coordinate of the start of the i-th row of this heightfield.

source

pub fn signed_x_at(&self, j: isize) -> Real

The smallest x coordinate of the j-th column of this heightfield.

source

pub fn signed_z_at(&self, i: isize) -> Real

The smallest z coordinate of the start of the i-th row of this heightfield.

source

pub fn triangles(&self) -> impl Iterator<Item = Triangle> + '_

An iterator through all the triangles of this heightfield.

source

pub fn triangles_around_point( &self, point: &Point3<Real> ) -> HeightFieldRadialTriangles<'_>

An iterator through all the triangles around the given point, after vertical projection on the heightfield.

source

pub fn triangle_at_id(&self, id: u32) -> Option<Triangle>

Gets the vertices of the triangle identified by id.

source

pub fn triangle_vids_at_id(&self, id: u32) -> Option<[u32; 3]>

Gets the vertex indices of the triangle identified by id.

source

pub fn triangles_vids_at( &self, i: usize, j: usize ) -> (Option<[u32; 3]>, Option<[u32; 3]>)

Gets the indices of the vertices of the (up to) two triangles for the cell (i, j).

source

pub fn triangles_at( &self, i: usize, j: usize ) -> (Option<Triangle>, Option<Triangle>)

The two triangles at the cell (i, j) of this heightfield.

Returns None fore triangles that have been removed because of their user-defined status flags (described by the HeightFieldCellStatus bitfield).

source

pub fn triangle_normal_constraints( &self, id: u32 ) -> Option<TrianglePseudoNormals>

Computes the pseudo-normals of the triangle identified by the given id.

Returns None if the heightfield’s [HeightfieldFlags::FIX_INTERNAL_EDGES] isn’t set, or if the triangle doesn’t exist due to it being removed by its status flag (HeightFieldCellStatus::LEFT_TRIANGLE_REMOVED or HeightFieldCellStatus::RIGHT_TRIANGLE_REMOVED).

source

pub fn num_cells_ij(&self) -> (usize, usize)

The number of cells of this heightfield along each dimension.

source

pub fn cell_status(&self, i: usize, j: usize) -> HeightFieldCellStatus

The status of the (i, j)-th cell.

source

pub fn set_cell_status( &mut self, i: usize, j: usize, status: HeightFieldCellStatus )

Set the status of the (i, j)-th cell.

source

pub fn cells_statuses(&self) -> &DMatrix<HeightFieldCellStatus>

The statuses of all the cells of this heightfield.

source

pub fn cells_statuses_mut(&mut self) -> &mut DMatrix<HeightFieldCellStatus>

The mutable statuses of all the cells of this heightfield.

source

pub fn flags(&self) -> HeightFieldFlags

The heightfield’s flags controlling internal-edges handling.

source

pub fn set_flags(&mut self, flags: HeightFieldFlags)

Sets the heightfield’s flags controlling internal-edges handling.

source

pub fn heights(&self) -> &DMatrix<Real>

The heights of this heightfield.

source

pub fn scale(&self) -> &Vector<Real>

The scale factor applied to this heightfield.

source

pub fn set_scale(&mut self, new_scale: Vector<Real>)

Sets the scale factor applied to this heightfield.

source

pub fn scaled(self, scale: &Vector<Real>) -> Self

Returns a scaled version of this heightfield.

source

pub fn cell_width(&self) -> Real

The width (extent along its local x axis) of each cell of this heightmap, including the scale factor.

source

pub fn cell_height(&self) -> Real

The height (extent along its local z axis) of each cell of this heightmap, including the scale factor.

source

pub fn unit_cell_width(&self) -> Real

The width (extent along its local x axis) of each cell of this heightmap, excluding the scale factor.

source

pub fn unit_cell_height(&self) -> Real

The height (extent along its local z axis) of each cell of this heightmap, excluding the scale factor.

source

pub fn root_aabb(&self) -> &Aabb

The Aabb of this heightmap.

source

pub fn convert_triangle_feature_id( &self, i: usize, j: usize, left: bool, fid: FeatureId ) -> FeatureId

Converts the FeatureID of the left or right triangle at the cell (i, j) into a FeatureId of the whole heightfield.

source

pub fn unclamped_elements_range_in_local_aabb( &self, aabb: &Aabb ) -> (Range<isize>, Range<isize>)

The range of segment ids that may intersect the given local Aabb.

source

pub fn map_elements_in_local_aabb( &self, aabb: &Aabb, f: &mut impl FnMut(u32, &Triangle) )

Applies the function f to all the triangles of this heightfield intersecting the given Aabb.

source§

impl HeightField

source

pub fn to_trimesh(&self) -> (Vec<Point3<Real>>, Vec<[u32; 3]>)

Discretize the boundary of this heightfield as a triangle-mesh.

Trait Implementations§

source§

impl Clone for HeightField

source§

fn clone(&self) -> HeightField

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for HeightField

source§

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

Formats the value using the given formatter. Read more
source§

impl From<HeightField> for TriMesh

source§

fn from(heightfield: HeightField) -> Self

Converts to this type from the input type.
source§

impl PointQuery for HeightField

source§

fn project_local_point_with_max_dist( &self, pt: &Point<Real>, solid: bool, max_dist: Real ) -> Option<PointProjection>

Projects a point on self, unless the projection lies further than the given max distance. Read more
source§

fn project_local_point(&self, point: &Point<Real>, _: bool) -> PointProjection

Projects a point on self. Read more
source§

fn project_local_point_and_get_feature( &self, point: &Point<Real> ) -> (PointProjection, FeatureId)

Projects a point on the boundary of self and returns the id of the feature the point was projected on.
source§

fn contains_local_point(&self, _point: &Point<Real>) -> bool

Tests if the given point is inside of self.
source§

fn project_point_with_max_dist( &self, m: &Isometry<Real>, pt: &Point<Real>, solid: bool, max_dist: Real ) -> Option<PointProjection>

Projects a point on self transformed by m, unless the projection lies further than the given max distance.
source§

fn distance_to_local_point(&self, pt: &Point<Real>, solid: bool) -> Real

Computes the minimal distance between a point and self.
source§

fn project_point( &self, m: &Isometry<Real>, pt: &Point<Real>, solid: bool ) -> PointProjection

Projects a point on self transformed by m.
source§

fn distance_to_point( &self, m: &Isometry<Real>, pt: &Point<Real>, solid: bool ) -> Real

Computes the minimal distance between a point and self transformed by m.
source§

fn project_point_and_get_feature( &self, m: &Isometry<Real>, pt: &Point<Real> ) -> (PointProjection, FeatureId)

Projects a point on the boundary of self transformed by m and returns the id of the feature the point was projected on.
source§

fn contains_point(&self, m: &Isometry<Real>, pt: &Point<Real>) -> bool

Tests if the given point is inside of self transformed by m.
source§

impl PointQueryWithLocation for HeightField

§

type Location = (usize, TrianglePointLocation)

Additional shape-specific projection information Read more
source§

fn project_local_point_and_get_location( &self, _point: &Point<Real>, _: bool ) -> (PointProjection, Self::Location)

Projects a point on self.
source§

fn project_point_and_get_location( &self, m: &Isometry<Real>, pt: &Point<Real>, solid: bool ) -> (PointProjection, Self::Location)

Projects a point on self transformed by m.
source§

fn project_local_point_and_get_location_with_max_dist( &self, pt: &Point<Real>, solid: bool, max_dist: Real ) -> Option<(PointProjection, Self::Location)>

Projects a point on self, with a maximum projection distance.
source§

fn project_point_and_get_location_with_max_dist( &self, m: &Isometry<Real>, pt: &Point<Real>, solid: bool, max_dist: Real ) -> Option<(PointProjection, Self::Location)>

Projects a point on self transformed by m, with a maximum projection distance.
source§

impl RayCast for HeightField

source§

fn cast_local_ray_and_get_normal( &self, ray: &Ray, max_time_of_impact: Real, solid: bool ) -> Option<RayIntersection>

Computes the time of impact, and normal between this transformed shape and a ray.
source§

fn cast_local_ray( &self, ray: &Ray, max_time_of_impact: Real, solid: bool ) -> Option<Real>

Computes the time of impact between this transform shape and a ray.
source§

fn intersects_local_ray(&self, ray: &Ray, max_time_of_impact: Real) -> bool

Tests whether a ray intersects this transformed shape.
source§

fn cast_ray( &self, m: &Isometry<Real>, ray: &Ray, max_time_of_impact: Real, solid: bool ) -> Option<Real>

Computes the time of impact between this transform shape and a ray.
source§

fn cast_ray_and_get_normal( &self, m: &Isometry<Real>, ray: &Ray, max_time_of_impact: Real, solid: bool ) -> Option<RayIntersection>

Computes the time of impact, and normal between this transformed shape and a ray.
source§

fn intersects_ray( &self, m: &Isometry<Real>, ray: &Ray, max_time_of_impact: Real ) -> bool

Tests whether a ray intersects this transformed shape.
source§

impl Shape for HeightField

source§

fn clone_box(&self) -> Box<dyn Shape>

Clones this shape into a boxed trait-object.
source§

fn compute_local_aabb(&self) -> Aabb

Computes the Aabb of this shape.
source§

fn compute_local_bounding_sphere(&self) -> BoundingSphere

Computes the bounding-sphere of this shape.
source§

fn compute_aabb(&self, position: &Isometry<Real>) -> Aabb

Computes the Aabb of this shape with the given position.
source§

fn mass_properties(&self, _density: Real) -> MassProperties

Compute the mass-properties of this shape given its uniform density.
source§

fn shape_type(&self) -> ShapeType

Gets the type tag of this shape.
source§

fn as_typed_shape(&self) -> TypedShape<'_>

Gets the underlying shape as an enum.
source§

fn ccd_thickness(&self) -> Real

source§

fn ccd_angular_thickness(&self) -> Real

source§

fn compute_bounding_sphere(&self, position: &Isometry<Real>) -> BoundingSphere

Computes the bounding-sphere of this shape with the given position.
source§

fn is_convex(&self) -> bool

Is this shape known to be convex? Read more
source§

fn as_support_map(&self) -> Option<&dyn SupportMap>

Convents this shape into its support mapping, if it has one.
source§

fn as_composite_shape(&self) -> Option<&dyn SimdCompositeShape>

source§

fn as_polygonal_feature_map(&self) -> Option<(&dyn PolygonalFeatureMap, Real)>

Converts this shape to a polygonal feature-map, if it is one.
source§

fn feature_normal_at_point( &self, _feature: FeatureId, _point: &Point<Real> ) -> Option<Unit<Vector<Real>>>

The shape’s normal at the given point located on a specific feature.
source§

fn compute_swept_aabb( &self, start_pos: &Isometry<Real>, end_pos: &Isometry<Real> ) -> Aabb

Computes the swept Aabb of this shape, i.e., the space it would occupy by moving from the given start position to the given end position.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.