HiRISE
 PDS_JP2
UA::HiRISE::Point_2D

Point_2D Struct Reference

A Point_2D holds 2-dimensional position information. More...

#include <Dimensions.hh>

Inheritance diagram for Point_2D:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Point_2D ()
 Constructs a point at position 0,0.
 Point_2D (const int &x, const int &y)
 Constructs a point at position x,y.
 Point_2D (const Point_2D &point)
 Constructs a point from another point.
Point_2D & operator= (const Point_2D &point)
 Assign the position of another point to this point.
int x () const
 Get the horizontal (x-axis) position.
Point_2D & x (const int &x_position)
 Set the horizontal (x-axis) position.
int y () const
 Get the vertical (y-axis) position.
Point_2D & y (const int &y_position)
 Set the vertical (y-axis) position.

Public Attributes

int X
 The horizontal (x-axis) position of the point.
int Y
 The vertical (y-axis) position of the point.

Detailed Description

A Point_2D holds 2-dimensional position information.

Author:
Bradford Castalia, UA/PIRL
Version:
1.4

Constructor & Destructor Documentation

Point_2D (   ) 
 

Constructs a point at position 0,0.

Point_2D (  const int &  x,
const int &  y
) 
 

Constructs a point at position x,y.

Point_2D (  const Point_2D &  point  ) 
 

Constructs a point from another point.

Parameters:
point A Point_2D to be copied.

Member Function Documentation

Point_2D & operator= (  const Point_2D &  point  ) 
 

Assign the position of another point to this point.

Parameters:
point A Point_2D whose values are to be assigned to this point.

int x (   )  const [inline]
 

Get the horizontal (x-axis) position.

Returns:
The horizontal (x-axis) position of the point.

Point_2D& x (  const int &  x_position  )  [inline]
 

Set the horizontal (x-axis) position.

Parameters:
x_position The horizontal (x-axis) position of the point.
Returns:
This Point_2D.

int y (   )  const [inline]
 

Get the vertical (y-axis) position.

Returns:
The vertical (y-axis) position of the point.

Point_2D& y (  const int &  y_position  )  [inline]
 

Set the vertical (y-axis) position.

Parameters:
y_position The vertical (y-axis) position of the point.
Returns:
This Point_2D.

Member Data Documentation

int X
 

The horizontal (x-axis) position of the point.

int Y
 

The vertical (y-axis) position of the point.

The documentation for this struct was generated from the following files:
Generated on Tue Jul 15 14:22:55 2008 for UA::HiRISE::PDS_JP2 by  doxygen 1.4.6