TLIB documentation
 

tlLocation Class Reference

Inheritance diagram for tlLocation:

Inheritance graph
[legend]

List of all members.

Detailed Description

Location object.

Public Member Functions

 tlLocation ()
 tlLocation (int x, int y, int disp=0)
virtual ~tlLocation ()
int setLocation (int x, int y, int disp=0)
int setLocation (tlPoint *point)
int shift (int dx, int dy, int ddisp=0)
int setWorldLocation (float wx, float wy, float wz)
tlLocation * toLocation ()
int toLocation (tlLocation *location)

Public Attributes

int x
int y
int disp
float wx
float wy
float wz

Constructor & Destructor Documentation

tlLocation::tlLocation (  ) 

Constructor.

Note:
See error management for details.

tlLocation::tlLocation ( int  x,
int  y,
int  disp = 0 
)

Constructor.

Parameters:
x x location of the object [pix]
y y location of the object [pix]
disp disparity of the object [disp]
Note:
See error management for details.

tlLocation::~tlLocation (  )  [virtual]

Destructor.

Destructor.

Note:
See error management for details.

Member Function Documentation

int tlLocation::setLocation ( int  x,
int  y,
int  disp = 0 
)

Set the location object parameters.

Parameters:
x x location of the object [pix]
y y location of the object [pix]
disp disparity of the object [disp]
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::setLocation ( tlPoint *  point  ) 

Set the location object parameters.

Parameters:
point tlPoint object
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::shift ( int  dx,
int  dy,
int  ddisp = 0 
)

Shift the object location.

Parameters:
dx shift along x axis [pix]
dy shift along y axis [pix]
ddisp disparity shift [disp]
Returns:
0 on success, -1 otherwise.
See error management for details.

int tlLocation::setWorldLocation ( float  wx,
float  wy,
float  wz 
)

Set the world location object parameters.

Parameters:
wx world X location
wy world Y location
wz world Z location
Returns:
0 on success, -1 otherwise.
See error management for details.

tlLocation * tlLocation::toLocation (  ) 

Get a copy of the location of the object.

Returns:
A pointer to a tlLocation object containing the data.
Note:
It is the responsibility of the programmer to delete the object returned.

int tlLocation::toLocation ( tlLocation *  location  ) 

Get the location of the object.

Parameters:
location [out] tlLocation object that will receive the data
Returns:
0 on success, -1 otherwise.
See error management for details.

Member Data Documentation

int tlLocation::x

X location of the object [pix].

int tlLocation::y

Y location of the object [pix].

int tlLocation::disp

Disparity of the object [disp].

int tlLocation::wx

X location of the object in real-world coordonates [m].

int tlLocation::wy

Y location of the object in real-world coordonates [m].

int tlLocation::wz

Z location of the object in real-world coordonates [m].

The documentation for this class was generated from the following files:
TLIB documentation - generated on 7 May 2008
Please address any questions to seb@tuyphon.com
(C) 2001-2008 - S. Grange
(C) 2001-2007 - VRAI Group, EPFL
All Rights Reserved.