Go::PlaneInt Class Reference
[Intersections]

Class representing planar algebraic intersection objects. More...

#include <PlaneInt.h>

Inheritance diagram for Go::PlaneInt:

List of all members.

Public Member Functions
	PlaneInt ()
	Constructor.
	PlaneInt (Point point, Point normal)
	Constructor.
	PlaneInt (double a, double b, double c, double d)
	Constructor.
virtual	~PlaneInt ()
	Constructor.
void	read (std::istream &is)
	Read a plane description from file.
double	a () const
	Get the x multiplicator.
double	b () const
	Get the y multiplicator.
double	c () const
	Get the z multiplicator.
double	d () const
	Get the constant.
boost::shared_ptr< SplineSurface >	surface (Point mid_pt, double length_x, double length_y) const
	Get a SplineSuface representing the plane.

---

Detailed Description

Class representing planar algebraic intersection objects.

Definition at line 56 of file PlaneInt.h.

---

Constructor & Destructor Documentation

Go::PlaneInt::PlaneInt

(

)

Constructor.

Used when reading from file.

Go::PlaneInt::PlaneInt	(	Point	point,
		Point	normal
	)

Constructor.

Parameters:

	point	reference point in the plane.
	normal	normal to the plane.

Go::PlaneInt::PlaneInt	(	double	a,
		double	b,
		double	c,
		double	d
	)

Constructor.

The plane is described by the expression .

Parameters:

	a	the x multiplicator.
	b	the y multiplicator.
	c	the z multiplicator.
	d	the constant.

---

Member Function Documentation

void Go::PlaneInt::read

(

std::istream &

is

)

Read a plane description from file.

Parameters:

is

the stream containing the plane description.

double Go::PlaneInt::a

(

)

const

Get the x multiplicator.

Returns:

a The x multiplicator.

double Go::PlaneInt::b

(

)

const

Get the y multiplicator.

Returns:

b The y multiplicator.

double Go::PlaneInt::c

(

)

const

Get the z multiplicator.

Returns:

c The z multiplicator.

double Go::PlaneInt::d

(

)

const

Get the constant.

Returns:

d The constant.

boost::shared_ptr<SplineSurface> Go::PlaneInt::surface	(	Point	mid_pt,
		double	length_x,
		double	length_y
	)			const

Get a SplineSuface representing the plane.

This can be used to visualize the object. Since the object is to be tesselated we make sure it is bounded.

Parameters:

	mid_pt	the intersection of the diagonals in a rectangle in the plane.
	length_x	the length of the rectangle in the x direction.
	length_y	the length of the rectangle in the y direction.

Returns:

The spline surface of the plane.

---

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

• PlaneInt.h

---