OpenSceneGraph
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
osgUtil::PolytopeIntersector Class Reference

Concrete class for implementing polytope intersections with the scene graph. More...

Inheritance diagram for osgUtil::PolytopeIntersector:
Inheritance graph
[legend]

Classes

struct  Intersection
 

Public Types

enum  { POINT_PRIMITIVES = (1<<0), LINE_PRIMITIVES = (1<<1), TRIANGLE_PRIMITIVES = (1<<2), ALL_PRIMITIVES = ( POINT_PRIMITIVES | LINE_PRIMITIVES | TRIANGLE_PRIMITIVES ) }
 dimension enum to specify primitive types to check. More...
 
typedef osg::Plane::Vec3_type Vec3_type
 
typedef std::set< IntersectionIntersections
 
- Public Types inherited from osgUtil::Intersector
enum  CoordinateFrame { WINDOW, PROJECTION, VIEW, MODEL }
 
enum  IntersectionLimit { NO_LIMIT, LIMIT_ONE_PER_DRAWABLE, LIMIT_ONE, LIMIT_NEAREST }
 
enum  PrecisionHint { USE_DOUBLE_CALCULATIONS, USE_FLOAT_CALCULATIONS }
 Hint to precision used in the internal intersections calculations. More...
 

Public Member Functions

 PolytopeIntersector (const osg::Polytope &polytope)
 Construct a PolytopeIntersector using specified polytope in MODEL coordinates. More...
 
 PolytopeIntersector (CoordinateFrame cf, const osg::Polytope &polytope)
 Construct a PolytopeIntersector using specified polytope in specified coordinate frame. More...
 
 PolytopeIntersector (CoordinateFrame cf, double xMin, double yMin, double xMax, double yMax)
 Convenience constructor for supporting picking in WINDOW, or PROJECTION coordinates In WINDOW coordinates (clip space cube) creates a five sided polytope box that has a front face at 0.0 and sides around box xMin, yMin, xMax, yMax. More...
 
osg::PolytopegetPolytope ()
 Get the Polytope used by the intersector. More...
 
const osg::PolytopegetPolytope () const
 Get the const Polytope used by the intersector. More...
 
void insertIntersection (const Intersection &intersection)
 
IntersectionsgetIntersections ()
 
Intersection getFirstIntersection ()
 
void setPrimitiveMask (unsigned int mask)
 Set which Primitives should be tested for intersections. More...
 
unsigned int getPrimitiveMask () const
 Get which Primitives should be tested for intersections. More...
 
void setReferencePlane (const osg::Plane &plane)
 set the plane used to sort the intersections. More...
 
const osg::PlanegetReferencePlane () const
 
virtual Intersectorclone (osgUtil::IntersectionVisitor &iv)
 
virtual bool enter (const osg::Node &node)
 
virtual void leave ()
 
virtual void intersect (osgUtil::IntersectionVisitor &iv, osg::Drawable *drawable)
 
virtual void reset ()
 
virtual bool containsIntersections ()
 
- Public Member Functions inherited from osgUtil::Intersector
 Intersector (CoordinateFrame cf=MODEL, IntersectionLimit il=NO_LIMIT)
 
void setCoordinateFrame (CoordinateFrame cf)
 
CoordinateFrame getCoordinateFrame () const
 
void setIntersectionLimit (IntersectionLimit limit)
 
IntersectionLimit getIntersectionLimit () const
 
bool disabled () const
 
void incrementDisabledCount ()
 
void decrementDisabledCount ()
 
bool reachedLimit ()
 
void setPrecisionHint (PrecisionHint hint)
 Set the hint to what precision to use in the intersections calculations. More...
 
PrecisionHint getPrecisionHint () const
 Get the hint to what precision should be used in the intersections calculations. More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
virtual void setThreadSafeRefUnref (bool)
 Deprecated, Referenced is always theadsafe so there method now has no effect and does not need to be called. More...
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Attributes

PolytopeIntersector_parent
 
osg::Polytope _polytope
 
unsigned int _primitiveMask
 mask which dimensions should be checked More...
 
osg::Plane _referencePlane
 plane to use for sorting intersections More...
 
Intersections _intersections
 
- Protected Attributes inherited from osgUtil::Intersector
CoordinateFrame _coordinateFrame
 
IntersectionLimit _intersectionLimit
 
unsigned int _disabledCount
 
PrecisionHint _precisionHint
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

Concrete class for implementing polytope intersections with the scene graph.

To be used in conjunction with IntersectionVisitor.

Member Typedef Documentation

◆ Intersections

◆ Vec3_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

dimension enum to specify primitive types to check.

