coal  3.0.1
Coal, The Collision Detection Library. Previously known as HPP-FCL, fork of FCL -- The Flexible Collision Library
coal::HFNodeBase Struct Reference

#include <coal/hfield.h>

Inheritance diagram for coal::HFNodeBase:

Public Types

enum class  FaceOrientation {
  TOP = 1 , BOTTOM = 1 , NORTH = 2 , EAST = 4 ,
  SOUTH = 8 , WEST = 16
}
 

Public Member Functions

 HFNodeBase ()
 Default constructor. More...
 
bool operator== (const HFNodeBase &other) const
 Comparison operator. More...
 
bool operator!= (const HFNodeBase &other) const
 Difference operator. More...
 
bool isLeaf () const
 Whether current node is a leaf node (i.e. contains a primitive index) More...
 
size_t leftChild () const
 Return the index of the first child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel. More...
 
size_t rightChild () const
 Return the index of the second child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel. More...
 
Eigen::Vector2i leftChildIndexes () const
 
Eigen::Vector2i rightChildIndexes () const
 

Public Attributes

size_t first_child
 An index for first child node or primitive If the value is positive, it is the index of the first child bv node If the value is negative, it is -(primitive index + 1) Zero is not used. More...
 
Eigen::DenseIndex x_id
 
Eigen::DenseIndex x_size
 
Eigen::DenseIndex y_id
 
Eigen::DenseIndex y_size
 
Scalar max_height
 
int contact_active_faces
 

Member Enumeration Documentation

◆ FaceOrientation

Enumerator
TOP 
BOTTOM 
NORTH 
EAST 
SOUTH 
WEST 

Constructor & Destructor Documentation

◆ HFNodeBase()

coal::HFNodeBase::HFNodeBase ( )
inline

Default constructor.

Member Function Documentation

◆ isLeaf()

bool coal::HFNodeBase::isLeaf ( ) const
inline

Whether current node is a leaf node (i.e. contains a primitive index)

◆ leftChild()

size_t coal::HFNodeBase::leftChild ( ) const
inline

Return the index of the first child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel.

◆ leftChildIndexes()

Eigen::Vector2i coal::HFNodeBase::leftChildIndexes ( ) const
inline

◆ operator!=()

bool coal::HFNodeBase::operator!= ( const HFNodeBase other) const
inline

Difference operator.

◆ operator==()

bool coal::HFNodeBase::operator== ( const HFNodeBase other) const
inline

Comparison operator.

◆ rightChild()

size_t coal::HFNodeBase::rightChild ( ) const
inline

Return the index of the second child. The index is referred to the bounding volume array (i.e. bvs) in BVHModel.

◆ rightChildIndexes()

Eigen::Vector2i coal::HFNodeBase::rightChildIndexes ( ) const
inline

Member Data Documentation

◆ contact_active_faces

int coal::HFNodeBase::contact_active_faces

◆ first_child

size_t coal::HFNodeBase::first_child

An index for first child node or primitive If the value is positive, it is the index of the first child bv node If the value is negative, it is -(primitive index + 1) Zero is not used.

◆ max_height

Scalar coal::HFNodeBase::max_height

◆ x_id

Eigen::DenseIndex coal::HFNodeBase::x_id

◆ x_size

Eigen::DenseIndex coal::HFNodeBase::x_size

◆ y_id

Eigen::DenseIndex coal::HFNodeBase::y_id

◆ y_size

Eigen::DenseIndex coal::HFNodeBase::y_size

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