OpenSceneGraph 3.6.5
osg::LineSegment Class Reference

LineSegment class for representing a line segment. More...

#include <LineSegment>

Inheritance diagram for osg::LineSegment:

Public Types

typedef Vec3d vec_type
typedef vec_type::value_type value_type

Public Member Functions

 LineSegment ()
 LineSegment (const LineSegment &seg)
 LineSegment (const vec_type &s, const vec_type &e)
LineSegmentoperator= (const LineSegment &seg)
void set (const vec_type &s, const vec_type &e)
vec_typestart ()
const vec_typestart () const
vec_typeend ()
const vec_typeend () const
bool valid () const
bool intersect (const BoundingBox &bb) const
 return true if segment intersects BoundingBox.
bool intersectAndComputeRatios (const BoundingBox &bb, float &ratioFromStartToEnd1, float &ratioFromStartToEnd2) const
 return true if segment intersects BoundingBox and set float ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
bool intersectAndComputeRatios (const BoundingBox &bb, double &ratioFromStartToEnd1, double &ratioFromStartToEnd2) const
 return true if segment intersects BoundingBox and set double ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
bool intersect (const BoundingSphere &bs) const
 return true if segment intersects BoundingSphere.
bool intersectAndComputeRatios (const BoundingSphere &bs, float &ratioFromStartToEnd1, float &ratioFromStartToEnd2) const
 return true if segment intersects BoundingSphere and set float ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
bool intersectAndComputeRatios (const BoundingSphere &bs, double &ratioFromStartToEnd1, double &ratioFromStartToEnd2) const
 return true if segment intersects BoundingSphere and set double ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
bool intersect (const Vec3f &v1, const Vec3f &v2, const Vec3f &v3, float &ratioFromStartToEnd)
 return true if segment intersects triangle and set float ratios where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
bool intersect (const Vec3d &v1, const Vec3d &v2, const Vec3d &v3, double &ratioFromStartToEnd)
 return true if segment intersects triangle and set double ratios where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.
void mult (const LineSegment &seg, const Matrix &m)
 post multiply a segment by matrix.
void mult (const Matrix &m, const LineSegment &seg)
 pre multiply a segment by matrix.
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.
 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.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

virtual ~LineSegment ()
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Static Protected Member Functions

static bool intersectAndClip (vec_type &s, vec_type &e, const BoundingBox &bb)

Protected Attributes

vec_type _s
vec_type _e
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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Detailed Description

LineSegment class for representing a line segment.

Member Typedef Documentation

◆ value_type

◆ vec_type

Constructor & Destructor Documentation

◆ LineSegment() [1/3]

osg::LineSegment::LineSegment ( )
inline

Referenced by LineSegment(), mult(), mult(), and operator=().

◆ LineSegment() [2/3]

osg::LineSegment::LineSegment ( const LineSegment & seg)
inline

◆ LineSegment() [3/3]

osg::LineSegment::LineSegment ( const vec_type & s,
const vec_type & e )
inline

References _e, and _s.

◆ ~LineSegment()

virtual osg::LineSegment::~LineSegment ( )
protectedvirtual

Member Function Documentation

◆ end() [1/2]

vec_type & osg::LineSegment::end ( )
inline

References _e.

◆ end() [2/2]

const vec_type & osg::LineSegment::end ( ) const
inline

References _e.

◆ intersect() [1/4]

bool osg::LineSegment::intersect ( const BoundingBox & bb) const

return true if segment intersects BoundingBox.

◆ intersect() [2/4]

bool osg::LineSegment::intersect ( const BoundingSphere & bs) const

return true if segment intersects BoundingSphere.

◆ intersect() [3/4]

bool osg::LineSegment::intersect ( const Vec3d & v1,
const Vec3d & v2,
const Vec3d & v3,
double & ratioFromStartToEnd )

return true if segment intersects triangle and set double ratios where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ intersect() [4/4]

bool osg::LineSegment::intersect ( const Vec3f & v1,
const Vec3f & v2,
const Vec3f & v3,
float & ratioFromStartToEnd )

return true if segment intersects triangle and set float ratios where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ intersectAndClip()

bool osg::LineSegment::intersectAndClip ( vec_type & s,
vec_type & e,
const BoundingBox & bb )
staticprotected

◆ intersectAndComputeRatios() [1/4]

bool osg::LineSegment::intersectAndComputeRatios ( const BoundingBox & bb,
double & ratioFromStartToEnd1,
double & ratioFromStartToEnd2 ) const

return true if segment intersects BoundingBox and set double ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ intersectAndComputeRatios() [2/4]

bool osg::LineSegment::intersectAndComputeRatios ( const BoundingBox & bb,
float & ratioFromStartToEnd1,
float & ratioFromStartToEnd2 ) const

return true if segment intersects BoundingBox and set float ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ intersectAndComputeRatios() [3/4]

bool osg::LineSegment::intersectAndComputeRatios ( const BoundingSphere & bs,
double & ratioFromStartToEnd1,
double & ratioFromStartToEnd2 ) const

return true if segment intersects BoundingSphere and set double ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ intersectAndComputeRatios() [4/4]

bool osg::LineSegment::intersectAndComputeRatios ( const BoundingSphere & bs,
float & ratioFromStartToEnd1,
float & ratioFromStartToEnd2 ) const

return true if segment intersects BoundingSphere and set float ratios for the first and second intersections, where the ratio is 0.0 at the segment start point, and 1.0 at the segment end point.

◆ mult() [1/2]

void osg::LineSegment::mult ( const LineSegment & seg,
const Matrix & m )
inline

post multiply a segment by matrix.

References _e, _s, and LineSegment().

◆ mult() [2/2]

void osg::LineSegment::mult ( const Matrix & m,
const LineSegment & seg )
inline

pre multiply a segment by matrix.

References _e, _s, and LineSegment().

◆ operator=()

LineSegment & osg::LineSegment::operator= ( const LineSegment & seg)
inline

References _e, _s, and LineSegment().

◆ set()

void osg::LineSegment::set ( const vec_type & s,
const vec_type & e )
inline

References _e, and _s.

◆ start() [1/2]

vec_type & osg::LineSegment::start ( )
inline

References _s.

◆ start() [2/2]

const vec_type & osg::LineSegment::start ( ) const
inline

References _s.

◆ valid()

bool osg::LineSegment::valid ( ) const
inline

References _e, and _s.

Member Data Documentation

◆ _e

vec_type osg::LineSegment::_e
protected

◆ _s

vec_type osg::LineSegment::_s
protected

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

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.