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

RayIntersector implements possibly-infinite line intersections with the scene graph. More...

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

Classes

struct  Intersection
 

Public Types

typedef std::multiset< 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

 RayIntersector (CoordinateFrame cf=MODEL, RayIntersector *parent=NULL, osgUtil::Intersector::IntersectionLimit intersectionLimit=osgUtil::Intersector::NO_LIMIT)
 Construct a RayIntersector. More...
 
 RayIntersector (const osg::Vec3d &start, const osg::Vec3d &direction)
 Construct a RayIntersector that runs from start point in specified direction to the infinity. More...
 
 RayIntersector (CoordinateFrame cf, const osg::Vec3d &start, const osg::Vec3d &direction, RayIntersector *parent=NULL, osgUtil::Intersector::IntersectionLimit intersectionLimit=osgUtil::Intersector::NO_LIMIT)
 Construct a RayIntersector the runs from start point in specified direction to the infinity in the specified coordinate frame. More...
 
 RayIntersector (CoordinateFrame cf, double x, double y)
 Convenience constructor for supporting picking in WINDOW and PROJECTION coordinates. More...
 
void insertIntersection (const Intersection &intersection)
 
IntersectionsgetIntersections ()
 
Intersection getFirstIntersection ()
 
virtual void setStart (const osg::Vec3d &start)
 
const osg::Vec3dgetStart () const
 
virtual void setDirection (const osg::Vec3d &dir)
 
const osg::Vec3dgetDirection () 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)
 
 Referenced (const Referenced &)
 
Referencedoperator= (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...
 
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 Member Functions

virtual bool intersects (const osg::BoundingSphere &bs)
 
bool intersectAndClip (osg::Vec3d &s, const osg::Vec3d &d, osg::Vec3d &e, const osg::BoundingBox &bb)
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

RayIntersector_parent
 
osg::Vec3d _start
 
osg::Vec3d _direction
 
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 DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Detailed Description

RayIntersector implements possibly-infinite line intersections with the scene graph.

Compared with LineSegmentIntersector, RayIntersector supports infinite intersection lines, start and end point can be given in homogeneous coordinates and projection matrix is allowed to have z-far plane at infinity (often used in shadow volume technique).

Currently, picking of objects at infinity is not supported. Please, contribute.

The class is be used in conjunction with IntersectionVisitor.

Member Typedef Documentation

Constructor & Destructor Documentation

osgUtil::RayIntersector::RayIntersector ( CoordinateFrame  cf = MODEL,
RayIntersector parent = NULL,
osgUtil::Intersector::IntersectionLimit  intersectionLimit = osgUtil::Intersector::NO_LIMIT 
)

Construct a RayIntersector.

You will need to provide start and end point, or start point and direction. See setStart() and setDirecton().

osgUtil::RayIntersector::RayIntersector ( const osg::Vec3d start,
const osg::Vec3d direction 
)

Construct a RayIntersector that runs from start point in specified direction to the infinity.

Start and direction are provided in MODEL coordinates.

osgUtil::RayIntersector::RayIntersector ( CoordinateFrame  cf,
const osg::Vec3d start,
const osg::Vec3d direction,
RayIntersector parent = NULL,
osgUtil::Intersector::IntersectionLimit  intersectionLimit = osgUtil::Intersector::NO_LIMIT 
)

Construct a RayIntersector the runs from start point in specified direction to the infinity in the specified coordinate frame.

osgUtil::RayIntersector::RayIntersector ( CoordinateFrame  cf,
double  x,
double  y 
)

Convenience constructor for supporting picking in WINDOW and PROJECTION coordinates.

In WINDOW coordinates, it creates a start value of (x,y,0) and end value of (x,y,1). In PROJECTION coordinates (clip space cube), it creates a start value of (x,y,-1) and end value of (x,y,1). In VIEW and MODEL coordinates, it creates a start value of (x,y,0) and end value of (x,y,1).

Member Function Documentation

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

Implements osgUtil::Intersector.

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

Implements osgUtil::Intersector.

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

Implements osgUtil::Intersector.

const osg::Vec3d& osgUtil::RayIntersector::getDirection ( ) const
inline
Intersection osgUtil::RayIntersector::getFirstIntersection ( )
inline
Intersections& osgUtil::RayIntersector::getIntersections ( )
inline
const osg::Vec3d& osgUtil::RayIntersector::getStart ( ) const
inline
void osgUtil::RayIntersector::insertIntersection ( const Intersection intersection)
inline
virtual void osgUtil::RayIntersector::intersect ( osgUtil::IntersectionVisitor iv,
osg::Drawable drawable 
)
virtual

Implements osgUtil::Intersector.

bool osgUtil::RayIntersector::intersectAndClip ( osg::Vec3d s,
const osg::Vec3d d,
osg::Vec3d e,
const osg::BoundingBox bb 
)
protected
virtual bool osgUtil::RayIntersector::intersects ( const osg::BoundingSphere bs)
protectedvirtual
virtual void osgUtil::RayIntersector::leave ( )
virtual

Implements osgUtil::Intersector.

virtual void osgUtil::RayIntersector::reset ( )
virtual

Reimplemented from osgUtil::Intersector.

virtual void osgUtil::RayIntersector::setDirection ( const osg::Vec3d dir)
inlinevirtual
virtual void osgUtil::RayIntersector::setStart ( const osg::Vec3d start)
inlinevirtual

Member Data Documentation

osg::Vec3d osgUtil::RayIntersector::_direction
protected
Intersections osgUtil::RayIntersector::_intersections
protected
RayIntersector* osgUtil::RayIntersector::_parent
protected
osg::Vec3d osgUtil::RayIntersector::_start
protected

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

osg logo
Generated at Wed Nov 11 2015 22:15:17 for the OpenSceneGraph by doxygen 1.8.10.