coal::kIOS Class Reference

A class describing the kIOS collision structure, which is a set of spheres. More...

#include <coal/BV/kIOS.h>

Collaboration diagram for coal::kIOS:

Public Member Functions
bool	operator== (const kIOS &other) const
	Equality operator. More...
bool	operator!= (const kIOS &other) const
	Difference operator. More...
bool	contain (const Vec3s &p) const
	Check whether the kIOS contains a point. More...
bool	overlap (const kIOS &other) const
	Check collision between two kIOS. More...
bool	overlap (const kIOS &other, const CollisionRequest &, Scalar &sqrDistLowerBound) const
	Check collision between two kIOS. More...
Scalar	distance (const kIOS &other, Vec3s *P=NULL, Vec3s *Q=NULL) const
	The distance between two kIOS. More...
kIOS &	operator+= (const Vec3s &p)
	A simple way to merge the kIOS and a point. More...
kIOS &	operator+= (const kIOS &other)
	Merge the kIOS and another kIOS. More...
kIOS	operator+ (const kIOS &other) const
	Return the merged kIOS of current kIOS and the other one. More...
Scalar	size () const
	size of the kIOS (used in BV_Splitter to order two kIOSs) More...
const Vec3s &	center () const
	Center of the kIOS. More...
Scalar	width () const
	Width of the kIOS. More...
Scalar	height () const
	Height of the kIOS. More...
Scalar	depth () const
	Depth of the kIOS. More...
Scalar	volume () const
	Volume of the kIOS. More...

Public Attributes
kIOS_Sphere	spheres [max_num_spheres]
	The (at most) five spheres for intersection. More...
unsigned int	num_spheres
	The number of spheres, no larger than 5. More...
OBB	obb
	@ OBB related with kIOS More...

Static Public Attributes
static constexpr size_t	max_num_spheres = 5

Detailed Description

A class describing the kIOS collision structure, which is a set of spheres.

Member Function Documentation

center()

const Vec3s& coal::kIOS::center ( ) const

inline

Center of the kIOS.

contain()

bool coal::kIOS::contain

(

const Vec3s &

p

)

const

Check whether the kIOS contains a point.

depth()

Scalar coal::kIOS::depth

(

)

const

Depth of the kIOS.

distance()

Scalar coal::kIOS::distance	(	const kIOS &	other,
		Vec3s *	P = NULL,
		Vec3s *	Q = NULL
	)		const

The distance between two kIOS.

height()

Scalar coal::kIOS::height

(

)

const

Height of the kIOS.

operator!=()

bool coal::kIOS::operator!= ( const kIOS &  other ) const

inline

Difference operator.

operator+()

kIOS coal::kIOS::operator+

(

const kIOS &

other

)

const

Return the merged kIOS of current kIOS and the other one.

operator+=() [1/2]

kIOS& coal::kIOS::operator+= ( const kIOS &  other )

inline

Merge the kIOS and another kIOS.

operator+=() [2/2]

kIOS& coal::kIOS::operator+=

(

const Vec3s &

p

)

A simple way to merge the kIOS and a point.

operator==()

bool coal::kIOS::operator== ( const kIOS &  other ) const

inline

Equality operator.

overlap() [1/2]

bool coal::kIOS::overlap

(

const kIOS &

other

)

const

Check collision between two kIOS.

overlap() [2/2]

bool coal::kIOS::overlap	(	const kIOS &	other,
		const CollisionRequest &	,
		Scalar &	sqrDistLowerBound
	)		const

Check collision between two kIOS.

size()

Scalar coal::kIOS::size

(

)

const

size of the kIOS (used in BV_Splitter to order two kIOSs)

volume()

Scalar coal::kIOS::volume

(

)

const

Volume of the kIOS.

width()

Scalar coal::kIOS::width

(

)

const

Width of the kIOS.

Member Data Documentation

max_num_spheres

constexpr size_t coal::kIOS::max_num_spheres = 5

staticconstexpr

num_spheres

unsigned int coal::kIOS::num_spheres

The number of spheres, no larger than 5.

obb

OBB coal::kIOS::obb

@ OBB related with kIOS

spheres

kIOS_Sphere coal::kIOS::spheres[max_num_spheres]

The (at most) five spheres for intersection.

---

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

• include/coal/BV/kIOS.h