icl::utils::Point Class Reference

Point class of the ICL used e.g. for the Images ROI offset. More...

#include <Point.h>

List of all members.

Public Member Functions
	Point ()
	default constructor
	Point (const Point &p)
	deep copy of a Point
	Point (const Point32f &p)
	Create a point from given float point (values are rounded)
	Point (int x, int y)
	create a special point
bool	isNull () const
	checks wether the object instance is null, i.e. all elements are zero
bool	operator== (const Point &s) const
	checks if two points are equal
bool	operator!= (const Point &s) const
	checks if two points are not equal
Point	operator+ (const Point &s) const
	adds two Points as vectors
Point	operator- (const Point &s) const
	substracts two Points as vectors
Point	operator* (double d) const
	scales a Points variables with a scalar value
Point &	operator+= (const Point &s)
	Adds another Point inplace.
Point &	operator-= (const Point &s)
	Substacts another Point inplace.
Point &	operator*= (double d)
	scales the Point inplace with a scalar
Point	transform (double xfac, double yfac) const
	transforms the point by element-wise scaling
float	distanceTo (const Point &p) const
	returns the euclidian distance to another point
int &	operator[] (int i)
	index based interface (returns i?y:x)
const int &	operator[] (int i) const
	index based interface, const (returns i?y:x)
Static Public Attributes
static const Point	null
	null Point is x=0, y=0

---

Detailed Description

Point class of the ICL used e.g. for the Images ROI offset.

---

Constructor & Destructor Documentation

icl::utils::Point::Point

(

)

[inline]

default constructor

icl::utils::Point::Point

(

const Point &

p

)

[inline]

deep copy of a Point

icl::utils::Point::Point

(

const Point32f &

p

)

Create a point from given float point (values are rounded)

icl::utils::Point::Point	(	int	x,
		int	y
	)		[inline]

create a special point

---

Member Function Documentation

float icl::utils::Point::distanceTo

(

const Point &

p

)

const

returns the euclidian distance to another point

bool icl::utils::Point::isNull

(

)

const [inline]

checks wether the object instance is null, i.e. all elements are zero

bool icl::utils::Point::operator!=

(

const Point &

s

)

const [inline]

checks if two points are not equal

Point icl::utils::Point::operator*

(

double

d

)

const [inline]

scales a Points variables with a scalar value

Point& icl::utils::Point::operator*=

(

double

d

)

[inline]

scales the Point inplace with a scalar

Point icl::utils::Point::operator+

(

const Point &

s

)

const [inline]

adds two Points as vectors

Point& icl::utils::Point::operator+=

(

const Point &

s

)

[inline]

Adds another Point inplace.

Point icl::utils::Point::operator-

(

const Point &

s

)

const [inline]

substracts two Points as vectors

Point& icl::utils::Point::operator-=

(

const Point &

s

)

[inline]

Substacts another Point inplace.

bool icl::utils::Point::operator==

(

const Point &

s

)

const [inline]

checks if two points are equal

int& icl::utils::Point::operator[]

(

int

i

)

[inline]

index based interface (returns i?y:x)

const int& icl::utils::Point::operator[]

(

int

i

)

const [inline]

index based interface, const (returns i?y:x)

Point icl::utils::Point::transform	(	double	xfac,
		double	yfac
	)		const [inline]

transforms the point by element-wise scaling

---

Member Data Documentation

const Point icl::utils::Point::null [static]

null Point is x=0, y=0

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLUtils/src/ICLUtils/Point.h