OpenSceneGraph
3.0.1
|
A Polytope class for representing convex clipping volumes made up of a set of planes. More...
Public Types | |
typedef unsigned int | ClippingMask |
typedef std::vector< Plane > | PlaneList |
typedef std::vector< Vec3 > | VertexList |
typedef fast_back_stack < ClippingMask > | MaskStack |
Public Member Functions | |
Polytope () | |
Polytope (const Polytope &cv) | |
Polytope (const PlaneList &pl) | |
~Polytope () | |
void | clear () |
Polytope & | operator= (const Polytope &cv) |
void | setToUnitFrustum (bool withNear=true, bool withFar=true) |
Create a Polytope which is a cube, centered at 0,0,0, with sides of 2 units. | |
void | setToBoundingBox (const BoundingBox &bb) |
Create a Polytope which is a equivalent to BoundingBox. | |
void | setAndTransformProvidingInverse (const Polytope &pt, const osg::Matrix &matrix) |
void | set (const PlaneList &pl) |
void | add (const osg::Plane &pl) |
void | flip () |
flip/reverse the orientation of all the planes. | |
PlaneList & | getPlaneList () |
const PlaneList & | getPlaneList () const |
void | setReferenceVertexList (VertexList &vertices) |
VertexList & | getReferenceVertexList () |
const VertexList & | getReferenceVertexList () const |
void | setupMask () |
ClippingMask & | getCurrentMask () |
ClippingMask | getCurrentMask () const |
void | setResultMask (ClippingMask mask) |
ClippingMask | getResultMask () const |
MaskStack & | getMaskStack () |
const MaskStack & | getMaskStack () const |
void | pushCurrentMask () |
void | popCurrentMask () |
bool | contains (const osg::Vec3 &v) const |
Check whether a vertex is contained within clipping set. | |
bool | contains (const std::vector< Vec3 > &vertices) |
Check whether any part of vertex list is contained within clipping set. | |
bool | contains (const osg::BoundingSphere &bs) |
Check whether any part of a bounding sphere is contained within clipping set. | |
bool | contains (const osg::BoundingBox &bb) |
Check whether any part of a bounding box is contained within clipping set. | |
bool | containsAllOf (const std::vector< Vec3 > &vertices) |
Check whether all of vertex list is contained with clipping set. | |
bool | containsAllOf (const osg::BoundingSphere &bs) |
Check whether the entire bounding sphere is contained within clipping set. | |
bool | containsAllOf (const osg::BoundingBox &bb) |
Check whether the entire bounding box is contained within clipping set. | |
void | transform (const osg::Matrix &matrix) |
Transform the clipping set by matrix. | |
void | transformProvidingInverse (const osg::Matrix &matrix) |
Transform the clipping set by provide a pre inverted matrix. | |
Protected Attributes | |
MaskStack | _maskStack |
ClippingMask | _resultMask |
PlaneList | _planeList |
VertexList | _referenceVertexList |
A Polytope class for representing convex clipping volumes made up of a set of planes.
When adding planes, their normals should point inwards (into the volume)
typedef unsigned int osg::Polytope::ClippingMask |
typedef std::vector<Plane> osg::Polytope::PlaneList |
typedef std::vector<Vec3> osg::Polytope::VertexList |
osg::Polytope::Polytope | ( | ) | [inline] |
osg::Polytope::Polytope | ( | const Polytope & | cv | ) | [inline] |
osg::Polytope::Polytope | ( | const PlaneList & | pl | ) | [inline] |
osg::Polytope::~Polytope | ( | ) | [inline] |
void osg::Polytope::add | ( | const osg::Plane & | pl | ) | [inline] |
void osg::Polytope::clear | ( | ) | [inline] |
bool osg::Polytope::contains | ( | const osg::Vec3 & | v | ) | const [inline] |
Check whether a vertex is contained within clipping set.
bool osg::Polytope::contains | ( | const std::vector< Vec3 > & | vertices | ) | [inline] |
Check whether any part of vertex list is contained within clipping set.
bool osg::Polytope::contains | ( | const osg::BoundingSphere & | bs | ) | [inline] |
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.
bool osg::Polytope::contains | ( | const osg::BoundingBox & | bb | ) | [inline] |
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.
bool osg::Polytope::containsAllOf | ( | const std::vector< Vec3 > & | vertices | ) | [inline] |
Check whether all of vertex list is contained with clipping set.
bool osg::Polytope::containsAllOf | ( | const osg::BoundingSphere & | bs | ) | [inline] |
Check whether the entire bounding sphere is contained within clipping set.
bool osg::Polytope::containsAllOf | ( | const osg::BoundingBox & | bb | ) | [inline] |
Check whether the entire bounding box is contained within clipping set.
void osg::Polytope::flip | ( | ) | [inline] |
flip/reverse the orientation of all the planes.
ClippingMask& osg::Polytope::getCurrentMask | ( | ) | [inline] |
ClippingMask osg::Polytope::getCurrentMask | ( | ) | const [inline] |
MaskStack& osg::Polytope::getMaskStack | ( | ) | [inline] |
const MaskStack& osg::Polytope::getMaskStack | ( | ) | const [inline] |
PlaneList& osg::Polytope::getPlaneList | ( | ) | [inline] |
const PlaneList& osg::Polytope::getPlaneList | ( | ) | const [inline] |
VertexList& osg::Polytope::getReferenceVertexList | ( | ) | [inline] |
const VertexList& osg::Polytope::getReferenceVertexList | ( | ) | const [inline] |
ClippingMask osg::Polytope::getResultMask | ( | ) | const [inline] |
References _maskStack, _resultMask, _planeList, and _referenceVertexList.
void osg::Polytope::popCurrentMask | ( | ) | [inline] |
Referenced by osg::ShadowVolumeOccluder::popCurrentMask().
void osg::Polytope::pushCurrentMask | ( | ) | [inline] |
References osg::fast_back_stack::push_back().
Referenced by osg::ShadowVolumeOccluder::pushCurrentMask().
void osg::Polytope::set | ( | const PlaneList & | pl | ) | [inline] |
void osg::Polytope::setAndTransformProvidingInverse | ( | const Polytope & | pt, |
const osg::Matrix & | matrix | ||
) | [inline] |
References _referenceVertexList, _maskStack, osg::fast_back_stack::back(), and _planeList.
void osg::Polytope::setReferenceVertexList | ( | VertexList & | vertices | ) | [inline] |
void osg::Polytope::setResultMask | ( | ClippingMask | mask | ) | [inline] |
Referenced by osg::ShadowVolumeOccluder::disableResultMasks().
void osg::Polytope::setToBoundingBox | ( | const BoundingBox & | bb | ) | [inline] |
Create a Polytope which is a equivalent to BoundingBox.
References osg::BoundingBoxImpl::xMin(), osg::BoundingBoxImpl::xMax(), osg::BoundingBoxImpl::yMin(), osg::BoundingBoxImpl::yMax(), osg::BoundingBoxImpl::zMin(), and osg::BoundingBoxImpl::zMax().
void osg::Polytope::setToUnitFrustum | ( | bool | withNear = true , |
bool | withFar = true |
||
) | [inline] |
Create a Polytope which is a cube, centered at 0,0,0, with sides of 2 units.
void osg::Polytope::setupMask | ( | ) | [inline] |
void osg::Polytope::transform | ( | const osg::Matrix & | matrix | ) | [inline] |
Transform the clipping set by matrix.
Note, this operations carries out the calculation of the inverse of the matrix since a plane must be multiplied by the inverse transposed to transform it. This makes this operation expensive. If the inverse has been already calculated elsewhere then use transformProvidingInverse() instead. See http://www.worldserver.com/turk/computergraphics/NormalTransformations.pdf
References osg::Matrixd::invert().
void osg::Polytope::transformProvidingInverse | ( | const osg::Matrix & | matrix | ) | [inline] |
Transform the clipping set by provide a pre inverted matrix.
see transform for details.
MaskStack osg::Polytope::_maskStack [protected] |
Referenced by operator=(), and setAndTransformProvidingInverse().
PlaneList osg::Polytope::_planeList [protected] |
Referenced by operator=(), and setAndTransformProvidingInverse().
VertexList osg::Polytope::_referenceVertexList [protected] |
Referenced by operator=(), and setAndTransformProvidingInverse().
ClippingMask osg::Polytope::_resultMask [protected] |
Referenced by operator=().
![]() | Generated at Mon Oct 3 2011 12:39:43 for the OpenSceneGraph by doxygen 1.7.5. |