SPATMOD::IMAGE::TILESET Class Reference

Container for tileset definition. More...

#include <spatmod/imagetileset.h>

List of all members.

Classes

class  FILTER
class  LIST
 webtilesets.xml reader More...
class  POSN
 Container for representing position within tileset. More...
class  RANGE
 Range of positions within tileset. More...
struct  TransparentColor
 struct for holding transparent color settings More...

Public Types

enum  IMGFORMAT {
  IMGFORMAT_Invalid = 0x00000000, IMGFORMAT_8bit = 0x00000001, IMGFORMAT_16bit = 0x00000002, IMGFORMAT_16bitA = 0x00000004,
  IMGFORMAT_16bitOLD = 0x00000008, IMGFORMAT_24bit = 0x00000010, IMGFORMAT_32bit = 0x00000020, IMGFORMAT_Terrain = 0x00000040,
  IMGFORMAT_PNG = 0x00000080, IMGFORMAT_JPEG = 0x00000100, IMGFORMAT_TIFF = 0x00000200, IMGFORMAT_GIF = 0x00000400,
  IMGFORMAT_JP2 = 0x00000800, IMGFORMAT_SVG = 0x00001000, IMGFORMAT_SVGZ = (IMGFORMAT_SVG|1), IMGFORMAT_PNG8 = (IMGFORMAT_PNG|IMGFORMAT_8bit),
  IMGFORMAT_PNG24 = (IMGFORMAT_PNG|IMGFORMAT_24bit), IMGFORMAT_PNG16Terrain = (IMGFORMAT_PNG|IMGFORMAT_16bit|IMGFORMAT_Terrain), IMGFORMAT_PNG16TerrainA = (IMGFORMAT_PNG|IMGFORMAT_16bitA|IMGFORMAT_Terrain), IMGFORMAT_PNG16TerrainOLD = (IMGFORMAT_PNG|IMGFORMAT_16bitOLD|IMGFORMAT_Terrain),
  IMGFORMAT_PNG24Terrain = (IMGFORMAT_PNG|IMGFORMAT_24bit|IMGFORMAT_Terrain), IMGFORMAT_PNG32Terrain = (IMGFORMAT_PNG|IMGFORMAT_32bit|IMGFORMAT_Terrain), IMGFORMAT_TIFF8 = (IMGFORMAT_TIFF|IMGFORMAT_8bit), IMGFORMAT_TIFF24 = (IMGFORMAT_TIFF|IMGFORMAT_24bit),
  IMGFORMAT_Auto_PNG8_JPEG = (IMGFORMAT_PNG8|IMGFORMAT_JPEG), IMGFORMAT_Auto_PNG24_JPEG = (IMGFORMAT_PNG24|IMGFORMAT_JPEG)
}
enum  PROFILE { PROFILE_None = 0, PROFILE_Local = 1, PROFILE_Global_Geographic = 2, PROFILE_Global_WebMercator = 3 }
enum  STRUCTURE { STRUCTURE_Hierarchical = 0, STRUCTURE_Flat = 1, STRUCTURE_WorldWind = 2 }
enum  TARGET {
  TARGET_Undefined = 0, TARGET_GoogleMaps = 1, TARGET_GoogleEarth = 2, TARGET_BingMaps = 3,
  TARGET_NASAWorldWind = 4
}
enum  TYPE {
  TYPE_None = 0x0000, TYPE_Image = 0x0001, TYPE_Terrain = 0x0002, TYPE_KML = 0x0004,
  TYPE_SVG = 0x0008, TYPE_DAE = 0x0010
}

Public Member Functions

 TILESET ()
 ~TILESET ()
