#include <points.h>

Public Member Functions
	FCOORD ()
	empty constructor More...

	FCOORD (float xvalue, float yvalue)

	FCOORD (ICOORD icoord)

float	x () const

float	y () const

void	set_x (float xin)
	rewrite function More...

void	set_y (float yin)
	rewrite function More...

float	sqlength () const
	find sq length More...

float	length () const
	find length More...

float	pt_to_pt_sqdist (const FCOORD &pt) const
	sq dist between pts More...

float	pt_to_pt_dist (const FCOORD &pt) const
	Distance between pts. More...

float	angle () const
	find angle More...

uinT8	to_direction () const

void	from_direction (uinT8 direction)

FCOORD	nearest_pt_on_line (const FCOORD &line_point, const FCOORD &dir_vector) const

bool	normalise ()
	Convert to unit vec. More...

BOOL8	operator== (const FCOORD &other)
	test equality More...

BOOL8	operator!= (const FCOORD &other)
	test inequality More...

void	rotate (const FCOORD vec)

void	unrotate (const FCOORD &vec)

Static Public Member Functions
static uinT8	binary_angle_plus_pi (double angle)

static double	angle_from_direction (uinT8 direction)

Friends
FCOORD	operator! (const FCOORD &)
	rotate 90 deg anti More...

FCOORD	operator- (const FCOORD &)
	unary minus More...

FCOORD	operator+ (const FCOORD &, const FCOORD &)
	add More...

FCOORD &	operator+= (FCOORD &, const FCOORD &)
	add More...

FCOORD	operator- (const FCOORD &, const FCOORD &)
	subtract More...

FCOORD &	operator-= (FCOORD &, const FCOORD &)
	subtract More...

float	operator% (const FCOORD &, const FCOORD &)
	scalar product More...

float	operator* (const FCOORD &, const FCOORD &)
	cross product More...

FCOORD	operator* (const FCOORD &, float)
	multiply More...

FCOORD	operator* (float, const FCOORD &)
	multiply More...

FCOORD &	operator*= (FCOORD &, float)
	multiply More...

FCOORD	operator/ (const FCOORD &, float)
	divide More...

FCOORD &	operator/= (FCOORD &, float)
	divide More...

Detailed Description

Definition at line 189 of file points.h.

Constructor & Destructor Documentation

FCOORD::FCOORD ( )

inline

empty constructor

Definition at line 193 of file points.h.

193 {

194 }

FCOORD::FCOORD	(	float	xvalue,
		float	yvalue
	)

inline

constructor

Parameters

xvalue	x value
yvalue	y value

Definition at line 198 of file points.h.

                          {
       xcoord = xvalue;           //set coords
       ycoord = yvalue;
     }

FCOORD::FCOORD ( ICOORD icoord )

inline

Definition at line 203 of file points.h.

                           {  //coords to set
       xcoord = icoord.xcoord;
       ycoord = icoord.ycoord;
     }

Member Function Documentation

float FCOORD::angle ( ) const

inline

find angle

Definition at line 249 of file points.h.

                         {
       return (float) atan2 (ycoord, xcoord);
     }

double FCOORD::angle_from_direction ( uinT8 direction )

static

Definition at line 129 of file points.cpp.

                                                    {
   return direction * M_PI / 128.0 - M_PI;
 }

uinT8 FCOORD::binary_angle_plus_pi ( double angle )

static

Definition at line 124 of file points.cpp.

                                                  {
   return Modulo(IntCastRounded((radians + M_PI) * 128.0 / M_PI), 256);
 }

void FCOORD::from_direction ( uinT8 direction )

Definition at line 115 of file points.cpp.

                                            {
   double radians = angle_from_direction(direction);
   xcoord = cos(radians);
   ycoord = sin(radians);
 }

float FCOORD::length ( ) const

inline

find length

Definition at line 230 of file points.h.

                          {
       return (float) sqrt (sqlength ());
     }

FCOORD FCOORD::nearest_pt_on_line	(	const FCOORD &	line_point,
		const FCOORD &	dir_vector
	)		const

Definition at line 136 of file points.cpp.

                                                                   {
   FCOORD point_vector(*this - line_point);
   // The dot product (%) is |dir_vector||point_vector|cos theta, so dividing by
   // the square of the length of dir_vector gives us the fraction of dir_vector
   // to add to line1 to get the appropriate point, so
   // result = line1 + lambda dir_vector.
   double lambda = point_vector % dir_vector / dir_vector.sqlength();
   return line_point + (dir_vector * lambda);
 }

bool FCOORD::normalise ( )

Convert to unit vec.

BOOL8 FCOORD::operator!= ( const FCOORD & other )

inline

test inequality

Definition at line 280 of file points.h.

                                             {
       return xcoord != other.xcoord || ycoord != other.ycoord;
     }

BOOL8 FCOORD::operator== ( const FCOORD & other )

inline

test equality

Definition at line 276 of file points.h.

                                             {
       return xcoord == other.xcoord && ycoord == other.ycoord;
     }

float FCOORD::pt_to_pt_dist ( const FCOORD & pt ) const

inline

Distance between pts.

Definition at line 244 of file points.h.

                                                 {
       return (float) sqrt (pt_to_pt_sqdist (pt));
     }

float FCOORD::pt_to_pt_sqdist ( const FCOORD & pt ) const

inline

sq dist between pts

Definition at line 235 of file points.h.

                                                   {
       FCOORD gap;
 
       gap.xcoord = xcoord - pt.xcoord;
       gap.ycoord = ycoord - pt.ycoord;
       return gap.sqlength ();
     }

