General purpose bounding sphere class for enclosing nodes/objects/vertices. More...

Public Types
typedef VT	vec_type

typedef VT::value_type	value_type

Public Member Functions
	BoundingSphereImpl ()
	Construct a default bounding sphere with radius to -1.0f, representing an invalid/unset bounding sphere. More...

	BoundingSphereImpl (const vec_type &cntr, value_type rad)
	Creates a bounding sphere initialized to the given extents. More...

	BoundingSphereImpl (const BoundingSphereImpl &bs)
	Creates a bounding sphere initialized to the given extents. More...

	BoundingSphereImpl (const BoundingBoxImpl< VT > &bb)
	Creates a bounding sphere initialized to the given extents. More...

void	init ()
	Clear the bounding sphere. More...

bool	valid () const
	Returns true of the bounding sphere extents are valid, false otherwise. More...

bool	operator== (const BoundingSphereImpl &rhs) const

bool	operator!= (const BoundingSphereImpl &rhs) const

void	set (const vec_type &center, value_type radius)
	Set the bounding sphere to the given center/radius using floats. More...

vec_type &	center ()
	Returns the center of the bounding sphere. More...

const vec_type &	center () const
	Returns the const center of the bounding sphere. More...

value_type &	radius ()
	Returns the radius of the bounding sphere. More...

value_type	radius () const
	Returns the const radius of the bounding sphere. More...

value_type	radius2 () const
	Returns the squared length of the radius. More...

template<typename vector_type >
void	expandBy (const vector_type &v)
	Expands the sphere to encompass the given point. More...

template<typename vector_type >
void	expandRadiusBy (const vector_type &v)
	Expands the sphere to encompass the given point. More...

void	expandBy (const BoundingSphereImpl &sh)
	Expands the sphere to encompass the given sphere. More...

void	expandRadiusBy (const BoundingSphereImpl &sh)
	Expands the sphere to encompass the given sphere. More...

template<typename BBT >
void	expandBy (const BoundingBoxImpl< BBT > &bb)
	Expands the sphere to encompass the given box. More...

template<typename BBT >
void	expandRadiusBy (const BoundingBoxImpl< BBT > &bb)
	Expands the sphere to encompass the given box. More...

bool	contains (const vec_type &v) const
	Returns true if v is within the sphere. More...

bool	intersects (const BoundingSphereImpl &bs) const
	Returns true if there is a non-empty intersection with the given bounding sphere. More...

Public Attributes
vec_type	_center

value_type	_radius

Detailed Description

template<typename VT>
class osg::BoundingSphereImpl< VT >

General purpose bounding sphere class for enclosing nodes/objects/vertices.

Bounds internal osg::Nodes in the scene, assists in view frustum culling, etc. Similar in function to BoundingBox, it's quicker for evaluating culling but generally will not cull as aggressively because it encloses a greater volume.

Member Typedef Documentation

template<typename VT >

typedef VT::value_type osg::BoundingSphereImpl< VT >::value_type

template<typename VT >

typedef VT osg::BoundingSphereImpl< VT >::vec_type

Constructor & Destructor Documentation

template<typename VT >

osg::BoundingSphereImpl< VT >::BoundingSphereImpl ( )

inline

Construct a default bounding sphere with radius to -1.0f, representing an invalid/unset bounding sphere.

template<typename VT >

osg::BoundingSphereImpl< VT >::BoundingSphereImpl	(	const vec_type &	cntr,
		value_type	rad
	)

inline

Creates a bounding sphere initialized to the given extents.

template<typename VT >

osg::BoundingSphereImpl< VT >::BoundingSphereImpl ( const BoundingSphereImpl< VT > & bs )

inline

Creates a bounding sphere initialized to the given extents.

template<typename VT >

osg::BoundingSphereImpl< VT >::BoundingSphereImpl ( const BoundingBoxImpl< VT > & bb )

inline

Creates a bounding sphere initialized to the given extents.

Member Function Documentation