void AddTileFormat (const IMAGE::FORMAT &format)
void Clear ()
void CloseZipFiles ()
double ComputeCellSize (INT32 level, bool UseExtents=false) const
ERRVALUE ComputeExtents (DRECT2D &Extents, INT32 level, INT32 TileColumn1, INT32 TileRow1, INT32 TileColumn2, INT32 TileRow2) const
ERRVALUE ComputeExtents (DRECT2D &Extents, INT32 level, INT32 TileColumn, INT32 TileRow) const
ERRVALUE ComputeExtents (DRECT2D &Extents, const LPOINT3D &TileIdx) const
ERRVALUE ComputeExtents (DRECT2D &Extents, INT32 level) const
ERRVALUE ComputeGeoreference (INT32 level, GEOREFERENCE &Georeference) const
INT32 ComputeMaxLevel (const LPOINT2D &SrcImageSize, const GEOREFERENCE &SrcGeoreference) const
INT32 ComputeMinLevel (const REGION2D &MapRegion, INT32 MaxLevel=-1) const
ERRVALUE ComputeTileRange (const DRECT2D &Extents, INT32 level, TILESET::RANGE &TileRange, bool IsOnBorder=false) const
ERRVALUE ComputeTileRangeGeog (const DRECT2D &GeogExtents, INT32 level, TILESET::RANGE &TileRange, bool IsOnBorder=false) const
ERRVALUE Create (const SPATREF::COORDREFSYS &crs, INT32 TileSize, double CellSize=0)
ERRVALUE Create (PROFILE profile, INT32 TileSize)
ERRVALUE CreateAuxiliaryFiles (const MISTRING &BaseURL, bool bOverwriteExisting=true, TILESET::TARGET Target=TILESET::TARGET_Undefined, INT32 MinLevel=-1)
ERRVALUE CreateAuxiliaryFiles (bool bOverwriteExisting=true, TILESET::TARGET Target=TILESET::TARGET_Undefined, INT32 MinLevel=-1)
ERRVALUE CreateReducedLevel (const FILEPATH &SourcePath, const FILEPATH &TargetPath, INT32 level, IMGFORMAT ImgFormat=IMGFORMAT_Invalid, UINT16 QualityJPEG=75, TILESET::TARGET Target=TILESET::TARGET_Undefined, MISTRING message=TEXTID_Creating_ResolutionLevelN, bool bZipOutput=false)
ERRVALUE CreateReducedLevel (INT32 level, IMGFORMAT ImgFormat=IMGFORMAT_Invalid, UINT16 QualityJPEG=75, TILESET::TARGET Target=TILESET::TARGET_Undefined, MISTRING message=TEXTID_Creating_ResolutionLevelN, bool bZipOutput=false)
bool FindKMLFile (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile, MISTRING &TileName)
const FORMAT * FindTileFile (INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile, MISTRING &TileName)
const FORMAT * FindTileFile (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile, MISTRING &TileName)
const FORMAT * FindTileFile (INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile)
const FORMAT * FindTileFile (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile) const
ERRVALUE GeneratePixelRangeMap (INT32 level=-1)
ERRVALUE GenerateRegionTileMap ()
ERRVALUE GenerateTerrainXML ()
ERRVALUE GenerateTileFilePath (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx, FILEPATH &PathTileFile, const FORMAT *pFormat=0, bool MakeFolder=false) const
ERRVALUE GenerateTileMap (INT32 level=-1)
ERRVALUE GenerateTilesetTest ()
double GetBaseCellSize () const
INT32 GetBaseLevel () const
INT32 GetBaseTileCount () const
void GetCacheLocationPath (FILEPATH &CacheLocationPath)
MISTRING GetCellSizeDisplayStr (INT32 level) const
const SPATREF::COORDREFSYS & GetCRS () const
XMLNODE * GetDateList () const
XMLNODE * GetDateRange () const
const DRECT2D & GetExtentsInCRS () const
void GetImgFormat (IMGFORMAT &ImgFormat, PIXEL &PixelProperties)
void GetImgFormat (IMGFORMAT &ImgFormat)
const MISTRINGLIST & GetLocalLocationLevelStrings () const
void GetLocalLocationPath (FILEPATH &LocationPath, INT32 level=-1)
MISTRING GetLocalLocationString (INT32 level=-1)
const MISTRINGLIST & GetLocalLocationStrings () const
double GetMargin () const
INT32 GetMaxLevel () const
MISTRING GetMetadata () const
INT32 GetMinLevel () const
const RVC::OBJITEM & GetObjItem ()
void GetPath (FILEPATH &path)
double GetPixelValueMax () const
double GetPixelValueMin () const
INT64 GetPostscaleOffset () const
INT64 GetPrescaleOffset () const
PROFILE GetProfile () const
void GetProperties (MISTRING &properties, bool ShowExtents=true)
MISTRING GetReferenceLocation () const
const MISTRINGLIST & GetRemoteLocationLevelStrings () const
MISTRING GetRemoteLocationString (INT32 level=-1)
const MISTRINGLIST & GetRemoteLocationStrings () const
double GetScale () const
INT32 GetScaleDenominator () const
INT32 GetScaleNumerator () const
STRUCTURE GetStructure ()
TARGET GetTarget ()
const FORMAT & GetTileFormat (bool HasNullCells) const
const MILIST< FORMAT > & GetTileFormatList () const
ERRVALUE GetTileRange (INT32 level, TILESET::RANGE &TileRange) const
INT32 GetTileSize () const
MISTRING GetTitle () const
ERRVALUE GetTopLeftTile (INT32 level, LPOINT2D &TileIdx) const
void GetTransparentColorList (MILIST< TransparentColor > &TransparentColors)
const DATETIME & GetTSDLastMod ()
TYPE GetType ()
INT32 HasDate () const
bool HasSourceTiles (INT32 level, INT32 row)
bool HasSourceTiles (const FILEPATH &PathBaseFolder, INT32 level, INT32 row)
bool HasSourceTiles (INT32 level, const LPOINT2D &TileIdx)
bool HasSourceTiles (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx)
bool HasTile (INT32 level, const LPOINT2D &TileIdx)
bool HasTile (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx)
bool HasTiles (INT32 level, INT32 row, bool bClear=false)
bool HasTiles (const FILEPATH &PathBaseFolder, INT32 level, INT32 row, bool bClear=false)
ERRVALUE ReadTSD (const XMLDOC &doc)
ERRVALUE ReadTSD (const MISTRING &URL)
ERRVALUE ReadTSD (const FILEPATH &filepath)
ERRVALUE ReadTSD (const RVC::OBJITEM &objitem)
ERRVALUE ScanTilesetTest ()
void SetBaseCellSize (double BaseCellSize)
void SetBaseTileCount (INT32 TileCount)
ERRVALUE SetExtents (const DRECT2D &ExtentsInCRS, INT32 MinLevel, INT32 MaxLevel, bool IsOnBorder=false)
void SetMargin (double margin)
ERRVALUE SetMaxTileRange (const TILESET::RANGE &TileRange)
void SetMetadata (const MISTRING &metadata)
void SetPath (const FILEPATH &path)
void SetPixelValueRange (double PixelValueMin, double PixelValueMax)
void SetPostscaleOffset (INT64 offset)
void SetPrescaleOffset (INT64 offset)
void SetRemoteLocationStrings (const MISTRINGLIST &RemoteLocationStrings)
void SetScale (double Scale)
void SetScaleRational (INT32 Numerator, INT32 Denominator)
void SetTileFormat (const IMAGE::FORMAT &format)
void SetTileSize (INT32 TileSize)
void SetTitle (const MISTRING &title)
void SetType (TYPE type)
void SetURL (const MISTRING &URL)
ERRVALUE Unzip (const FILEPATH &TileFolderBasePath, const FILEPATH &TargetPath, bool bDeleteAfterUnzip=false)
ERRVALUE Unzip (const FILEPATH &TileFolderBasePath, bool bDeleteAfterUnzip=false)
ERRVALUE WriteKML (const FILEPATH &PathBaseFolder, INT32 level, const LPOINT2D &TileIdx)
ERRVALUE WriteTSD (const FILEPATH &filepath, INT32 MinLevel=-1)
ERRVALUE WriteTSD (const FILEPATH &filepath, const MISTRINGLIST &LocationList, const MISTRINGLIST &LocalLevelLocationList, const MISTRINGLIST &RemoteLevelLocationList, INT32 MinLevel=-1)
ERRVALUE WriteTSD (const FILEPATH &filepath, const FILEPATH &PathBaseFolder, const MISTRINGLIST &LocalLevelLocationList, const MISTRINGLIST &RemoteLevelLocationList, INT32 MinLevel=-1)
ERRVALUE WriteTSD (const FILEPATH &filepath, const MISTRINGLIST &LocationList, INT32 MinLevel=-1)
ERRVALUE WriteTSD (const FILEPATH &filepath, const FILEPATH &PathBaseFolder, INT32 MinLevel=-1)
ERRVALUE Zip (const FILEPATH &TileFolderBasePath, const FILEPATH &TargetPath, bool bDeleteAfterZip=false)
ERRVALUE Zip (const FILEPATH &TileFolderBasePath, bool bDeleteAfterZip=false)
ERRVALUE ZipLevel (const FILEPATH &TileFolderBasePath, const FILEPATH &TargetPath, INT32 level, bool bDeleteAfterZip=false, MITHREAD::QUEUE *Queue=NULL)
ERRVALUE ZipLevel (const FILEPATH &TileFolderBasePath, INT32 level, bool bDeleteAfterZip=false)

