Public Member Functions | Public Attributes | List of all members
coal::HFNode< BV > Struct Template Reference

#include <hfield.h>

Inheritance diagram for coal::HFNode< BV >:
Inheritance graph
[legend]

Public Member Functions

CoalScalar distance (const HFNode &other, Vec3s *P1=NULL, Vec3s *P2=NULL) const
 Compute the distance between two BVNode. P1 and P2, if not NULL and the underlying BV supports distance, return the nearest points. More...
 
Vec3s getCenter () const
 Access to the center of the BV. More...
 
coal::Matrix3s::IdentityReturnType getOrientation () const
 Access to the orientation of the BV. More...
 
bool operator!= (const HFNode &other) const
 Difference operator. More...
 
bool operator== (const HFNode &other) const
 Equality operator. More...
 
bool overlap (const HFNode &other) const
 Check whether two BVNode collide. More...
 
bool overlap (const HFNode &other, const CollisionRequest &request, CoalScalar &sqrDistLowerBound) const
 Check whether two BVNode collide. More...
 
virtual ~HFNode ()
 
- Public Member Functions inherited from coal::HFNodeBase
 HFNodeBase ()
 Default constructor. 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...
 
Eigen::Vector2i leftChildIndexes () const
 
bool operator!= (const HFNodeBase &other) const
 Difference operator. More...
 
bool operator== (const HFNodeBase &other) const
 Comparison operator. 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 rightChildIndexes () const
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef HFNodeBase Base
 
BV bv
 bounding volume storing the geometry More...
 
- Public Attributes inherited from coal::HFNodeBase
int contact_active_faces
 
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...
 
CoalScalar max_height
 
Eigen::DenseIndex x_id
 
Eigen::DenseIndex x_size
 
Eigen::DenseIndex y_id
 
Eigen::DenseIndex y_size
 

Additional Inherited Members

- Public Types inherited from coal::HFNodeBase
enum  FaceOrientation {
  FaceOrientation::TOP = 1, FaceOrientation::BOTTOM = 1, FaceOrientation::NORTH = 2, FaceOrientation::EAST = 4,
  FaceOrientation::SOUTH = 8, FaceOrientation::WEST = 16
}
 

Detailed Description

template<typename BV>
struct coal::HFNode< BV >

Definition at line 128 of file coal/hfield.h.

Constructor & Destructor Documentation

◆ ~HFNode()

template<typename BV >
virtual coal::HFNode< BV >::~HFNode ( )
inlinevirtual

Definition at line 167 of file coal/hfield.h.

Member Function Documentation

◆ distance()

template<typename BV >
CoalScalar coal::HFNode< BV >::distance ( const HFNode< BV > &  other,
Vec3s P1 = NULL,
Vec3s P2 = NULL 
) const
inline

Compute the distance between two BVNode. P1 and P2, if not NULL and the underlying BV supports distance, return the nearest points.

Definition at line 154 of file coal/hfield.h.

◆ getCenter()

template<typename BV >
Vec3s coal::HFNode< BV >::getCenter ( ) const
inline

Access to the center of the BV.

Definition at line 160 of file coal/hfield.h.

◆ getOrientation()

template<typename BV >
coal::Matrix3s::IdentityReturnType coal::HFNode< BV >::getOrientation ( ) const
inline

Access to the orientation of the BV.

Definition at line 163 of file coal/hfield.h.

◆ operator!=()

template<typename BV >
bool coal::HFNode< BV >::operator!= ( const HFNode< BV > &  other) const
inline

Difference operator.

Definition at line 142 of file coal/hfield.h.

◆ operator==()

template<typename BV >
bool coal::HFNode< BV >::operator== ( const HFNode< BV > &  other) const
inline

Equality operator.

Definition at line 137 of file coal/hfield.h.

◆ overlap() [1/2]

template<typename BV >
bool coal::HFNode< BV >::overlap ( const HFNode< BV > &  other) const
inline

Check whether two BVNode collide.

Definition at line 145 of file coal/hfield.h.

◆ overlap() [2/2]

template<typename BV >
bool coal::HFNode< BV >::overlap ( const HFNode< BV > &  other,
const CollisionRequest request,
CoalScalar sqrDistLowerBound 
) const
inline

Check whether two BVNode collide.

Definition at line 147 of file coal/hfield.h.

Member Data Documentation

◆ Base

template<typename BV >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef HFNodeBase coal::HFNode< BV >::Base

Definition at line 131 of file coal/hfield.h.

◆ bv

template<typename BV >
BV coal::HFNode< BV >::bv

bounding volume storing the geometry

Definition at line 134 of file coal/hfield.h.


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


hpp-fcl
Author(s):
autogenerated on Sat Nov 23 2024 03:45:00