Enumerator
POINT_PRIMITIVES 
LINE_PRIMITIVES 

check for points

TRIANGLE_PRIMITIVES 

check for lines

ALL_PRIMITIVES 

check for triangles and other primitives like quad, polygons that can be decomposed into triangles

Constructor & Destructor Documentation

◆ PolytopeIntersector() [1/3]

osgUtil::PolytopeIntersector::PolytopeIntersector ( const osg::Polytope polytope)

Construct a PolytopeIntersector using specified polytope in MODEL coordinates.

◆ PolytopeIntersector() [2/3]

osgUtil::PolytopeIntersector::PolytopeIntersector ( CoordinateFrame  cf,
const osg::Polytope polytope 
)

Construct a PolytopeIntersector using specified polytope in specified coordinate frame.

◆ PolytopeIntersector() [3/3]

osgUtil::PolytopeIntersector::PolytopeIntersector ( CoordinateFrame  cf,
double  xMin,
double  yMin,
double  xMax,
double  yMax 
)

Convenience constructor for supporting picking in WINDOW, or PROJECTION coordinates In WINDOW coordinates (clip space cube) creates a five sided polytope box that has a front face at 0.0 and sides around box xMin, yMin, xMax, yMax.

In PROJECTION coordinates (clip space cube) creates a five sided polytope box that has a front face at -1 and sides around box xMin, yMin, xMax, yMax. In VIEW and MODEL coordinates (clip space cube) creates a five sided polytope box that has a front face at 0.0 and sides around box xMin, yMin, xMax, yMax.

Member Function Documentation

◆ clone()

virtual Intersector* osgUtil::PolytopeIntersector::clone ( osgUtil::IntersectionVisitor iv)
virtual

Implements osgUtil::Intersector.

◆ containsIntersections()

virtual bool osgUtil::PolytopeIntersector::containsIntersections ( )
inlinevirtual

Implements osgUtil::Intersector.

◆ enter()

virtual bool osgUtil::PolytopeIntersector::enter ( const osg::Node node)
virtual

Implements osgUtil::Intersector.

◆ getFirstIntersection()

Intersection osgUtil::PolytopeIntersector::getFirstIntersection ( )
inline

◆ getIntersections()

Intersections& osgUtil::PolytopeIntersector::getIntersections ( )
inline

◆ getPolytope() [1/2]

osg::Polytope& osgUtil::PolytopeIntersector::getPolytope ( )
inline

Get the Polytope used by the intersector.

◆ getPolytope() [2/2]

const osg::Polytope& osgUtil::PolytopeIntersector::getPolytope ( ) const
inline

Get the const Polytope used by the intersector.

◆ getPrimitiveMask()

unsigned int osgUtil::PolytopeIntersector::getPrimitiveMask ( ) const
inline

Get which Primitives should be tested for intersections.

◆ getReferencePlane()

const osg::Plane& osgUtil::PolytopeIntersector::getReferencePlane ( ) const
inline

References osg::clone().

◆ insertIntersection()

void osgUtil::PolytopeIntersector::insertIntersection ( const Intersection intersection)
inline

◆ intersect()

virtual void osgUtil::PolytopeIntersector::intersect ( osgUtil::IntersectionVisitor iv,
osg::Drawable drawable 
)
virtual

Implements osgUtil::Intersector.

◆ leave()

virtual void osgUtil::PolytopeIntersector::leave ( )
virtual

Implements osgUtil::Intersector.

◆ reset()

virtual void osgUtil::PolytopeIntersector::reset ( )
virtual

Reimplemented from osgUtil::Intersector.

◆ setPrimitiveMask()

void osgUtil::PolytopeIntersector::setPrimitiveMask ( unsigned int  mask)
inline

Set which Primitives should be tested for intersections.

◆ setReferencePlane()

void osgUtil::PolytopeIntersector::setReferencePlane ( const osg::Plane plane)
inline

set the plane used to sort the intersections.

The intersections are sorted by the distance of the localIntersectionPoint and the reference plane. The default for the reference plane is the last plane of the polytope.

Member Data Documentation

◆ _intersections

Intersections osgUtil::PolytopeIntersector::_intersections
protected

◆ _parent

PolytopeIntersector* osgUtil::PolytopeIntersector::_parent
protected

◆ _polytope

osg::Polytope osgUtil::PolytopeIntersector::_polytope
protected

◆ _primitiveMask

unsigned int osgUtil::PolytopeIntersector::_primitiveMask
protected

mask which dimensions should be checked

◆ _referencePlane

osg::Plane osgUtil::PolytopeIntersector::_referencePlane
protected

plane to use for sorting intersections


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