OpenSceneGraph
Public Types | Public Member Functions | Protected Attributes | List of all members
osgUtil::Intersector Class Referenceabstract

Pure virtual base class for implementing custom intersection technique. More...

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

Public Types

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

 Intersector (CoordinateFrame cf=MODEL, IntersectionLimit il=NO_LIMIT)
 
void setCoordinateFrame (CoordinateFrame cf)
 
CoordinateFrame getCoordinateFrame () const
 
void setIntersectionLimit (IntersectionLimit limit)
 
IntersectionLimit getIntersectionLimit () const
 
virtual Intersectorclone (osgUtil::IntersectionVisitor &iv)=0
 
virtual bool enter (const osg::Node &node)=0
 
virtual void leave ()=0
 
virtual void intersect (osgUtil::IntersectionVisitor &iv, osg::Drawable *drawable)=0
 
virtual void reset ()
 
virtual bool containsIntersections ()=0
 
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

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

Pure virtual base class for implementing custom intersection technique.

To implement a specific intersection technique on must override all the pure virtual methods, concrete examples of how to do this can be seen in the LineSegmentIntersector.

Member Enumeration Documentation

◆ CoordinateFrame

Enumerator
WINDOW 
PROJECTION 
VIEW 
MODEL 

◆ IntersectionLimit

Enumerator
NO_LIMIT 
LIMIT_ONE_PER_DRAWABLE 
LIMIT_ONE 
LIMIT_NEAREST 

◆ PrecisionHint

Hint to precision used in the internal intersections calculations.

Enumerator
USE_DOUBLE_CALCULATIONS 
USE_FLOAT_CALCULATIONS 

Constructor & Destructor Documentation

◆ Intersector()

osgUtil::Intersector::Intersector ( CoordinateFrame  cf = MODEL,
IntersectionLimit  il = NO_LIMIT 
)
inline

Member Function Documentation

◆ clone()

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

◆ containsIntersections()

virtual bool osgUtil::Intersector::containsIntersections ( )
pure virtual

◆ decrementDisabledCount()

void osgUtil::Intersector::decrementDisabledCount ( )
inline

References _disabledCount.

◆ disabled()

bool osgUtil::Intersector::disabled ( ) const
inline

References _disabledCount.

◆ enter()

virtual bool osgUtil::Intersector::enter ( const osg::Node node)
pure virtual

◆ getCoordinateFrame()

CoordinateFrame osgUtil::Intersector::getCoordinateFrame ( ) const
inline

References _coordinateFrame.

◆ getIntersectionLimit()

IntersectionLimit osgUtil::Intersector::getIntersectionLimit ( ) const
inline

◆ getPrecisionHint()

PrecisionHint osgUtil::Intersector::getPrecisionHint ( ) const
inline

Get the hint to what precision should be used in the intersections calculations.

References _precisionHint.

◆ incrementDisabledCount()

void osgUtil::Intersector::incrementDisabledCount ( )
inline

References _disabledCount.

◆ intersect()

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

◆ leave()

virtual void osgUtil::Intersector::leave ( )
pure virtual

◆ reachedLimit()

bool osgUtil::Intersector::reachedLimit ( )
inline

◆ reset()

virtual void osgUtil::Intersector::reset ( )
inlinevirtual

◆ setCoordinateFrame()

void osgUtil::Intersector::setCoordinateFrame ( CoordinateFrame  cf)
inline

References _coordinateFrame.

◆ setIntersectionLimit()

void osgUtil::Intersector::setIntersectionLimit ( IntersectionLimit  limit)
inline

References _intersectionLimit.

◆ setPrecisionHint()

void osgUtil::Intersector::setPrecisionHint ( PrecisionHint  hint)
inline

Set the hint to what precision to use in the intersections calculations.

References _precisionHint.

Member Data Documentation

◆ _coordinateFrame

CoordinateFrame osgUtil::Intersector::_coordinateFrame
protected

◆ _disabledCount

unsigned int osgUtil::Intersector::_disabledCount
protected

◆ _intersectionLimit

IntersectionLimit osgUtil::Intersector::_intersectionLimit
protected

◆ _precisionHint

PrecisionHint osgUtil::Intersector::_precisionHint
protected

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