limbo::geometry::orientation_2d Class Reference

a class denoting orientation of lines More...

#include <Geometry.h>

Public Member Functions
	orientation_2d ()
	constructor
	orientation_2d (orientation_2d_enum const &ori)
	constructor More...
	orientation_2d (const orientation_2d &ori)
	copy constructor More...
orientation_2d &	operator= (const orientation_2d &ori)
	assignment More...
bool	operator== (orientation_2d const &rhs) const
	equality operator More...
bool	operator!= (orientation_2d const &rhs) const
	inequality operator More...
int	to_int () const
	convert orientation to integer More...
void	turn_90 ()
	turn 90 degree
orientation_2d	get_perpendicular () const
	get perpendicular orientation More...
bool	valid () const
	check whether the orientation is valid More...

Protected Attributes
int	m_orient
	enum type of orientation in integer representation

Friends
bool	operator< (orientation_2d const &ori1, orientation_2d const &ori2)
	less than operator More...

Detailed Description

a class denoting orientation of lines

Definition at line 92 of file Geometry.h.

Constructor & Destructor Documentation

limbo::geometry::orientation_2d::orientation_2d ( orientation_2d_enum const &  ori )

inline

constructor

Parameters

ori	enum type of orientation

Definition at line 99 of file Geometry.h.

limbo::geometry::orientation_2d::orientation_2d ( const orientation_2d &  ori )

inline

copy constructor

Parameters

ori	an orientation_2d object

Definition at line 103 of file Geometry.h.

Member Function Documentation

orientation_2d limbo::geometry::orientation_2d::get_perpendicular ( ) const

inline

get perpendicular orientation

Returns

perpendicular orientation

Definition at line 124 of file Geometry.h.

bool limbo::geometry::orientation_2d::operator!= ( orientation_2d const &  rhs ) const

inline

inequality operator

Parameters

rhs	object at right hand side

Returns

true if they are inequal

Definition at line 116 of file Geometry.h.

orientation_2d& limbo::geometry::orientation_2d::operator= ( const orientation_2d &  ori )

inline

assignment

Parameters

ori	an orientation_2d object

Returns

reference to the object

Definition at line 107 of file Geometry.h.

bool limbo::geometry::orientation_2d::operator== ( orientation_2d const &  rhs ) const

inline

equality operator

Parameters

rhs	object at right hand side

Returns

true if they are equal

Definition at line 112 of file Geometry.h.

int limbo::geometry::orientation_2d::to_int ( ) const

inline

convert orientation to integer

Returns

integer representation of the orientation

Definition at line 119 of file Geometry.h.

bool limbo::geometry::orientation_2d::valid ( ) const

inline

check whether the orientation is valid

Returns

true if it is valid

Definition at line 132 of file Geometry.h.

Friends And Related Function Documentation

bool operator< ( orientation_2d const &  ori1, orientation_2d const &  ori2  )

friend

less than operator

Parameters

ori1	orientation
ori2	orientation

Returns

true if ori1 is less than ori2

Definition at line 137 of file Geometry.h.

---

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

• /Users/yibolin/Documents/Projects/Limbo/limbo/geometry/Geometry.h