OpenSceneGraph 2.8.4
Public Types | Public Member Functions | Public Attributes
osg::BoundingSphereImpl< VT > Class Template Reference

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

List of all members.

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.
 BoundingSphereImpl (const vec_type &center, value_type radius)
 Creates a bounding sphere initialized to the given extents.
 BoundingSphereImpl (const BoundingSphereImpl &bs)
 Creates a bounding sphere initialized to the given extents.
 BoundingSphereImpl (const BoundingBoxImpl< VT > &bb)
 Creates a bounding sphere initialized to the given extents.
void init ()
 Clear the bounding sphere.
bool valid () const
 Returns true of the bounding sphere extents are valid, false otherwise.
void set (const vec_type &center, value_type radius)
 Set the bounding sphere to the given center/radius using floats.
vec_typecenter ()
 Returns the center of the bounding sphere.
const vec_typecenter () const
 Returns the const center of the bounding sphere.
value_typeradius ()
 Returns the radius of the bounding sphere.
value_type radius () const
 Returns the const radius of the bounding sphere.
value_type radius2 () const
 Returns the squared length of the radius.
template<typename vector_type >
void expandBy (const vector_type &v)
 Expands the sphere to encompass the given point.
template<typename vector_type >
void expandRadiusBy (const vector_type &v)
 Expands the sphere to encompass the given point.
void expandBy (const BoundingSphereImpl &sh)
 Expands the sphere to encompass the given sphere.
void expandRadiusBy (const BoundingSphereImpl &sh)
 Expands the sphere to encompass the given sphere.
void expandBy (const BoundingBoxImpl< VT > &bb)
 Expands the sphere to encompass the given box.
void expandRadiusBy (const BoundingBoxImpl< VT > &bb)
 Expands the sphere to encompass the given box.
bool contains (const vec_type &v) const
 Returns true if v is within the sphere.
bool intersects (const BoundingSphereImpl &bs) const
 Returns true if there is a non-empty intersection with the given bounding sphere.

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 center,
value_type  radius 
) [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.

References osg::BoundingSphereImpl< VT >::expandBy().


Member Function Documentation

template<typename VT>
vec_type& osg::BoundingSphereImpl< VT >::center ( ) [inline]
template<typename VT>
const vec_type& osg::BoundingSphereImpl< VT >::center ( ) const [inline]

Returns the const center of the bounding sphere.

References osg::BoundingSphereImpl< VT >::_center.

template<typename VT>
bool osg::BoundingSphereImpl< VT >::contains ( const vec_type v) const [inline]
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.

Referenced by osg::BoundingSphereImpl< VT >::BoundingSphereImpl(), and osg::Node::getBound().

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.

References osg::BoundingSphereImpl< VT >::_center, osg::BoundingSphereImpl< VT >::_radius, osg::BoundingSphereImpl< VT >::center(), osg::BoundingSphereImpl< VT >::radius(), and osg::BoundingSphereImpl< VT >::valid().

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

Expands the sphere to encompass the given box.

Repositions the sphere center to minimize the radius increase.

References osg::BoundingBoxImpl< VT >::center(), osg::BoundingBoxImpl< VT >::corner(), osg::BoundingBoxImpl< VT >::expandBy(), osg::BoundingBoxImpl< VT >::radius(), and osg::BoundingBoxImpl< VT >::valid().

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.

References osg::BoundingSphereImpl< VT >::_center, osg::BoundingSphereImpl< VT >::_radius, and osg::BoundingSphereImpl< VT >::valid().

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

Expands the sphere to encompass the given box.

Does not repositions the sphere center.

References osg::BoundingBoxImpl< VT >::center(), osg::BoundingBoxImpl< VT >::corner(), osg::BoundingBoxImpl< VT >::radius(), and osg::BoundingBoxImpl< VT >::valid().

template<typename VT>
void osg::BoundingSphereImpl< VT >::init ( ) [inline]

Clear the bounding sphere.

Reset to default values.

References osg::BoundingSphereImpl< VT >::_center, and osg::BoundingSphereImpl< VT >::_radius.

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.

References osg::BoundingSphereImpl< VT >::_center, osg::BoundingSphereImpl< VT >::_radius, and osg::BoundingSphereImpl< VT >::valid().

template<typename VT>
value_type osg::BoundingSphereImpl< VT >::radius ( ) const [inline]

Returns the const radius of the bounding sphere.

References osg::BoundingSphereImpl< VT >::_radius.

template<typename VT>
value_type& osg::BoundingSphereImpl< VT >::radius ( ) [inline]
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.

References osg::BoundingSphereImpl< VT >::_radius.

Referenced by osg::BoundingSphereImpl< VT >::contains().

template<typename VT>
void osg::BoundingSphereImpl< VT >::set ( const vec_type center,
value_type  radius 
) [inline]
template<typename VT>
bool osg::BoundingSphereImpl< VT >::valid ( ) const [inline]

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 file:

osg logo
Generated at Sun Jan 8 2012 13:16:05 for the OpenSceneGraph by doxygen 1.7.4.