template<typename VT >

vec_type& osg::BoundingSphereImpl< VT >::center ( )

inline

Returns the center of the bounding sphere.

template<typename VT >

const vec_type& osg::BoundingSphereImpl< VT >::center ( ) const

inline

Returns the const center of the bounding sphere.

template<typename VT >

bool osg::BoundingSphereImpl< VT >::contains ( const vec_type & v ) const

inline

Returns true if v is within the sphere.

template<typename VT >

template<typename vector_type >

void osg::BoundingSphereImpl< VT >::expandBy ( const vector_type & v )

Expands the sphere to encompass the given point.

Repositions the sphere center to minimize the radius increase. If the sphere is uninitialized, set its center to v and radius to zero.

template<typename VT >

void osg::BoundingSphereImpl< VT >::expandBy ( const BoundingSphereImpl< VT > & sh )

Expands the sphere to encompass the given sphere.

Repositions the sphere center to minimize the radius increase. If the sphere is uninitialized, set its center and radius to match sh.

template<typename VT >

template<typename BBT >

void osg::BoundingSphereImpl< VT >::expandBy ( const BoundingBoxImpl< BBT > & bb )

Expands the sphere to encompass the given box.

Repositions the sphere center to minimize the radius increase.

template<typename VT >

template<typename vector_type >

void osg::BoundingSphereImpl< VT >::expandRadiusBy ( const vector_type & v )

Expands the sphere to encompass the given point.

Does not reposition the sphere center. If the sphere is uninitialized, set its center to v and radius to zero.

template<typename VT >

void osg::BoundingSphereImpl< VT >::expandRadiusBy ( const BoundingSphereImpl< VT > & sh )

Expands the sphere to encompass the given sphere.

Does not repositions the sphere center. If the sphere is uninitialized, set its center and radius to match sh.

template<typename VT >

template<typename BBT >

void osg::BoundingSphereImpl< VT >::expandRadiusBy ( const BoundingBoxImpl< BBT > & bb )

Expands the sphere to encompass the given box.

Does not repositions the sphere center.

template<typename VT >

void osg::BoundingSphereImpl< VT >::init ( )

inline

Clear the bounding sphere.

Reset to default values.

template<typename VT >

bool osg::BoundingSphereImpl< VT >::intersects ( const BoundingSphereImpl< VT > & bs ) const

inline

Returns true if there is a non-empty intersection with the given bounding sphere.

template<typename VT >

bool osg::BoundingSphereImpl< VT >::operator!= ( const BoundingSphereImpl< VT > & rhs ) const

inline

template<typename VT >

bool osg::BoundingSphereImpl< VT >::operator== ( const BoundingSphereImpl< VT > & rhs ) const

inline

template<typename VT >

value_type& osg::BoundingSphereImpl< VT >::radius ( )

inline

Returns the radius of the bounding sphere.

template<typename VT >

value_type osg::BoundingSphereImpl< VT >::radius ( ) const

inline

Returns the const radius of the bounding sphere.

template<typename VT >

value_type osg::BoundingSphereImpl< VT >::radius2 ( ) const

inline

Returns the squared length of the radius.

Note, For performance reasons, the calling method is responsible for checking to make sure the sphere is valid.

template<typename VT >

void osg::BoundingSphereImpl< VT >::set	(	const vec_type &	center,
		value_type	radius
	)

inline

Set the bounding sphere to the given center/radius using floats.

template<typename VT >

bool osg::BoundingSphereImpl< VT >::valid ( ) const

inline

Returns true of the bounding sphere extents are valid, false otherwise.

Member Data Documentation

template<typename VT >

vec_type osg::BoundingSphereImpl< VT >::_center

template<typename VT >

value_type osg::BoundingSphereImpl< VT >::_radius

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

osg/BoundingBox
osg/BoundingSphere

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename VT> class osg::BoundingSphereImpl< VT >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename VT>
class osg::BoundingSphereImpl< VT >