Static Public Member Functions

static void RegisterTSDFileType ()
static void SaveAs (const MISTRING &url, const FILEPATH &filepath)
static void TSDFileTypeGetDescription (MISTRING &description, const RVC::OBJITEM &objitem)
static void TSDFileTypeGetProperties (MISTRING &properties, const RVC::OBJITEM &objitem, bool ShowExtents)
static void TSDFileTypeGetProperties (MISTRING &properties, const RVC::OBJITEM &objitem)
static void TSDFileTypeGetProperties (MISTRING &properties, const FILEPATH &filepath)

Detailed Description

Container for tileset definition.

Member Enumeration Documentation

enum SPATMOD::IMAGE::TILESET::IMGFORMAT

Format of external image files.

Enumerator:
IMGFORMAT_Invalid 

Invalid format.

IMGFORMAT_8bit 

8 bit

IMGFORMAT_16bit 

16 bit

IMGFORMAT_16bitA 

16 bit

IMGFORMAT_16bitOLD 

16 bit

IMGFORMAT_24bit 

24 bit

IMGFORMAT_32bit 

32 bit

IMGFORMAT_Terrain 

Terarin.

IMGFORMAT_PNG 

PNG file.

IMGFORMAT_JPEG 

JPEG file.

IMGFORMAT_TIFF 

TIFF file.

IMGFORMAT_GIF 

JP2 file.

IMGFORMAT_JP2 

JP2 file.

IMGFORMAT_SVG 

SVG file.

IMGFORMAT_SVGZ 

SVGZ file.

IMGFORMAT_PNG8 

8-bit PNG file

IMGFORMAT_PNG24 

24-bit PNG file

IMGFORMAT_PNG16Terrain 

16-bit Terrain

IMGFORMAT_PNG16TerrainA 

16-bit Terrain

IMGFORMAT_PNG16TerrainOLD 

16-bit Terrain

IMGFORMAT_PNG24Terrain 

24-bit Terrain

IMGFORMAT_PNG32Terrain 

32-bit Terrain

IMGFORMAT_TIFF8 

8-bit TIFF file

IMGFORMAT_TIFF24 

24-bit TIFF file

IMGFORMAT_Auto_PNG8_JPEG 

Automatically use PNG or JPEG depending on whether need validity/opacity. Uses 8-bit PNGs.

IMGFORMAT_Auto_PNG24_JPEG 

Automatically use PNG or JPEG depending on whether need validity/opacity. Uses 24-bit PNGs.

enum SPATMOD::IMAGE::TILESET::PROFILE

Tileset profile.

Enumerator:
PROFILE_None 
PROFILE_Local 
PROFILE_Global_Geographic 
PROFILE_Global_WebMercator 
enum SPATMOD::IMAGE::TILESET::STRUCTURE
Enumerator:
STRUCTURE_Hierarchical 
STRUCTURE_Flat 
STRUCTURE_WorldWind 
enum SPATMOD::IMAGE::TILESET::TARGET
Enumerator:
TARGET_Undefined 
TARGET_GoogleMaps 
TARGET_GoogleEarth 
TARGET_BingMaps 
TARGET_NASAWorldWind 
enum SPATMOD::IMAGE::TILESET::TYPE
Enumerator:
TYPE_None 
TYPE_Image 
TYPE_Terrain 
TYPE_KML 
TYPE_SVG 
TYPE_DAE 

Constructor & Destructor Documentation

