class SG_EXPORT osg::ClippingVolume

A ClippingVolume class for representing convex clipping volumes made up.

Public Methods

typedef std::vector<osg::Plane>inline PlaneList ClippingVolume()

inline ClippingVolume(const ClippingVolume& cv)

inline ClippingVolume(const PlaneList& pl)

inline ~ClippingVolume()

inline void clear()

inline ClippingVolume& operator = (const ClippingVolume& cv)

void setToUnitFrustum()

Create a ClippingVolume with is cube, centered at 0,0,0, with sides of 2 units

void setToUnitFrustumWithoutNearFar()

inline void set(const ClippingVolume& cs)

inline void set(const PlaneList& pl)

inline void add(const osg::Plane& pl)

inline PlaneList& getPlaneList()

inline const PlaneList& getPlaneList() const

inline void setupMask()

inline const bool contains(const osg::Vec3& v) const

Check whether a vertex is contained with clipping set

inline const bool contains(const osg::BoundingSphere& bs, unsigned int& mask) const

Check whether any part of a bounding sphere is contained within clipping set.

inline const bool contains(const osg::BoundingSphere& bs) const

Check whether any part of a bounding sphere is contained within clipping set

inline const bool contains(const osg::BoundingBox& bb, unsigned int& mask) const

Check whether any part of a bounding box is contained within clipping set.

inline const bool contains(const osg::BoundingBox& bb) const

Check whether any part of a bounding box is contained within clipping set

inline const bool containsAllOf(const osg::BoundingSphere& bs) const

Check whether the entire bounding sphere is contained within clipping set

inline const bool containsAllOf(const osg::BoundingBox& bb) const

Check whether the entire bounding box is contained within clipping set

inline void transform(const osg::Matrix& matrix)

Transform the clipping set by matrix.

inline void transformProvidingInverse(const osg::Matrix& matrix)

Transform the clipping set by provide a pre inverted matrix.

Protected Fields

unsigned int _localMask

PlaneList _planeList

Documentation

A ClippingVolume class for representing convex clipping volumes made up. When adding planes, their normals should point inwards (into the volume)

typedef std::vector<osg::Plane>inline PlaneList ClippingVolume()

inline ClippingVolume(const ClippingVolume& cv)

inline ClippingVolume(const PlaneList& pl)

inline ~ClippingVolume()

inline void clear()

inline ClippingVolume& operator = (const ClippingVolume& cv)

void setToUnitFrustum()

Create a ClippingVolume with is cube, centered at 0,0,0, with sides of 2 units

void setToUnitFrustumWithoutNearFar()

inline void set(const ClippingVolume& cs)

inline void set(const PlaneList& pl)

inline void add(const osg::Plane& pl)

inline PlaneList& getPlaneList()

inline const PlaneList& getPlaneList() const

inline void setupMask()

inline const bool contains(const osg::Vec3& v) const

Check whether a vertex is contained with clipping set

inline const bool contains(const osg::BoundingSphere& bs, unsigned int& mask) const

Check whether any part of a bounding sphere is contained within clipping set. Using a mask to determine which planes should be used for the check, and modifying the mask to turn off planes which wouldn't contribute to clipping of any internal objects. This feature is used in osgUtil::CullVisitor to prevent redundant plane checking.

inline const bool contains(const osg::BoundingSphere& bs) const

Check whether any part of a bounding sphere is contained within clipping set

inline const bool contains(const osg::BoundingBox& bb, unsigned int& mask) const

Check whether any part of a bounding box is contained within clipping set. Using a mask to determine which planes should be used for the check, and modifying the mask to turn off planes which wouldn't contribute to clipping of any internal objects. This feature is used in osgUtil::CullVisitor to prevent redundant plane checking.

inline const bool contains(const osg::BoundingBox& bb) const

Check whether any part of a bounding box is contained within clipping set

inline const bool containsAllOf(const osg::BoundingSphere& bs) const

Check whether the entire bounding sphere is contained within clipping set

inline const bool containsAllOf(const osg::BoundingBox& bb) const

Check whether the entire bounding box is contained within clipping set

inline void transform(const osg::Matrix& matrix)

Transform the clipping set by matrix. Note, this operations carries out the calculation of the inverse of the matrix since to transforms planes must be multiplied my the inverse transposed. This make this operation expensive. If the inverse has been already calculated elsewhere then use transformProvidingInverse() instead. See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf

inline void transformProvidingInverse(const osg::Matrix& matrix)

Transform the clipping set by provide a pre inverted matrix. see transform for details.

unsigned int _localMask

PlaneList _planeList

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java