PIRL++

# Dimensions.hh File Reference

`#include <iosfwd>`
Include dependency graph for Dimensions.hh:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes

struct  PIRL::Point_2D
A Point_2D holds 2-dimensional position information. More...
struct  PIRL::Size_2D
A Size_2D holds 2-dimensional size information. More...
struct  PIRL::Rectangle
A Rectangle is a position with a size. More...
struct  PIRL::Cube
A Cube is a Rectangle with depth. More...

## Namespaces

namespace  PIRL

The Planetary Image Research Laboratory.

## Defines

#define COORDINATE_TYPE   int
#define DIMENSIONS_TYPE   unsigned COORDINATE_TYPE

## Typedefs

typedef COORDINATE_TYPE PIRL::Coordinate_Type
The integer data type of a coordinate value.
typedef DIMENSIONS_TYPE PIRL::Dimensions_Type
The integer data type of a dimension value.

## Functions

Coordinate_Type PIRL::Round (double number)
Rounds a floating point number to the nearest integer value.
Point_2D PIRL::operator+ (const Point_2D &point_1, const Point_2D &point_2)
Point_2D PIRL::operator- (const Point_2D &point_1, const Point_2D &point_2)
Subtract one point from another.
Point_2D PIRL::operator- (const Point_2D &point)
Get the negation of a point.
Point_2D PIRL::operator* (const Point_2D &point, double factor)
Multiply a point by a factor.
Point_2D PIRL::operator* (double factor, const Point_2D &point)
Multiply a point by a factor.
Point_2D PIRL::operator/ (const Point_2D &point, double factor)
Divide a point by a factor.
std::ostream & PIRL::operator<< (std::ostream &stream, const Point_2D &point)
Print a Point_2D description to an output stream.
Size_2D PIRL::operator+ (const Size_2D &size_1, const Size_2D &size_2)
Size_2D PIRL::operator- (const Size_2D &size_1, const Size_2D &size_2)
Subtract one size from another.
Size_2D PIRL::operator* (const Size_2D &size, double factor)
Multiply a size by a factor.
Size_2D PIRL::operator* (double factor, const Size_2D &size)
Multiply a size by a factor.
Size_2D PIRL::operator/ (const Size_2D &size, double factor)
Divide a size by a factor.
std::ostream & PIRL::operator<< (std::ostream &stream, const Size_2D &size)
Print a Size_2D description to an output stream.
Rectangle PIRL::operator+ (const Rectangle &rectangle, const Point_2D &point)
Add a Point_2D offset to a Rectangle.
Rectangle PIRL::operator+ (const Point_2D &point, const Rectangle &rectangle)
Add a Point_2D offset to a Rectangle.
Rectangle PIRL::operator+ (const Rectangle &rectangle_1, const Rectangle &rectangle_2)
Rectangle PIRL::operator- (const Rectangle &rectangle, const Point_2D &point)
Subtract a Point_2D offset from a Rectangle.
Rectangle PIRL::operator- (const Rectangle &rectangle_1, const Rectangle &rectangle_2)
Subtract two Rectangles.
Rectangle PIRL::operator- (const Rectangle &rectangle)
Get the negation of a Rectangle.
Rectangle PIRL::operator+ (const Rectangle &rectangle, const Size_2D &size)
Add a size amount to a Rectangle.
Rectangle PIRL::operator+ (const Size_2D &size, const Rectangle &rectangle)
Add a size amount to a Rectangle.
Rectangle PIRL::operator- (const Rectangle &rectangle, const Size_2D &size)
Subtract a size amount from a Rectangle.
Rectangle PIRL::operator* (const Rectangle &rectangle, double factor)
Multiply a Rectangle by a factor.
Rectangle PIRL::operator* (double factor, const Rectangle &rectangle)
Multiply a Rectangle by a factor.
Rectangle PIRL::operator/ (const Rectangle &rectangle, double factor)
Divide a Rectangle by a factor.
Rectangle PIRL::operator& (const Rectangle &rectangle_1, const Rectangle &rectangle_2)
Get the intersection of two Rectangles.
Rectangle & PIRL::operator| (const Rectangle &rectangle_1, const Rectangle &rectangle_2)
Get the union of two Rectangles.
std::ostream & PIRL::operator<< (std::ostream &stream, const Rectangle &rectangle)
Print a Rectangle description to an output stream.
Cube PIRL::operator+ (const Cube &cube, int amount)
Add an amount to a Cube Depth.
Cube PIRL::operator- (const Cube &cube, int amount)
Subtract an amount from a Cube Depth.
Cube PIRL::operator+ (const Cube &cube_1, const Cube &cube_2)
Cube PIRL::operator- (const Cube &cube_1, const Cube &cube_2)
Subtract two Cubes.
Cube PIRL::operator* (const Cube &cube, double factor)
Multiply a Cube by a factor.
Cube PIRL::operator* (double factor, const Cube &cube)
Multiply a Cube by a factor.
Cube PIRL::operator/ (const Cube &cube, double factor)
Divide a Cube by a factor.
Cube PIRL::operator& (const Cube &cube_1, const Cube &cube_2)
Get the intersection of two Cubes.
Cube & PIRL::operator| (const Cube &cube_1, const Cube &cube_2)
Get the union of two Cubes.
std::ostream & PIRL::operator<< (std::ostream &stream, const Cube &cube)
Print a Cube description to an output stream.

## Define Documentation

 #define COORDINATE_TYPE   int
 #define DIMENSIONS_TYPE   unsigned COORDINATE_TYPE