Struct rapier3d::geometry::HeightField
source · [−]pub struct HeightField { /* private fields */ }
Expand description
An heightfield implicitly discretized with triangles.
Implementations
sourceimpl HeightField
impl HeightField
sourceimpl HeightField
impl HeightField
sourcepub fn bounding_sphere(
&self,
pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> BoundingSphere
pub fn bounding_sphere(
&self,
pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> BoundingSphere
Computes the world-space bounding sphere of this height-field, transformed by pos
.
sourcepub fn local_bounding_sphere(&self) -> BoundingSphere
pub fn local_bounding_sphere(&self) -> BoundingSphere
Computes the local-space bounding sphere of this height-field.
sourceimpl HeightField
impl HeightField
sourcepub fn new(
heights: Matrix<f32, Dynamic, Dynamic, VecStorage<f32, Dynamic, Dynamic>>,
scale: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>
) -> HeightField
pub fn new(
heights: Matrix<f32, Dynamic, Dynamic, VecStorage<f32, Dynamic, Dynamic>>,
scale: Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>
) -> HeightField
Initializes a new heightfield with the given heights and a scaling factor.
sourcepub fn cell_at_point(
&self,
pt: &OPoint<f32, Const<3_usize>>
) -> Option<(usize, usize)>
pub fn cell_at_point(
&self,
pt: &OPoint<f32, Const<3_usize>>
) -> Option<(usize, usize)>
The pair of index of the cell containing the vertical projection of the given point.
sourcepub fn x_at(&self, j: usize) -> f32
pub fn x_at(&self, j: usize) -> f32
The smallest x coordinate of the j
-th column of this heightfield.
sourcepub fn z_at(&self, i: usize) -> f32
pub fn z_at(&self, i: usize) -> f32
The smallest z coordinate of the start of the i
-th row of this heightfield.
sourcepub fn triangles(&'a self) -> impl Iterator<Item = Triangle> + 'a
pub fn triangles(&'a self) -> impl Iterator<Item = Triangle> + 'a
An iterator through all the triangles of this heightfield.
sourcepub fn triangles_at(
&self,
i: usize,
j: usize
) -> (Option<Triangle>, Option<Triangle>)
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).
sourcepub fn cell_status(&self, i: usize, j: usize) -> HeightFieldCellStatus
pub fn cell_status(&self, i: usize, j: usize) -> HeightFieldCellStatus
The status of the (i, j)
-th cell.
sourcepub fn set_cell_status(
&mut self,
i: usize,
j: usize,
status: HeightFieldCellStatus
)
pub fn set_cell_status(
&mut self,
i: usize,
j: usize,
status: HeightFieldCellStatus
)
Set the status of the (i, j)
-th cell.
sourcepub fn cells_statuses(
&self
) -> &Matrix<HeightFieldCellStatus, Dynamic, Dynamic, VecStorage<HeightFieldCellStatus, Dynamic, Dynamic>>
pub fn cells_statuses(
&self
) -> &Matrix<HeightFieldCellStatus, Dynamic, Dynamic, VecStorage<HeightFieldCellStatus, Dynamic, Dynamic>>
The statuses of all the cells of this heightfield.
sourcepub fn cells_statuses_mut(
&mut self
) -> &mut Matrix<HeightFieldCellStatus, Dynamic, Dynamic, VecStorage<HeightFieldCellStatus, Dynamic, Dynamic>>
pub fn cells_statuses_mut(
&mut self
) -> &mut Matrix<HeightFieldCellStatus, Dynamic, Dynamic, VecStorage<HeightFieldCellStatus, Dynamic, Dynamic>>
The mutable statuses of all the cells of this heightfield.
sourcepub fn heights(
&self
) -> &Matrix<f32, Dynamic, Dynamic, VecStorage<f32, Dynamic, Dynamic>>
pub fn heights(
&self
) -> &Matrix<f32, Dynamic, Dynamic, VecStorage<f32, Dynamic, Dynamic>>
The heights of this heightfield.
sourcepub fn scale(
&self
) -> &Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>
pub fn scale(
&self
) -> &Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>
The scale factor applied to this heightfield.
sourcepub fn cell_width(&self) -> f32
pub fn cell_width(&self) -> f32
The width (extent along its local x
axis) of each cell of this heightmap, including the scale factor.
sourcepub fn cell_height(&self) -> f32
pub fn cell_height(&self) -> f32
The height (extent along its local z
axis) of each cell of this heightmap, including the scale factor.
sourcepub fn unit_cell_width(&self) -> f32
pub fn unit_cell_width(&self) -> f32
The width (extent along its local x
axis) of each cell of this heightmap, excluding the scale factor.
sourcepub fn unit_cell_height(&self) -> f32
pub fn unit_cell_height(&self) -> f32
The height (extent along its local z
axis) of each cell of this heightmap, excluding the scale factor.
Trait Implementations
sourceimpl Clone for HeightField
impl Clone for HeightField
sourcefn clone(&self) -> HeightField
fn clone(&self) -> HeightField
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HeightField
impl Debug for HeightField
sourceimpl From<HeightField> for TriMesh
impl From<HeightField> for TriMesh
sourcefn from(heightfield: HeightField) -> TriMesh
fn from(heightfield: HeightField) -> TriMesh
Converts to this type from the input type.
sourceimpl PointQuery for HeightField
impl PointQuery for HeightField
sourcefn project_local_point(
&self,
point: &OPoint<f32, Const<3_usize>>,
bool
) -> PointProjection
fn project_local_point(
&self,
point: &OPoint<f32, Const<3_usize>>,
bool
) -> PointProjection
Projects a point on self
. Read more
sourcefn project_local_point_and_get_feature(
&self,
point: &OPoint<f32, Const<3_usize>>
) -> (PointProjection, FeatureId)
fn project_local_point_and_get_feature(
&self,
point: &OPoint<f32, Const<3_usize>>
) -> (PointProjection, FeatureId)
Projects a point on the boundary of self
and returns the id of the
feature the point was projected on. Read more
sourcefn contains_local_point(&self, _point: &OPoint<f32, Const<3_usize>>) -> bool
fn contains_local_point(&self, _point: &OPoint<f32, Const<3_usize>>) -> bool
Tests if the given point is inside of self
.
sourcefn distance_to_local_point(
&self,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> f32
fn distance_to_local_point(
&self,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> f32
Computes the minimal distance between a point and self
.
sourcefn project_point(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> PointProjection
fn project_point(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> PointProjection
Projects a point on self
transformed by m
.
sourcefn distance_to_point(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> f32
fn distance_to_point(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> f32
Computes the minimal distance between a point and self
transformed by m
.
sourcefn project_point_and_get_feature(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>
) -> (PointProjection, FeatureId)
fn project_point_and_get_feature(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>
) -> (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. Read more
sourceimpl PointQueryWithLocation for HeightField
impl PointQueryWithLocation for HeightField
type Location = (usize, TrianglePointLocation)
type Location = (usize, TrianglePointLocation)
Additional shape-specific projection information Read more
sourcefn project_local_point_and_get_location(
&self,
_point: &OPoint<f32, Const<3_usize>>,
bool
) -> (PointProjection, <HeightField as PointQueryWithLocation>::Location)
fn project_local_point_and_get_location(
&self,
_point: &OPoint<f32, Const<3_usize>>,
bool
) -> (PointProjection, <HeightField as PointQueryWithLocation>::Location)
Projects a point on self
.
sourcefn project_point_and_get_location(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> (PointProjection, Self::Location)
fn project_point_and_get_location(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
pt: &OPoint<f32, Const<3_usize>>,
solid: bool
) -> (PointProjection, Self::Location)
Projects a point on self
transformed by m
.
sourceimpl RayCast for HeightField
impl RayCast for HeightField
sourcefn cast_local_ray_and_get_normal(
&self,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<RayIntersection>
fn cast_local_ray_and_get_normal(
&self,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<RayIntersection>
Computes the time of impact, and normal between this transformed shape and a ray.
sourcefn cast_local_ray(&self, ray: &Ray, max_toi: f32, solid: bool) -> Option<f32>
fn cast_local_ray(&self, ray: &Ray, max_toi: f32, solid: bool) -> Option<f32>
Computes the time of impact between this transform shape and a ray.
sourcefn intersects_local_ray(&self, ray: &Ray, max_toi: f32) -> bool
fn intersects_local_ray(&self, ray: &Ray, max_toi: f32) -> bool
Tests whether a ray intersects this transformed shape.
sourcefn cast_ray(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<f32>
fn cast_ray(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<f32>
Computes the time of impact between this transform shape and a ray.
sourcefn cast_ray_and_get_normal(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<RayIntersection>
fn cast_ray_and_get_normal(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32,
solid: bool
) -> Option<RayIntersection>
Computes the time of impact, and normal between this transformed shape and a ray.
sourcefn intersects_ray(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32
) -> bool
fn intersects_ray(
&self,
m: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
ray: &Ray,
max_toi: f32
) -> bool
Tests whether a ray intersects this transformed shape.
sourceimpl Shape for HeightField
impl Shape for HeightField
sourcefn clone_box(&self) -> Box<dyn Shape + 'static, Global>
fn clone_box(&self) -> Box<dyn Shape + 'static, Global>
Clones this shape into a boxed trait-object.
sourcefn compute_local_aabb(&self) -> AABB
fn compute_local_aabb(&self) -> AABB
Computes the AABB of this shape.
sourcefn compute_local_bounding_sphere(&self) -> BoundingSphere
fn compute_local_bounding_sphere(&self) -> BoundingSphere
Computes the bounding-sphere of this shape.
sourcefn compute_aabb(
&self,
position: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> AABB
fn compute_aabb(
&self,
position: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> AABB
Computes the AABB of this shape with the given position.
sourcefn mass_properties(&self, _density: f32) -> MassProperties
fn mass_properties(&self, _density: f32) -> MassProperties
Compute the mass-properties of this shape given its uniform density.
sourcefn shape_type(&self) -> ShapeType
fn shape_type(&self) -> ShapeType
Gets the type tag of this shape.
sourcefn as_typed_shape(&self) -> TypedShape<'_>
fn as_typed_shape(&self) -> TypedShape<'_>
Gets the underlying shape as an enum.
fn ccd_thickness(&self) -> f32
fn ccd_angular_thickness(&self) -> f32
sourcefn compute_bounding_sphere(
&self,
position: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> BoundingSphere
fn compute_bounding_sphere(
&self,
position: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> BoundingSphere
Computes the bounding-sphere of this shape with the given position.
sourcefn as_support_map(&self) -> Option<&dyn SupportMap>
fn as_support_map(&self) -> Option<&dyn SupportMap>
Convents this shape into its support mapping, if it has one.
fn as_composite_shape(&self) -> Option<&dyn SimdCompositeShape>
sourcefn as_polygonal_feature_map(&self) -> Option<(&dyn PolygonalFeatureMap, f32)>
fn as_polygonal_feature_map(&self) -> Option<(&dyn PolygonalFeatureMap, f32)>
Converts this shape to a polygonal feature-map, if it is one.
sourcefn feature_normal_at_point(
&self,
_feature: FeatureId,
_point: &OPoint<f32, Const<3_usize>>
) -> Option<Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>>>
fn feature_normal_at_point(
&self,
_feature: FeatureId,
_point: &OPoint<f32, Const<3_usize>>
) -> Option<Unit<Matrix<f32, Const<{_: usize}>, Const<1_usize>, ArrayStorage<f32, 3_usize, 1_usize>>>>
The shape’s normal at the given point located on a specific feature.
sourcefn compute_swept_aabb(
&self,
start_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
end_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> AABB
fn compute_swept_aabb(
&self,
start_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>,
end_pos: &Isometry<f32, Unit<Quaternion<f32>>, 3_usize>
) -> 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. Read more
Auto Trait Implementations
impl RefUnwindSafe for HeightField
impl Send for HeightField
impl Sync for HeightField
impl Unpin for HeightField
impl UnwindSafe for HeightField
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
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. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcefn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
sourcefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
sourcefn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
sourcefn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more