Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | List of all members
icl::utils::Point Class Reference

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

#include <Point.h>

Inheritance diagram for icl::utils::Point:

Public Member Functions

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

Static Public Attributes

static const Point null
 null Point is x=0, y=0 More...
 

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: