osgUtil::PolytopeIntersector Class Reference

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

Inheritance diagram for osgUtil::PolytopeIntersector:

Classes
struct	Intersection

Public Types
enum	{ DimZero = (1<<0), DimOne = (1<<1), DimTwo = (1<<2), AllDims = (DimZero | DimOne | DimTwo) }
	dimension enum to specify primitive types to check. More...
typedef osg::Plane::Vec3_type	Vec3_type
typedef std::set< Intersection >	Intersections
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...
void	insertIntersection (const Intersection &intersection)
Intersections &	getIntersections ()
Intersection	getFirstIntersection ()
unsigned int	getDimensionMask () const
void	setDimensionMask (unsigned int dimensionMask)
	set the dimension mask. More...
const osg::Plane &	getReferencePlane () const
void	setReferencePlane (const osg::Plane &plane)
	set the plane used to sort the intersections. More...
virtual Intersector *	clone (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)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () 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...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () 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	_dimensionMask
	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::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	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

typedef std::set<Intersection> osgUtil::PolytopeIntersector::Intersections

typedef osg::Plane::Vec3_type osgUtil::PolytopeIntersector::Vec3_type

Member Enumeration Documentation

anonymous enum

dimension enum to specify primitive types to check.

Enumerator
DimZero	check for points
DimOne	check for lines
DimTwo	check for triangles, quad
AllDims

Constructor & Destructor Documentation

osgUtil::PolytopeIntersector::PolytopeIntersector

(

const osg::Polytope &

polytope

)

Construct a PolytopeIntersector using specified polytope in MODEL coordinates.

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

Construct a PolytopeIntersector using specified polytope in specified coordinate frame.

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

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

virtual

Implements osgUtil::Intersector.

virtual bool osgUtil::PolytopeIntersector::containsIntersections ( )

inlinevirtual

Implements osgUtil::Intersector.

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

virtual

Implements osgUtil::Intersector.

unsigned int osgUtil::PolytopeIntersector::getDimensionMask ( ) const

inline

Intersection osgUtil::PolytopeIntersector::getFirstIntersection ( )

inline

Intersections& osgUtil::PolytopeIntersector::getIntersections ( )

inline

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

inline

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

inline

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

virtual

Implements osgUtil::Intersector.

virtual void osgUtil::PolytopeIntersector::leave ( )

virtual

Implements osgUtil::Intersector.

virtual void osgUtil::PolytopeIntersector::reset ( )

virtual

Reimplemented from osgUtil::Intersector.

void osgUtil::PolytopeIntersector::setDimensionMask ( unsigned int  dimensionMask )

inline

set the dimension mask.

As polytope-triangle and polytope-quad intersections are expensive to compute it is possible to turn them off by calling setDimensionMask( DimZero | DimOne )

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

unsigned int osgUtil::PolytopeIntersector::_dimensionMask

protected

mask which dimensions should be checked

Intersections osgUtil::PolytopeIntersector::_intersections

protected

PolytopeIntersector* osgUtil::PolytopeIntersector::_parent

protected

osg::Polytope osgUtil::PolytopeIntersector::_polytope

protected

osg::Plane osgUtil::PolytopeIntersector::_referencePlane

protected

plane to use for sorting intersections

---

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

• osgUtil/PolytopeIntersector