objtree::Plane Class Reference

#include <plane.h>

Inheritance diagram for objtree::Plane:

List of all members.

Public Member Functions
const Point &	boundingMax () const
const Point &	boundingMin () const
virtual bool	fitsIntoBox (const Box &box) const
virtual bool	interfereWithBox (const Box &box) const
virtual bool	isPointInside (float x, float y, float z) const
virtual bool	isSimilar (const Object *object) const
const Vector &	normal () const
	Plane (const Point &center, const Vector &normal, const Point &scale)
	Plane (const Polygon &points)
const Polygon &	points () const
const Point &	pos () const
Private Attributes
Point	m_boundingMax
Point	m_boundingMin
float	m_d
Vector	m_normal
Polygon	m_points
Point	m_pos

---

Detailed Description

Plane class. Represent plane in octree.

Definition at line 43 of file plane.h.

---

Constructor & Destructor Documentation

objtree::Plane::Plane	(	const Point &	center,
		const Vector &	normal,
		const Point &	scale
	)

A constructor. Creates plane from center point, normal and scale.

Parameters:

center	center point
normal	plane normal
scale	size of plane bounding box

Definition at line 82 of file plane.cpp.

objtree::Plane::Plane

(

const Polygon &

points

)

A constructor. Creates plane from a polygon.

Parameters:

points

polygon

Definition at line 40 of file plane.cpp.

---

Member Function Documentation

const Point& objtree::Plane::boundingMax

(

)

const [inline]

Definition at line 65 of file plane.h.

const Point& objtree::Plane::boundingMin

(

)

const [inline]

Definition at line 64 of file plane.h.

bool objtree::Plane::fitsIntoBox

(

const Box &

box

)

const [virtual]

Returns true if plane fits into a box. TODO: Not implemented.

Parameters:

box	box for test

Returns:

true if plane fits into a box, false otherwise

Implements objtree::Object.

Definition at line 108 of file plane.cpp.

bool objtree::Plane::interfereWithBox

(

const Box &

box

)

const [virtual]

Returns true if plane interferes with a box.

Parameters:

box	box for test

Returns:

true if plane interferes with box, false otherwise

Implements objtree::Object.

Definition at line 118 of file plane.cpp.

bool objtree::Plane::isPointInside	(	float	x,
		float	y,
		float	z
	)		const [virtual]

Check if point is on a plane.

Parameters:

x
y
z

Returns:

true if point is on a plane, false otherwise

Implements objtree::Object.

Definition at line 175 of file plane.cpp.

bool objtree::Plane::isSimilar

(

const Object *

object

)

const [virtual]

Compare other object for similarity.

Parameters:

object

object to compare

Returns:

true if object is similar, false otherwise

Implements objtree::Object.

Definition at line 150 of file plane.cpp.

const Vector& objtree::Plane::normal

(

)

const [inline]

Definition at line 62 of file plane.h.

const Polygon& objtree::Plane::points

(

)

const [inline]

Definition at line 63 of file plane.h.

const Point& objtree::Plane::pos

(

)

const [inline]

Definition at line 61 of file plane.h.

---

Member Data Documentation

Point objtree::Plane::m_boundingMax [private]

Definition at line 50 of file plane.h.

Point objtree::Plane::m_boundingMin [private]

Definition at line 50 of file plane.h.

float objtree::Plane::m_d [private]

Definition at line 49 of file plane.h.

Vector objtree::Plane::m_normal [private]

Definition at line 47 of file plane.h.

Polygon objtree::Plane::m_points [private]

Definition at line 48 of file plane.h.

Point objtree::Plane::m_pos [private]

Definition at line 46 of file plane.h.

---

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

• plane.h
• plane.cpp