inet::Plane Class Reference

This class represents a 2 dimensional plane in the 3 dimensional space. More...

#include <Plane.h>

Inheritance diagram for inet::Plane:

Public Member Functions
	Plane ()
	Plane (const Coord &basePoint, const Coord &normalVector)
const Coord &	getBasePoint ()
void	setBasePoint (const Coord &basePoint)
const Coord &	getNormalVector ()
void	setNormalVector (const Coord &normalVector)
virtual bool	isNil () const override
	Returns true if this geometric object is the same as the unspecified singleton instance of this type. More...
virtual bool	isUnspecified () const override
	Returns true if this geometric object is not completely specified. More...
Coord	computeIntersection (const LineSegment &lineSegment)
Public Member Functions inherited from inet::GeometricObjectBase
	GeometricObjectBase ()
virtual	~GeometricObjectBase ()

Static Public Attributes
static const Plane	NIL

Protected Attributes
Coord	basePoint
Coord	normalVector

Detailed Description

This class represents a 2 dimensional plane in the 3 dimensional space.

Constructor & Destructor Documentation

Plane() [1/2]

inet::Plane::Plane

(

)

             :
    basePoint(Coord::NIL),
    normalVector(Coord::NIL)
{
}

Plane() [2/2]

inet::Plane::Plane	(	const Coord &	basePoint,
		const Coord &	normalVector
	)

                                                              :
    basePoint(basePoint),
    normalVector(normalVector)
{
}

Member Function Documentation

computeIntersection()

Coord inet::Plane::computeIntersection

(

const LineSegment &

lineSegment

)

{
    // NOTE: based on http://paulbourke.net/geometry/pointlineplane/
    const Coord& point1 = lineSegment.getPoint1();
    const Coord& point2 = lineSegment.getPoint2();
    double denominator = normalVector * (point2 - point1);
    if (denominator == 0)
        return Coord::NIL;
    else {
        double numerator = normalVector * (basePoint - point1);
        double q = numerator / denominator;
        if (q < 0 || q > 1)
            return Coord::NIL;
        else
            return point1 * (1 - q) + point2 * q;
    }
}

getBasePoint()

const Coord& inet::Plane::getBasePoint ( )

inline

{ return basePoint; }

getNormalVector()

const Coord& inet::Plane::getNormalVector ( )

inline

{ return normalVector; }

isNil()

virtual bool inet::Plane::isNil ( ) const

inlineoverridevirtual

Returns true if this geometric object is the same as the unspecified singleton instance of this type.

Implements inet::GeometricObjectBase.

{ return this == &NIL; }

isUnspecified()

virtual bool inet::Plane::isUnspecified ( ) const

inlineoverridevirtual

Returns true if this geometric object is not completely specified.

Implements inet::GeometricObjectBase.

{ return basePoint.isUnspecified() || normalVector.isUnspecified(); }

setBasePoint()

void inet::Plane::setBasePoint ( const Coord &  basePoint )

inline

{ this->basePoint = basePoint; }

setNormalVector()

void inet::Plane::setNormalVector ( const Coord &  normalVector )

inline

{ this->normalVector = normalVector; }

Member Data Documentation

basePoint

Coord inet::Plane::basePoint

protected

Referenced by computeIntersection().

NIL

const Plane inet::Plane::NIL

static

normalVector

Coord inet::Plane::normalVector

protected

Referenced by computeIntersection().

---

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

• Plane.h
• Plane.cc