SPATMOD::IMAGE::TILESET::TILESET (  ) 

Default constructor, creates undefined tileset.

SPATMOD::IMAGE::TILESET::~TILESET (  ) 

Destructor.

Member Function Documentation

void SPATMOD::IMAGE::TILESET::AddTileFormat ( const IMAGE::FORMAT &  format  ) 

Add additional tile format and optional extension.

Used for tilesets that use multiple tile formats (ie mixed JPEG and PNG).

Parameters:
format Image format
void SPATMOD::IMAGE::TILESET::Clear (  ) 
void SPATMOD::IMAGE::TILESET::CloseZipFiles (  ) 

Close any zip files left open by FindTileFile.

double SPATMOD::IMAGE::TILESET::ComputeCellSize ( INT32  level,
bool  UseExtents = false 
) const

Compute cell size for specified zoom level.

Cell size in profile-specific CRS units returned.

Parameters:
level Zoom level (0-30)
UseExtents Use location of data to determine cellsize (for mercator)
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeExtents ( DRECT2D &  Extents,
INT32  level,
INT32  TileColumn1,
INT32  TileRow1,
INT32  TileColumn2,
INT32  TileRow2 
) const

Compute extents for range of tiles.

Parameters:
Extents Extents in tileset CRS returned
level Zoom level (0-30)
TileColumn1 Absolute left tile column on overall grid
TileRow1 Absolute top tile row on overall grid
TileColumn2 Absolute right tile column on overall grid
TileRow2 Absolute bottom tile row on overall grid
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeExtents ( DRECT2D &  Extents,
INT32  level,
INT32  TileColumn,
INT32  TileRow 
) const [inline]

Compute extents for single tile.

Parameters:
Extents Extents in tileset CRS returned
level Zoom level (0-30)
TileColumn Absolute tile column on overall grid
TileRow Absolute tile row on overall grid
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeExtents ( DRECT2D &  Extents,
const LPOINT3D &  TileIdx 
) const [inline]

Compute extents for single tile.

Parameters:
Extents Extents in tileset CRS returned
TileIdx Absolute tile index
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeExtents ( DRECT2D &  Extents,
INT32  level 
) const

Compute extents for entire level.

Parameters:
Extents Extents in tileset CRS returned
level Zoom level (0-30)
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeGeoreference ( INT32  level,
GEOREFERENCE &  Georeference 
) const

Compute georeference for specified zoom level relative to top-left tile.

Parameters:
level Zoom level (0-30)
Georeference Georeference returned
INT32 SPATMOD::IMAGE::TILESET::ComputeMaxLevel ( const LPOINT2D &  SrcImageSize,
const GEOREFERENCE &  SrcGeoreference 
) const

Compute maximum zoom level to maintain all of source image detail.

Parameters:
SrcImageSize Source image size
SrcGeoreference Source image georeference
INT32 SPATMOD::IMAGE::TILESET::ComputeMinLevel ( const REGION2D &  MapRegion,
INT32  MaxLevel = -1 
) const

Compute zoom level where specified region is smaller than single tile.

Note that actual result may have up to 4 tiles if region overlaps tile boundaries.

Parameters:
MapRegion Region in any map coordinates (may differ from tileset CRS)
MaxLevel Maximum level, -1 (default) to use previously
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeTileRange ( const DRECT2D &  Extents,
INT32  level,
TILESET::RANGE &  TileRange,
bool  IsOnBorder = false 
) const

Compute tile range and padding values from extentand zoom level.

Parameters:
Extents Extents in tileset CRS
level Zoom level (0-30)
TileRange Absolute tile range returned
IsOnBorder True if extents boundary lies on borders between tiles
ERRVALUE SPATMOD::IMAGE::TILESET::ComputeTileRangeGeog ( const DRECT2D &  GeogExtents,
INT32  level,
TILESET::RANGE &  TileRange,
bool  IsOnBorder = false 
) const

Compute tile range and padding values from geographic extent and zoom level.

Parameters:
GeogExtents Geographic extents in degrees
level Zoom level (0-30)
TileRange Absolute tile range returned
IsOnBorder True if extents boundary lies on borders between tiles
ERRVALUE SPATMOD::IMAGE::TILESET::Create ( const SPATREF::COORDREFSYS &  crs,
INT32  TileSize,
double  CellSize = 0 
)

Create with local profile based on CRS, tile size and cell size.

Parameters:
crs CRS for local profile
TileSize Tile size
CellSize Base level cell size, usually at maximum zoom level, 0 if will be set later
ERRVALUE SPATMOD::IMAGE::TILESET::Create ( PROFILE  profile,
INT32  TileSize 
)

Create using profile and tile size.

Parameters:
profile Profile, should not be Local
TileSize Tile size
ERRVALUE SPATMOD::IMAGE::TILESET::CreateAuxiliaryFiles ( const MISTRING &  BaseURL,
bool  bOverwriteExisting = true,
TILESET::TARGET  Target = TILESET::TARGET_Undefined,
INT32  MinLevel = -1 
)

Create the auxiliary tileset files (html/xml/kml).

Parameters:
BaseURL Server location where html will be
bOverwriteExisting Write over any existing files
Target Target to create files for. Default will determine target from tileset.
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::CreateAuxiliaryFiles ( bool  bOverwriteExisting = true,
TILESET::TARGET  Target = TILESET::TARGET_Undefined,
INT32  MinLevel = -1 
)

Create the auxiliary tileset files (html/xml/kml).

