fawkes::HomPoint Class Reference

A homogeneous point. More...

#include <geometry/hom_point.h>

Inheritance diagram for fawkes::HomPoint:

List of all members.

Public Member Functions
	HomPoint (float x=0.0, float y=0.0, float z=0.0)
	Constructor.
	HomPoint (cart_coord_2d_t coord)
	Constructor.
	HomPoint (cart_coord_3d_t coord)
	Constructor.
	HomPoint (const HomCoord &h)
	Constructor.
virtual	~HomPoint ()
	Destructor.
float	distance () const
	Obtain distance from the point to the origin.
HomPoint &	move (float dx, float dy, float dz)
	Move the point by the given coordiantes.
HomPoint &	move_to (float x, float y, float z)
	Move the point to the given coordiantes.
HomVector	operator- (const HomPoint &p) const
	Compute the vector between two points.
Public Member Functions inherited from fawkes::HomCoord
	HomCoord (const HomCoord &c)
	Copy constructor.
virtual	~HomCoord ()
	Destructor.
virtual float	x () const
	RO-getter for x.
virtual float &	x ()
	RW-getter for x.
virtual HomCoord &	x (float x)
	Setter function for x.
virtual float	y () const
	RO-getter for y.
virtual float &	y ()
	RW-getter for y.
virtual HomCoord &	y (float y)
	Setter function for y.
virtual float	z () const
	RO-getter for z.
virtual float &	z ()
	RW-getter for z.
virtual HomCoord &	z (float z)
	Setter function for z.
virtual float	w () const
	RO-getter for w.
virtual float &	w ()
	RW-getter for w.
virtual HomCoord &	w (float w)
	Setter function for w.
virtual HomCoord &	rotate_x (float rad)
	Convenience function to rotate the HomCoord around the x-axis.
virtual HomCoord &	rotate_y (float rad)
	Convenience function to rotate the HomCoord around the y-axis.
virtual HomCoord &	rotate_z (float rad)
	Convenience function to rotate the HomCoord around the z-axis.
HomCoord &	transform (const HomTransform &t)
	Transform the vector with the given transform.
virtual HomCoord	operator- (const HomCoord &h) const
	Subtraction operator.
virtual HomCoord &	operator-= (const HomCoord &h)
	Substraction-assignment operator.
virtual HomCoord	operator+ (const HomCoord &h) const
	Addition operator.
virtual HomCoord &	operator+= (const HomCoord &h)
	Addition-assignment operator.
virtual float	operator* (const HomCoord &h) const
	Calculates the dot product of two coords.
virtual HomCoord	operator* (const float s) const
	Mulitplication operator.
virtual HomCoord &	operator*= (const float s)
	Multiplication-assignment operator.
virtual HomCoord &	operator= (const HomCoord &h)
	Assignment operator.
virtual bool	operator== (const HomCoord &h) const
	Comparison operator.
virtual bool	operator!= (const HomCoord &h) const
	Inequality operator.
Public Member Functions inherited from fawkes::Printable
	Printable ()
	Constructor.
virtual	~Printable ()
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from fawkes::HomCoord
	HomCoord (float x=0.0, float y=0.0, float z=0.0, float w=0.0)
	Constructor.
	HomCoord (const Vector &v)
	Constructor.
virtual std::ostream &	print (std::ostream &stream) const
	Appends the components of the HomCoord to the ostream.
Protected Attributes inherited from fawkes::HomCoord
Vector *	m_vector
	The internal data container.

---

Detailed Description

A homogeneous point.

Author:

Daniel Beck

Definition at line 33 of file hom_point.h.

---

Constructor & Destructor Documentation

fawkes::HomPoint::HomPoint	(	float	x = 0.0,
		float	y = 0.0,
		float	z = 0.0
	)

Constructor.

Parameters:

x	the x-coordinate
y	the y-coordinate
z	the z-coordinate

Definition at line 42 of file hom_point.cpp.

fawkes::HomPoint::HomPoint

(

cart_coord_2d_t

coord

)

Constructor.

Constructs a 2-dimensional vector from a cart_coord_2d_t struct.

Parameters:

coord

a structure for a 2-dimensional coordinate

Definition at line 51 of file hom_point.cpp.

fawkes::HomPoint::HomPoint

(

cart_coord_3d_t

coord

)

Constructor.

Constructs a 3-dimensional vector from a cart_coord_3d_t struct.

Parameters:

coord

a structure for a 3-dimensional coordinate

Definition at line 60 of file hom_point.cpp.

fawkes::HomPoint::HomPoint

(

const HomCoord &

h

)

Constructor.

Parameters:

h	a HomCoord

Definition at line 68 of file hom_point.cpp.

References fawkes::HomCoord::w().

fawkes::HomPoint::~HomPoint ( )

virtual

Destructor.

Definition at line 80 of file hom_point.cpp.

---

Member Function Documentation

float fawkes::HomPoint::distance

(

)

const

Obtain distance from the point to the origin.

Returns:

distance to origin

Definition at line 88 of file hom_point.cpp.

References fawkes::HomCoord::x(), fawkes::HomCoord::y(), and fawkes::HomCoord::z().

HomPoint & fawkes::HomPoint::move	(	float	dx,
		float	dy,
		float	dz
	)

Move the point by the given coordiantes.

Parameters:

dx	x-offset
dy	y-offset
dz	z-offset

Returns:

reference to the moved point

Definition at line 101 of file hom_point.cpp.

References fawkes::HomCoord::x(), fawkes::HomCoord::y(), and fawkes::HomCoord::z().

HomPoint & fawkes::HomPoint::move_to	(	float	x,
		float	y,
		float	z
	)

Move the point to the given coordiantes.

Parameters:

x	new x-coordinate
y	new y-coordinate
z	new z-coordinate

Returns:

reference to the moved point

Definition at line 117 of file hom_point.cpp.

References fawkes::HomCoord::x(), fawkes::HomCoord::y(), and fawkes::HomCoord::z().

Referenced by fawkes::HomVectorDrawer::draw().

HomVector fawkes::HomPoint::operator-

(

const HomPoint &

p

)

const

Compute the vector between two points.

Parameters:

p	the other point

Returns:

the vector between the two points

Definition at line 131 of file hom_point.cpp.

References fawkes::HomCoord::x(), fawkes::HomCoord::y(), and fawkes::HomCoord::z().

---

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

• src/libs/geometry/hom_point.h
• src/libs/geometry/hom_point.cpp