SPATMOD::IMAGE::DIMENSIONS Class Reference

Container for defining image dimensions. More...

#include <spatmod/imagedimensions.h>

List of all members.

Public Member Functions
	DIMENSIONS ()
const SPANS &	GetColumnSpans () const
INT32	GetNumColumnsOfTiles () const
double	GetNumColumnsPerTile (TILEPOSITION tileposition) const
INT32	GetNumRowsOfTiles () const
double	GetNumRowsPerTile (TILEPOSITION tileposition) const
const SPANS &	GetRowSpans () const
UINT32	GetTotalColumns () const
UINT32	GetTotalRows () const
bool	IsEqual (const DIMENSIONS &rhs) const
ERRVALUE	SetTileDimensions (double ColumnsPerTile, double RowsPerTile, double ColumnsPerTileFirst=0, double RowsPerTileFirst=0, double ColumnsPerTileLast=0, double RowsPerTileLast=0)
ERRVALUE	SetTotalDimensions (UINT32 TotalColumns, UINT32 TotalRows)

---

Detailed Description

Container for defining image dimensions.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::DIMENSIONS::DIMENSIONS

(

)

Constructor.

---

Member Function Documentation

const SPANS& SPATMOD::IMAGE::DIMENSIONS::GetColumnSpans

(

)

const [inline]

Get column spans.

INT32 SPATMOD::IMAGE::DIMENSIONS::GetNumColumnsOfTiles

(

)

const [inline]

Get number of columns of tiles "across" the image.

Returns:

Number of columns of tiles.

double SPATMOD::IMAGE::DIMENSIONS::GetNumColumnsPerTile

(

TILEPOSITION

tileposition

)

const

Get number of columns per tile.

Note that first and last tiles may have different sizes than each other or interior tiles. If GetNumColumnsOfTiles is less than 3 then will return 0 for TILEPOSITION_Interior. If GetNumColumnsOfTiles is less than 2 then the "last" tile will have same dimension as "first" tile.

Returns:

Number of columns per tile.

Parameters:

tileposition

Tile position

INT32 SPATMOD::IMAGE::DIMENSIONS::GetNumRowsOfTiles

(

)

const [inline]

Get number of rows of tiles "down" the image.

Returns:

Number of rows of tiles.

double SPATMOD::IMAGE::DIMENSIONS::GetNumRowsPerTile

(

TILEPOSITION

tileposition

)

const

Get number of rows per tile.

Note that first and last tiles may have different sizes than each other or interior tiles. If GetNumRowsOfTiles is less than 3 then will return 0 for TILEPOSITION_Interior. If GetNumRowsOfTiles is less than 2 then the "last" tile will have same dimension as "first" tile.

Returns:

Number of rows per tile.

Parameters:

tileposition

Tile position

const SPANS& SPATMOD::IMAGE::DIMENSIONS::GetRowSpans

(

)

const [inline]

Get row spans.

UINT32 SPATMOD::IMAGE::DIMENSIONS::GetTotalColumns

(

)

const [inline]

Get total number of columns in image.

Returns:

Total image columns.

UINT32 SPATMOD::IMAGE::DIMENSIONS::GetTotalRows

(

)

const [inline]

Get total number of rows in image.

Returns:

Total image rows.

bool SPATMOD::IMAGE::DIMENSIONS::IsEqual

(

const DIMENSIONS &

rhs

)

const [inline]

Test if DIMENSIONS are equal.

ERRVALUE SPATMOD::IMAGE::DIMENSIONS::SetTileDimensions	(	double	ColumnsPerTile,
		double	RowsPerTile,
		double	ColumnsPerTileFirst = 0,
		double	RowsPerTileFirst = 0,
		double	ColumnsPerTileLast = 0,
		double	RowsPerTileLast = 0
	)

Set tile dimensions.

ERRVALUE SPATMOD::IMAGE::DIMENSIONS::SetTotalDimensions	(	UINT32	TotalColumns,
		UINT32	TotalRows
	)

Set image dimensions.

Will reset tile dimensions to match image dimensions (resulting in "untiled" image).

---

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

• spatmod/imagedimensions.h