---

SbLine Class Reference

The SbLine class represents a line in 3D space. More...

#include <Inventor/SbLinear.h>

List of all members.

Public Methods
	SbLine (void)
	SbLine (const SbVec3f &p0, const SbVec3f &p1)
void	setValue (const SbVec3f &p0, const SbVec3f &p1)
SbBool	getClosestPoints (const SbLine &line2, SbVec3f &ptOnThis, SbVec3f &ptOnLine2) const
SbVec3f	getClosestPoint (const SbVec3f &point) const
const SbVec3f &	getPosition (void) const
const SbVec3f &	getDirection (void) const
void	print (FILE *file) const

---

Detailed Description

The SbLine class represents a line in 3D space.

SbLine is used by many other classes in Coin. It provides a way of specifying a directed line (also known as a ray) through a specified point (origin) and a direction in 3D space. Note that the line is infinite in both directions from its definition point.

See also:

SbVec3f

---

Constructor & Destructor Documentation

SbLine::SbLine (  void    )

The empty constructor does nothing. The line will be uninitialized until the first assignment or setValue() call.

SbLine::SbLine (  const SbVec3f &    p0, const SbVec3f &    p1 )

Constructor with p0 specifying the line start point and p1 the line end point. p0 should not be the same as p1, as this will lead to having a null vector as the direction vector, which would cause division by zero problems in some of the other methods on this class.

---

Member Function Documentation

void SbLine::setValue (  const SbVec3f &    p0, const SbVec3f &    p1 )

Set new position and direction of the line by specifying line start point and end point. p0 should not be the same as p1, as this will lead to having a null vector as the direction vector, which would cause division by zero problems in some of the other methods on this class.

SbBool SbLine::getClosestPoints (  const SbLine &    line2, SbVec3f &    ptOnThis, SbVec3f &    ptOnLine2 )  const

Returns the two closest points on the lines. If the lines are parallel, all points are equally close and we return FALSE. If the lines are not parallel, the point positions will be stored in ptOnThis and ptOnLine2, and we'll return TRUE. See also: getClosestPoint().

SbVec3f SbLine::getClosestPoint (  const SbVec3f &    point )  const

Returns the point on the line which is closest to point. See also: getClosestPoints().

const SbVec3f & SbLine::getPosition (  void    )  const

Return a vector representing a point on the line.

const SbVec3f & SbLine::getDirection (  void    )  const

Return a vector representing the direction of the line. The direction vector will always be normalized.

void SbLine::print (  FILE *    fp )  const

Dump the state of this object to the file stream. Only works in debug version of library, method does nothing in an optimized compile.

---

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

• SbLine.cpp
• SbLine.h

---