Parameters:
bOverwriteExisting Write over any existing files
Target Target to create files for. Default will determine target from tileset.
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::CreateReducedLevel ( const FILEPATH &  SourcePath,
const FILEPATH &  TargetPath,
INT32  level,
IMGFORMAT  ImgFormat = IMGFORMAT_Invalid,
UINT16  QualityJPEG = 75,
TILESET::TARGET  Target = TILESET::TARGET_Undefined,
MISTRING  message = TEXTID_Creating_ResolutionLevelN,
bool  bZipOutput = false 
)

Create reduced resolution level.

Parameters:
SourcePath Location of source tiles
TargetPath Location to output tiles
level Zoom level to compute.
ImgFormat ImgFormat to use for output files. Default will determine from tileset.
QualityJPEG Quality of JPEG output
Target Target to create files for. Default will determine from tileset.
message Context message to display
bZipOutput zip tileset
ERRVALUE SPATMOD::IMAGE::TILESET::CreateReducedLevel ( INT32  level,
IMGFORMAT  ImgFormat = IMGFORMAT_Invalid,
UINT16  QualityJPEG = 75,
TILESET::TARGET  Target = TILESET::TARGET_Undefined,
MISTRING  message = TEXTID_Creating_ResolutionLevelN,
bool  bZipOutput = false 
)

Create reduced resolution level.

Parameters:
level Zoom level to compute.
ImgFormat ImgFormat to use for output files. Default will determine from tileset.
QualityJPEG Quality of JPEG output
Target Target to create files for. Default will determine from tileset.
message Context message to display
bZipOutput zip tileset
bool SPATMOD::IMAGE::TILESET::FindKMLFile ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile,
MISTRING &  TileName 
)

Find KML file.

Returns:
False if not found.
Parameters:
PathBaseFolder Path to base folder
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
TileName Name of tile found
const FORMAT* SPATMOD::IMAGE::TILESET::FindTileFile ( INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile,
MISTRING &  TileName 
)

Find tile file and format.

Uses sourcepath read from TSD

Returns:
Pointer to format for tile file if found, NULL if not found.
Parameters:
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
TileName Name of tile found
const FORMAT* SPATMOD::IMAGE::TILESET::FindTileFile ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile,
MISTRING &  TileName 
)

Find tile file and format.

Returns:
Pointer to format for tile file if found, NULL if not found.
Parameters:
PathBaseFolder Path to base folder
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
TileName Name of tile found
const FORMAT* SPATMOD::IMAGE::TILESET::FindTileFile ( INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile 
)

Find tile file and format.

Uses sourcepath read from TSD

Returns:
Pointer to format for tile file if found, NULL if not found.
Parameters:
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
const FORMAT* SPATMOD::IMAGE::TILESET::FindTileFile ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile 
) const

Find tile file and format.

Returns:
Pointer to format for tile file if found, NULL if not found.
Parameters:
PathBaseFolder Path to base folder
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
ERRVALUE SPATMOD::IMAGE::TILESET::GeneratePixelRangeMap ( INT32  level = -1  ) 

Generate pixel range map.

ERRVALUE SPATMOD::IMAGE::TILESET::GenerateRegionTileMap (  ) 

Generate region tile map.

ERRVALUE SPATMOD::IMAGE::TILESET::GenerateTerrainXML (  ) 

Generate xml snippet for terrain tileset.

ERRVALUE SPATMOD::IMAGE::TILESET::GenerateTileFilePath ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx,
FILEPATH &  PathTileFile,
const FORMAT *  pFormat = 0,
bool  MakeFolder = false 
) const

Generate path for tile file.

Parameters:
PathBaseFolder Path to base folder
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
PathTileFile Path to tile file returned
pFormat Optional format, if 0 will use first one set for tileset
MakeFolder Create folder if does not exist
ERRVALUE SPATMOD::IMAGE::TILESET::GenerateTileMap ( INT32  level = -1  ) 

Generate tile map.

ERRVALUE SPATMOD::IMAGE::TILESET::GenerateTilesetTest (  ) 

Make tileset test table.

double SPATMOD::IMAGE::TILESET::GetBaseCellSize (  )  const [inline]

Get base cell size for "local" profile.

Returns:
Base cell size specified in Create(), undefined if not using local profile.
INT32 SPATMOD::IMAGE::TILESET::GetBaseLevel (  )  const [inline]

Get level corresponding to base cell size for "local" profile.

Returns:
Base level, undefined if not using local profile.
INT32 SPATMOD::IMAGE::TILESET::GetBaseTileCount (  )  const [inline]

Get number of tiles at base level in y direction.

void SPATMOD::IMAGE::TILESET::GetCacheLocationPath ( FILEPATH &  CacheLocationPath  ) 

Get location to cache if defined in TSD.

MISTRING SPATMOD::IMAGE::TILESET::GetCellSizeDisplayStr ( INT32  level  )  const

Get display string for cell size.

Parameters:
level Zoom level (0-30)
const SPATREF::COORDREFSYS& SPATMOD::IMAGE::TILESET::GetCRS (  )  const [inline]

Get Coordinate Reference System.

XMLNODE* SPATMOD::IMAGE::TILESET::GetDateList (  )  const [inline]

Get node containing list of dates to use.

XMLNODE* SPATMOD::IMAGE::TILESET::GetDateRange (  )  const [inline]

Get node containing date range to use.

const DRECT2D& SPATMOD::IMAGE::TILESET::GetExtentsInCRS (  )  const [inline]

Get extents in tileset CRS.

void SPATMOD::IMAGE::TILESET::GetImgFormat ( IMGFORMAT &  ImgFormat,
PIXEL &  PixelProperties 
)

Determine format from tileset.