void FCOORD::rotate ( const FCOORD vec )

inline

rotate

Parameters

vec by vector

Definition at line 471 of file ipoints.h.

                                              {
   float tmp;
 
   tmp = xcoord * vec.x () - ycoord * vec.y ();
   ycoord = ycoord * vec.x () + xcoord * vec.y ();
   xcoord = tmp;
 }

void FCOORD::set_x ( float xin )

inline

rewrite function

Definition at line 216 of file points.h.

                           {
       xcoord = xin;              //write new value
     }

void FCOORD::set_y ( float yin )

inline

rewrite function

Definition at line 220 of file points.h.

                           {  //value to set
       ycoord = yin;
     }

float FCOORD::sqlength ( ) const

inline

find sq length

Definition at line 225 of file points.h.

                            {
       return xcoord * xcoord + ycoord * ycoord;
     }

uinT8 FCOORD::to_direction ( ) const

Definition at line 111 of file points.cpp.

                                  {
   return binary_angle_plus_pi(angle());
 }

void FCOORD::unrotate ( const FCOORD & vec )

inline

Definition at line 480 of file ipoints.h.

                                               {
   rotate(FCOORD(vec.x(), -vec.y()));
 }

float FCOORD::x ( ) const

inline

Definition at line 209 of file points.h.

                     {  //get coords
       return xcoord;
     }

float FCOORD::y ( ) const

inline

Definition at line 212 of file points.h.

                     {
       return ycoord;
     }

Friends And Related Function Documentation

FCOORD operator! ( const FCOORD & src )

friend

rotate 90 deg anti

Definition at line 258 of file ipoints.h.

   {
   FCOORD result;                 //output
 
   result.xcoord = -src.ycoord;
   result.ycoord = src.xcoord;
   return result;
 }

float operator%	(	const FCOORD &	op1,
		const FCOORD &	op2
	)

friend

scalar product

Definition at line 362 of file ipoints.h.

                     {
   return op1.xcoord * op2.xcoord + op1.ycoord * op2.ycoord;
 }

float operator*	(	const FCOORD &	op1,
		const FCOORD &	op2
	)

friend

cross product

Definition at line 375 of file ipoints.h.

                                            {
   return op1.xcoord * op2.ycoord - op1.ycoord * op2.xcoord;
 }

FCOORD operator*	(	const FCOORD &	op1,
		float	scale
	)

friend

multiply

Definition at line 388 of file ipoints.h.

                                       {
   FCOORD result;                 //output
 
   result.xcoord = op1.xcoord * scale;
   result.ycoord = op1.ycoord * scale;
   return result;
 }

FCOORD operator*	(	float	scale,
		const FCOORD &	op1
	)

friend

multiply

Definition at line 399 of file ipoints.h.

                           {
   FCOORD result;                 //output
 
   result.xcoord = op1.xcoord * scale;
   result.ycoord = op1.ycoord * scale;
   return result;
 }

FCOORD& operator*=	(	FCOORD &	op1,
		float	scale
	)

friend

multiply

Definition at line 418 of file ipoints.h.

              {
   op1.xcoord *= scale;
   op1.ycoord *= scale;
   return op1;
 }

FCOORD operator+	(	const FCOORD &	op1,
		const FCOORD &	op2
	)

friend

add

Definition at line 294 of file ipoints.h.

                     {
   FCOORD sum;                    //result
 
   sum.xcoord = op1.xcoord + op2.xcoord;
   sum.ycoord = op1.ycoord + op2.ycoord;
   return sum;
 }

FCOORD& operator+=	(	FCOORD &	op1,
		const FCOORD &	op2
	)

friend

add

Definition at line 312 of file ipoints.h.

                     {
   op1.xcoord += op2.xcoord;
   op1.ycoord += op2.ycoord;
   return op1;
 }

FCOORD operator- ( const FCOORD & src )

friend

unary minus

Definition at line 276 of file ipoints.h.

   {
   FCOORD result;                 //output
 
   result.xcoord = -src.xcoord;
   result.ycoord = -src.ycoord;
   return result;
 }

FCOORD operator-	(	const FCOORD &	op1,
		const FCOORD &	op2
	)

friend

subtract

Definition at line 328 of file ipoints.h.

                     {
   FCOORD sum;                    //result
 
   sum.xcoord = op1.xcoord - op2.xcoord;
   sum.ycoord = op1.ycoord - op2.ycoord;
   return sum;
 }

FCOORD& operator-=	(	FCOORD &	op1,
		const FCOORD &	op2
	)

friend

subtract

Definition at line 346 of file ipoints.h.

                     {
   op1.xcoord -= op2.xcoord;
   op1.ycoord -= op2.ycoord;
   return op1;
 }

FCOORD operator/	(	const FCOORD &	op1,
		float	scale
	)

friend

divide

Definition at line 434 of file ipoints.h.

              {
   FCOORD result;                 //output
 
   if (scale != 0) {
     result.xcoord = op1.xcoord / scale;
     result.ycoord = op1.ycoord / scale;
   }
   return result;
 }

FCOORD& operator/=	(	FCOORD &	op1,
		float	scale
	)

friend

divide

Definition at line 454 of file ipoints.h.

              {
   if (scale != 0) {
     op1.xcoord /= scale;
     op1.ycoord /= scale;
   }
   return op1;
 }

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

ccstruct/points.h
ccstruct/ipoints.h
ccstruct/points.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation