Template Class HeightField

Defined in File hfield.h

Inheritance Relationships

Base Type

public coal::CollisionGeometry (Class CollisionGeometry)

Derived Type

public boost::serialization::internal::HeightFieldAccessor< BV > (Template Struct HeightFieldAccessor)

Class Documentation

template<typename BV> class HeightField : public coal::CollisionGeometry 

Data structure depicting a height field given by the base grid dimensions and the elevation along the grid.

An height field is defined by its base dimensions along the X and Y axes and a set ofpoints defined by their altitude, regularly dispatched on the grid. The height field is centered at the origin and the corners of the geometry correspond to the following coordinates [± x_dim/2; ± y_dim/2].

Template Parameters:: BV – one of the bounding volume class in Bounding volumes.

Subclassed by boost::serialization::internal::HeightFieldAccessor< BV >

Public Types

typedef HFNode<BV> Node

typedef std::vector<Node, Eigen::aligned_allocator<Node>> BVS

Public Functions

inline HeightField(): Constructing an empty HeightField.

inline HeightField(const CoalScalar x_dim, const CoalScalar y_dim, const MatrixXs &heights, const CoalScalar min_height = (CoalScalar)0)

Constructing an HeightField from its base dimensions and the set of heights points. The granularity of the height field along X and Y direction is extraded from the Z grid.

Parameters:

x_dim – [in] Dimension along the X axis
y_dim – [in] Dimension along the Y axis
heights – [in] Matrix containing the altitude of each point compositng the height field
min_height – [in] Minimal height of the height field

inline HeightField(const HeightField &other)

Copy contructor from another HeightField.

Parameters:: other – [in] to copy.

inline const VecXs &getXGrid() const: Returns a const reference of the grid along the X direction.

inline const VecXs &getYGrid() const: Returns a const reference of the grid along the Y direction.

inline const MatrixXs &getHeights() const: Returns a const reference of the heights.

inline CoalScalar getXDim() const: Returns the dimension of the Height Field along the X direction.

inline CoalScalar getYDim() const: Returns the dimension of the Height Field along the Y direction.

inline CoalScalar getMinHeight() const: Returns the minimal height value of the Height Field.

inline CoalScalar getMaxHeight() const: Returns the maximal height value of the Height Field.

inline virtual HeightField<BV> *clone() const: Clone *this into a new CollisionGeometry.

inline const BVS &getNodes() const

inline virtual ~HeightField(): deconstruction, delete mesh data related.

inline virtual void computeLocalAABB(): Compute the AABB for the HeightField, used for broad-phase collision.

inline void updateHeights(const MatrixXs &new_heights): Update Height Field height.

inline const HFNode<BV> &getBV(unsigned int i) const: Access the bv giving the its index.

inline HFNode<BV> &getBV(unsigned int i): Access the bv giving the its index.

inline virtual NODE_TYPE getNodeType() const: Get the BV type: default is unknown.

virtual NODE_TYPE getNodeType() const: Specialization of getNodeType() for HeightField with different BV types.

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

virtual NODE_TYPE getNodeType() const: get the node type

Public Members

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef CollisionGeometry Base

Protected Functions

inline void init(const CoalScalar x_dim, const CoalScalar y_dim, const MatrixXs &heights, const CoalScalar min_height)

inline virtual OBJECT_TYPE getObjectType() const: Get the object type: it is a HFIELD.

inline virtual Vec3s computeCOM() const: compute center of mass

inline virtual CoalScalar computeVolume() const: compute the volume

inline virtual Matrix3s computeMomentofInertia() const: compute the inertia matrix, related to the origin

inline int buildTree(): Build the bounding volume hierarchy.

inline CoalScalar recursiveUpdateHeight(const size_t bv_id)

inline CoalScalar recursiveBuildTree(const size_t bv_id, const Eigen::DenseIndex x_id, const Eigen::DenseIndex x_size, const Eigen::DenseIndex y_id, const Eigen::DenseIndex y_size)

Protected Attributes

CoalScalar x_dim: Dimensions in meters along X and Y directions.

CoalScalar y_dim

MatrixXs heights: Elevation values in meters of the Height Field.

CoalScalar min_height: Minimal height of the Height Field: all values bellow min_height will be discarded.

CoalScalar max_height

VecXs x_grid: Grids along the X and Y directions. Useful for plotting or other related things.

VecXs y_grid

BVS bvs: Bounding volume hierarchy.

unsigned int num_bvs