void SPATMOD::IMAGE::TILESET::GetImgFormat ( IMGFORMAT &  ImgFormat  ) 

Determine format from tileset.

const MISTRINGLIST& SPATMOD::IMAGE::TILESET::GetLocalLocationLevelStrings (  )  const [inline]

Get list of all level specific local location strings, TSD must have been read.

List size is number of levels, starts at minlevel. Contains empty string if no level specific location

void SPATMOD::IMAGE::TILESET::GetLocalLocationPath ( FILEPATH &  LocationPath,
INT32  level = -1 
)

Get location path for local tileset, TSD must have been read Will return level specific location if one exists.

If using a list of locations, will iterate through list and return next location

Parameters:
level Optional level to get location for
MISTRING SPATMOD::IMAGE::TILESET::GetLocalLocationString ( INT32  level = -1  ) 

Get location string for local tileset, TSD must have been read.

Will return level specific location if one exists. If using a list of locations, will iterate through list and return next location

Parameters:
level Optional level to get location for
const MISTRINGLIST& SPATMOD::IMAGE::TILESET::GetLocalLocationStrings (  )  const [inline]

Get list of all local location strings, TSD must have been read.

double SPATMOD::IMAGE::TILESET::GetMargin (  )  const [inline]

Get margin (svg tileset).

INT32 SPATMOD::IMAGE::TILESET::GetMaxLevel (  )  const [inline]

Get maximum zoom level defined.

MISTRING SPATMOD::IMAGE::TILESET::GetMetadata (  )  const [inline]

Get metadata.

INT32 SPATMOD::IMAGE::TILESET::GetMinLevel (  )  const [inline]

Get minimum zoom level defined.

const RVC::OBJITEM& SPATMOD::IMAGE::TILESET::GetObjItem (  )  [inline]

Get objitem of tsd.

void SPATMOD::IMAGE::TILESET::GetPath ( FILEPATH &  path  )  [inline]

Get path of TSD if it has been read or written.

double SPATMOD::IMAGE::TILESET::GetPixelValueMax (  )  const [inline]
double SPATMOD::IMAGE::TILESET::GetPixelValueMin (  )  const [inline]
INT64 SPATMOD::IMAGE::TILESET::GetPostscaleOffset (  )  const [inline]

Get postscale offset.

INT64 SPATMOD::IMAGE::TILESET::GetPrescaleOffset (  )  const [inline]

Get prescale offset.

PROFILE SPATMOD::IMAGE::TILESET::GetProfile (  )  const [inline]

Get profile.

void SPATMOD::IMAGE::TILESET::GetProperties ( MISTRING &  properties,
bool  ShowExtents = true 
)

Get details about tileset as string.

MISTRING SPATMOD::IMAGE::TILESET::GetReferenceLocation (  )  const [inline]

Get reference location.

const MISTRINGLIST& SPATMOD::IMAGE::TILESET::GetRemoteLocationLevelStrings (  )  const [inline]

Get list of all level specific remote location strings, TSD must have been read.

List size is number of levels, starts at minlevel. Contains empty string if no level specific location

MISTRING SPATMOD::IMAGE::TILESET::GetRemoteLocationString ( INT32  level = -1  ) 

Get location string for online tileset, TSD must have been read Will return level specific location if one exists.

If using a list of locations, will iterate through list and return next location

Parameters:
level Optional level to get location for
const MISTRINGLIST& SPATMOD::IMAGE::TILESET::GetRemoteLocationStrings (  )  const [inline]

Get list of all remote location strings, TSD must have been read.

double SPATMOD::IMAGE::TILESET::GetScale (  )  const [inline]

Get scale to meters.

INT32 SPATMOD::IMAGE::TILESET::GetScaleDenominator (  )  const [inline]
INT32 SPATMOD::IMAGE::TILESET::GetScaleNumerator (  )  const [inline]
STRUCTURE SPATMOD::IMAGE::TILESET::GetStructure (  ) 

Get structure.

TARGET SPATMOD::IMAGE::TILESET::GetTarget (  ) 

Get target tileset.

const FORMAT& SPATMOD::IMAGE::TILESET::GetTileFormat ( bool  HasNullCells  )  const

Get preferred tile format.

const MILIST<FORMAT>& SPATMOD::IMAGE::TILESET::GetTileFormatList (  )  const [inline]

Get list of tile formats used.

ERRVALUE SPATMOD::IMAGE::TILESET::GetTileRange ( INT32  level,
TILESET::RANGE &  TileRange 
) const

Get tile range at specified zoom level.

Parameters:
level Zoom level, must be in previously specified range
TileRange Tile range returned
INT32 SPATMOD::IMAGE::TILESET::GetTileSize (  )  const [inline]

Get tile size.

MISTRING SPATMOD::IMAGE::TILESET::GetTitle (  )  const [inline]

Get title;.

ERRVALUE SPATMOD::IMAGE::TILESET::GetTopLeftTile ( INT32  level,
LPOINT2D &  TileIdx 
) const

Get top left tile for specified zoom level.

Parameters:
level Zoom level, must be in previously specified range
TileIdx Top left tile index returned
void SPATMOD::IMAGE::TILESET::GetTransparentColorList ( MILIST< TransparentColor > &  TransparentColors  )  [inline]

Get list of transparent colors for tileset.

const DATETIME& SPATMOD::IMAGE::TILESET::GetTSDLastMod (  )  [inline]

Return time when tsd was last modified.

TYPE SPATMOD::IMAGE::TILESET::GetType (  )  [inline]

Get type.

INT32 SPATMOD::IMAGE::TILESET::HasDate (  )  const

Determine if TSD contains date to use in location 0 if no date 1 if date list 2 if date range or [d] specified in location.

bool SPATMOD::IMAGE::TILESET::HasSourceTiles ( INT32  level,
INT32  row 
)

Determine if specified row has any source tiles from next level down. Uses sourcepath read from TSD.

bool SPATMOD::IMAGE::TILESET::HasSourceTiles ( const FILEPATH &  PathBaseFolder,
INT32  level,
INT32  row 
)

Determine if specified row has any source tiles from next level down.

bool SPATMOD::IMAGE::TILESET::HasSourceTiles ( INT32  level,
const LPOINT2D &  TileIdx 
)

Determine if specified tile has at least 1 source tile from next level down. Uses sourcepath read from TSD.

bool SPATMOD::IMAGE::TILESET::HasSourceTiles ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx 
)

Determine if specified tile has at least 1 source tile from next level down.

bool SPATMOD::IMAGE::TILESET::HasTile ( INT32  level,
const LPOINT2D &  TileIdx 
)

Determine if specified tile exists. Uses sourcepath read from TSD.

bool SPATMOD::IMAGE::TILESET::HasTile ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx 
)

Determine if specified tile exists.

bool SPATMOD::IMAGE::TILESET::HasTiles ( INT32  level,
INT32  row,
bool  bClear = false 
)

Determine if specified row has any tiles. Uses sourcepath read from TSD.

bool SPATMOD::IMAGE::TILESET::HasTiles ( const FILEPATH &  PathBaseFolder,
INT32  level,
INT32  row,
bool  bClear = false 
)

Determine if specified row has any tiles.

ERRVALUE SPATMOD::IMAGE::TILESET::ReadTSD ( const XMLDOC &  doc  ) 

Read and parse TSD from xml.

ERRVALUE SPATMOD::IMAGE::TILESET::ReadTSD ( const MISTRING &  URL  ) 

Read and parse TSD from URL.

ERRVALUE SPATMOD::IMAGE::TILESET::ReadTSD ( const FILEPATH &  filepath  ) 

Read and parse TSD from filepath.

ERRVALUE SPATMOD::IMAGE::TILESET::ReadTSD ( const RVC::OBJITEM &  objitem  ) 

Read and parse TSD from objitem.

static void SPATMOD::IMAGE::TILESET::RegisterTSDFileType (  )  [static]
static void SPATMOD::IMAGE::TILESET::SaveAs ( const MISTRING &  url,
const FILEPATH &  filepath 
) [static]
ERRVALUE SPATMOD::IMAGE::TILESET::ScanTilesetTest (  ) 

Scan tileset test table.

void SPATMOD::IMAGE::TILESET::SetBaseCellSize ( double  BaseCellSize  )  [inline]

Set base cell size for local profile.

void SPATMOD::IMAGE::TILESET::SetBaseTileCount ( INT32  TileCount  )  [inline]

Set number of tiles at base level in y direction.

Default is 1. For case of geographic profile, default would be 1x2 tiles at level 0. Mercator would be 1x1. If TileCount was 5, then number of tiles would be 5x10 for geographic and 5x5 for mercator.

ERRVALUE SPATMOD::IMAGE::TILESET::SetExtents ( const DRECT2D &  ExtentsInCRS,
INT32  MinLevel,
INT32  MaxLevel,
bool  IsOnBorder = false 
)

Set spatial and zoom level extents.

Parameters:
ExtentsInCRS Extents in tileset CRS at maximum zoom level
MinLevel Minimum zoom level (0-30)
MaxLevel Maximum zoom level, should not exceed base level if local profile
IsOnBorder True if extents boundary lies on borders between tiles
void SPATMOD::IMAGE::TILESET::SetMargin ( double  margin  )  [inline]

Set margin (for svg tileset).

ERRVALUE SPATMOD::IMAGE::TILESET::SetMaxTileRange ( const TILESET::RANGE &  TileRange  ) 

Set tile range for max level. Will compute range for all levels.

Parameters:
TileRange Tile Range at max level
void SPATMOD::IMAGE::TILESET::SetMetadata ( const MISTRING &  metadata  )  [inline]

Set metadata.

void SPATMOD::IMAGE::TILESET::SetPath ( const FILEPATH &  path  )  [inline]

Set path of TSD.

void SPATMOD::IMAGE::TILESET::SetPixelValueRange ( double  PixelValueMin,
double  PixelValueMax 
) [inline]

Set pixel range values to be written to ttsd.

void SPATMOD::IMAGE::TILESET::SetPostscaleOffset ( INT64  offset  )  [inline]

Set Postscale offset.

void SPATMOD::IMAGE::TILESET::SetPrescaleOffset ( INT64  offset  )  [inline]

Set prescale offset.

void SPATMOD::IMAGE::TILESET::SetRemoteLocationStrings ( const MISTRINGLIST &  RemoteLocationStrings  )  [inline]

Manually set list of urls. Used in bing maps.

void SPATMOD::IMAGE::TILESET::SetScale ( double  Scale  )  [inline]

Set scale to meters.

void SPATMOD::IMAGE::TILESET::SetScaleRational ( INT32  Numerator,
INT32  Denominator 
) [inline]
void SPATMOD::IMAGE::TILESET::SetTileFormat ( const IMAGE::FORMAT &  format  ) 

Set tile format and optional extension.

Will clear all previous tile formats.

Parameters:
format Image format
void SPATMOD::IMAGE::TILESET::SetTileSize ( INT32  TileSize  )  [inline]

Set tile size.

void SPATMOD::IMAGE::TILESET::SetTitle ( const MISTRING &  title  )  [inline]

Set title.

void SPATMOD::IMAGE::TILESET::SetType ( TYPE  type  )  [inline]

Set type.

void SPATMOD::IMAGE::TILESET::SetURL ( const MISTRING &  URL  )  [inline]

Set URL of TSD.

static void SPATMOD::IMAGE::TILESET::TSDFileTypeGetDescription ( MISTRING &  description,
const RVC::OBJITEM &  objitem 
) [static]
static void SPATMOD::IMAGE::TILESET::TSDFileTypeGetProperties ( MISTRING &  properties,
const RVC::OBJITEM &  objitem,
bool  ShowExtents 
) [static]
static void SPATMOD::IMAGE::TILESET::TSDFileTypeGetProperties ( MISTRING &  properties,
const RVC::OBJITEM &  objitem 
) [static]
static void SPATMOD::IMAGE::TILESET::TSDFileTypeGetProperties ( MISTRING &  properties,
const FILEPATH &  filepath 
) [static]
ERRVALUE SPATMOD::IMAGE::TILESET::Unzip ( const FILEPATH &  TileFolderBasePath,
const FILEPATH &  TargetPath,
bool  bDeleteAfterUnzip = false 
)

Unzip tileset to location.

Parameters:
TileFolderBasePath Location of tile folder
TargetPath Target Location
bDeleteAfterUnzip Delete zip files after unzipping
ERRVALUE SPATMOD::IMAGE::TILESET::Unzip ( const FILEPATH &  TileFolderBasePath,
bool  bDeleteAfterUnzip = false 
)

Unzip tileset.

Parameters:
TileFolderBasePath Location of tile folder
bDeleteAfterUnzip Delete zip files after unzipping
ERRVALUE SPATMOD::IMAGE::TILESET::WriteKML ( const FILEPATH &  PathBaseFolder,
INT32  level,
const LPOINT2D &  TileIdx 
)

Write KML file for a Google Earth tile.

Parameters:
PathBaseFolder Path to base folder
level Zoom level
TileIdx Absolute tile index within defined tile range for zoom level
ERRVALUE SPATMOD::IMAGE::TILESET::WriteTSD ( const FILEPATH &  filepath,
INT32  MinLevel = -1 
)

Write descriptive file in TSD format. Uses same locations set by ReadTSD.

Parameters:
filepath TSD path
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::WriteTSD ( const FILEPATH &  filepath,
const MISTRINGLIST &  LocationList,
const MISTRINGLIST &  LocalLevelLocationList,
const MISTRINGLIST &  RemoteLevelLocationList,
INT32  MinLevel = -1 
)

Write descriptive file in TSD format.

Parameters:
filepath TSD path
LocationList Location list of tile folders
LocalLevelLocationList Location list of level specific tile folders
RemoteLevelLocationList Location list of level specific tile folders
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::WriteTSD ( const FILEPATH &  filepath,
const FILEPATH &  PathBaseFolder,
const MISTRINGLIST &  LocalLevelLocationList,
const MISTRINGLIST &  RemoteLevelLocationList,
INT32  MinLevel = -1 
)

Write descriptive file in TSD format.

Parameters:
filepath TSD path
PathBaseFolder Location of tile folder
LocalLevelLocationList Location list of level specific tile folders
RemoteLevelLocationList Location list of level specific tile folders
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::WriteTSD ( const FILEPATH &  filepath,
const MISTRINGLIST &  LocationList,
INT32  MinLevel = -1 
)

Write descriptive file in TSD format.

Parameters:
filepath TSD path
LocationList Location list of tile folders
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::WriteTSD ( const FILEPATH &  filepath,
const FILEPATH &  PathBaseFolder,
INT32  MinLevel = -1 
)

Write descriptive file in TSD format.

Parameters:
filepath TSD path
PathBaseFolder Location of tile folder
MinLevel Minimum zoom level to include
ERRVALUE SPATMOD::IMAGE::TILESET::Zip ( const FILEPATH &  TileFolderBasePath,
const FILEPATH &  TargetPath,
bool  bDeleteAfterZip = false 
)

Zip tileset.

Parameters:
TileFolderBasePath Location of tile folder
TargetPath Target Location
bDeleteAfterZip Delete source tiles after zipping
ERRVALUE SPATMOD::IMAGE::TILESET::Zip ( const FILEPATH &  TileFolderBasePath,
bool  bDeleteAfterZip = false 
)

Zip tileset.

Parameters:
TileFolderBasePath Location of tile folder
bDeleteAfterZip Delete source tiles after zipping
ERRVALUE SPATMOD::IMAGE::TILESET::ZipLevel ( const FILEPATH &  TileFolderBasePath,
const FILEPATH &  TargetPath,
INT32  level,
bool  bDeleteAfterZip = false,
MITHREAD::QUEUE *  Queue = NULL 
)

Zip contents of zoom level.

Parameters:
TileFolderBasePath Location of tile folder
TargetPath Target Location
level Zoom level to zip
bDeleteAfterZip Delete source tiles after zipping
Queue Thread queue for zipping
ERRVALUE SPATMOD::IMAGE::TILESET::ZipLevel ( const FILEPATH &  TileFolderBasePath,
INT32  level,
bool  bDeleteAfterZip = false 
)

Zip contents of zoom level.

Parameters:
TileFolderBasePath Location of tile folder
level Zoom level to zip
bDeleteAfterZip Delete source tiles after zipping
The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:40:23 2012 for TNTsdk 2012 by  doxygen 1.6.1