coal  3.0.1
Coal, The Collision Detection Library. Previously known as HPP-FCL, fork of FCL -- The Flexible Collision Library
boost::serialization::internal::HeightFieldAccessor< BV > Struct Template Reference

#include <coal/serialization/hfield.h>

Inheritance diagram for boost::serialization::internal::HeightFieldAccessor< BV >:
Collaboration diagram for boost::serialization::internal::HeightFieldAccessor< BV >:

Public Types

typedef coal::HeightField< BV > Base
 
- Public Types inherited from coal::HeightField< BV >
typedef HFNode< BV > Node
 
typedef std::vector< Node, Eigen::aligned_allocator< Node > > BVS
 

Public Attributes

BVS bvs
 Bounding volume hierarchy. More...
 
MatrixXs heights
 Elevation values in meters of the Height Field. More...
 
CoalScalar max_height
 
CoalScalar min_height
 Minimal height of the Height Field: all values bellow min_height will be discarded. More...
 
unsigned int num_bvs
 
CoalScalar x_dim
 Dimensions in meters along X and Y directions. More...
 
VecXs x_grid
 Grids along the X and Y directions. Useful for plotting or other related things. More...
 
CoalScalar y_dim
 
VecXs y_grid
 
- Public Attributes inherited from coal::HeightField< BV >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef CollisionGeometry Base
 
- Public Attributes inherited from coal::CollisionGeometry
Vec3s aabb_center
 AABB center in local coordinate. More...
 
CoalScalar aabb_radius
 AABB radius. More...
 
AABB aabb_local
 AABB in local coordinate, used for tight AABB when only translation transform. More...
 
void * user_data
 pointer to user defined data specific to this object More...
 
CoalScalar cost_density
 collision cost for unit volume More...
 
CoalScalar threshold_occupied
 threshold for occupied ( >= is occupied) More...
 
CoalScalar threshold_free
 threshold for free (<= is free) More...
 

Additional Inherited Members

- Public Member Functions inherited from coal::HeightField< BV >
 HeightField ()
 Constructing an empty HeightField. More...
 
 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. More...
 
 HeightField (const HeightField &other)
 Copy contructor from another HeightField. More...
 
const VecXsgetXGrid () const
 Returns a const reference of the grid along the X direction. More...
 
const VecXsgetYGrid () const
 Returns a const reference of the grid along the Y direction. More...
 
const MatrixXsgetHeights () const
 Returns a const reference of the heights. More...
 
CoalScalar getXDim () const
 Returns the dimension of the Height Field along the X direction. More...
 
CoalScalar getYDim () const
 Returns the dimension of the Height Field along the Y direction. More...
 
CoalScalar getMinHeight () const
 Returns the minimal height value of the Height Field. More...
 
CoalScalar getMaxHeight () const
 Returns the maximal height value of the Height Field. More...
 
virtual HeightField< BV > * clone () const
 Clone *this into a new CollisionGeometry. More...
 
const BVSgetNodes () const
 
virtual ~HeightField ()
 deconstruction, delete mesh data related. More...
 
void computeLocalAABB ()
 Compute the AABB for the HeightField, used for broad-phase collision. More...
 
void updateHeights (const MatrixXs &new_heights)
 Update Height Field height. More...
 
const HFNode< BV > & getBV (unsigned int i) const
 Access the bv giving the its index. More...
 
HFNode< BV > & getBV (unsigned int i)
 Access the bv giving the its index. More...
 
NODE_TYPE getNodeType () const
 Get the BV type: default is unknown. More...
 
NODE_TYPE getNodeType () const
 Specialization of getNodeType() for HeightField with different BV types. More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
NODE_TYPE getNodeType () const
 get the node type More...
 
- Public Member Functions inherited from coal::CollisionGeometry
 CollisionGeometry ()
 
 CollisionGeometry (const CollisionGeometry &other)=default
 Copy constructor. More...
 
virtual ~CollisionGeometry ()
 
bool operator== (const CollisionGeometry &other) const
 Equality operator. More...
 
bool operator!= (const CollisionGeometry &other) const
 Difference operator. More...
 
void * getUserData () const
 get user data in geometry More...
 
void setUserData (void *data)
 set user data in geometry More...
 
bool isOccupied () const
 whether the object is completely occupied More...
 
bool isFree () const
 whether the object is completely free More...
 
bool isUncertain () const
 whether the object has some uncertainty More...
 
virtual Matrix3s computeMomentofInertiaRelatedToCOM () const
 compute the inertia matrix, related to the com More...
 
- Protected Member Functions inherited from coal::HeightField< BV >
void init (const CoalScalar x_dim, const CoalScalar y_dim, const MatrixXs &heights, const CoalScalar min_height)
 
OBJECT_TYPE getObjectType () const
 Get the object type: it is a HFIELD. More...
 
Vec3s computeCOM () const
 compute center of mass More...
 
CoalScalar computeVolume () const
 compute the volume More...
 
Matrix3s computeMomentofInertia () const
 compute the inertia matrix, related to the origin More...
 
int buildTree ()
 Build the bounding volume hierarchy. More...
 
CoalScalar recursiveUpdateHeight (const size_t bv_id)
 
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 inherited from coal::HeightField< BV >
CoalScalar x_dim
 Dimensions in meters along X and Y directions. More...
 
CoalScalar y_dim
 
MatrixXs heights
 Elevation values in meters of the Height Field. More...
 
CoalScalar min_height
 Minimal height of the Height Field: all values bellow min_height will be discarded. More...
 
CoalScalar max_height
 
VecXs x_grid
 Grids along the X and Y directions. Useful for plotting or other related things. More...
 
VecXs y_grid
 
BVS bvs
 Bounding volume hierarchy. More...
 
unsigned int num_bvs
 

Member Typedef Documentation

◆ Base

Member Data Documentation

◆ bvs

template<typename BV >
BVS coal::HeightField< BV >::bvs

Bounding volume hierarchy.

◆ heights

template<typename BV >
MatrixXs coal::HeightField< BV >::heights

Elevation values in meters of the Height Field.

◆ max_height

template<typename BV >
CoalScalar coal::HeightField< BV >::max_height

◆ min_height

template<typename BV >
CoalScalar coal::HeightField< BV >::min_height

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

◆ num_bvs

template<typename BV >
unsigned int coal::HeightField< BV >::num_bvs

◆ x_dim

template<typename BV >
CoalScalar coal::HeightField< BV >::x_dim

Dimensions in meters along X and Y directions.

◆ x_grid

template<typename BV >
VecXs coal::HeightField< BV >::x_grid

Grids along the X and Y directions. Useful for plotting or other related things.

◆ y_dim

template<typename BV >
CoalScalar coal::HeightField< BV >::y_dim

◆ y_grid

template<typename BV >
VecXs coal::HeightField< BV >::y_grid

The documentation for this struct was generated from the following file: