SPATMOD::IMAGE::TARGET_TILESET_KML Class Reference

KML target. More...

#include <spatmod/imagetargettilesetkml.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_TILESET_KML:

[legend]

Public Member Functions
	TARGET_TILESET_KML (STAGE *pInputStage, TILESET::IMGFORMAT format, const FILEPATH &filepath, INT32 TileSize, INT32 MinLevel, INT32 MaxLevel)
	TARGET_TILESET_KML (STAGE *pInputStage, TILESET::IMGFORMAT format, const FILEPATH &filepath, INT32 TileSize, IMAGE::TILESET::PROFILE profile)
virtual	~TARGET_TILESET_KML ()
void	SetCreateFullStructure (bool bCreateFullStructure)
void	SetGeogExtents (const DRECT2D &GeogExtents)
void	SetParmsJPEG (INT16 quality)
void	SetParmsTIFF (const TARGETPARM_TIFF &Parm)
void	SetProcessBranchKML (bool bProcessBranchKML)
void	SetProcessLeafKML (bool bProcessLeafKML)
Static Public Member Functions
static ERRVALUE	ComputeReducedLevel (TILESET &Tileset, const FILEPATH &SourcePath, const FILEPATH &TargetPath, INT32 level, TILESET::IMGFORMAT ImgFormat, const IMAGE::PIXEL &PixelProperties, UINT16 QualityJPEG=75, TARGETPARM_TIFF *pParmsTIFF=NULL, MISTRING message=TEXTID_Creating_ResolutionLevelN, bool bZipOutput=false, RESAMPLEMETHOD ResampleMethod=RESAMPLEMETHOD_Nearest)
static ERRVALUE	ComputeReducedLevel (TILESET &Tileset, INT32 level, TILESET::IMGFORMAT ImgFormat=TILESET::IMGFORMAT_Invalid, UINT16 QualityJPEG=75, TARGETPARM_TIFF *pParmsTIFF=NULL, MISTRING message=TEXTID_Creating_ResolutionLevelN, bool bZipOutput=false)
static ERRVALUE	ComputeReducedLevel (TILESET &Tileset, const FILEPATH &SourcePath, const FILEPATH &TargetPath, INT32 level, MISTRING message=TEXTID_Creating_ResolutionLevelN)
static ERRVALUE	ComputeReducedLevel (TILESET &Tileset, INT32 level, MISTRING message=TEXTID_Creating_ResolutionLevelN)
static ERRVALUE	ComputeStructureLevel (TILESET &Tileset, const FILEPATH &SourcePath, const FILEPATH &TargetPath, INT32 level, MISTRING message=TEXTID_Creating_ResolutionLevelN, bool bZipOutput=false)
static ERRVALUE	CreateHTML (TILESET &Tileset, bool bOverwriteExisting=true, MISTRING GoogleAPIKey=TEXTID__None)
static ERRVALUE	CreateHTML (TILESET &Tileset, const MISTRING &ServerURL, bool bOverwriteExisting=true, MISTRING GoogleAPIKey=TEXTID__None)
static ERRVALUE	ResolveBranchKML (TILESET &Tileset, const FILEPATH &TileLocation, bool bOverwriteExisting=true, INT32 MinLevel=-1)
static ERRVALUE	WriteBranchKML (TILESET &Tileset, const FILEPATH &TileLocation, INT32 level, const LPOINT2D &TileIdx, bool bPutGroundOverlay=true)
static ERRVALUE	WriteLeafKML (TILESET &Tileset, const FILEPATH &TileLocation, INT32 level, const LPOINT2D &TileIdx)
static ERRVALUE	WriteRootKML (TILESET &Tileset, const FILEPATH &KMLLocation, const FILEPATH &TileLocation, bool bOverwriteExisting=true, INT32 MinLevel=-1)
static ERRVALUE	WriteRootKML (TILESET &Tileset, const MISTRING &ServerURL, const FILEPATH &KMLLocation, const FILEPATH &TileLocation, bool bOverwriteExisting=true, INT32 MinLevel=-1)

Detailed Description

KML target.

Constructor & Destructor Documentation

SPATMOD::IMAGE::TARGET_TILESET_KML::TARGET_TILESET_KML	(	STAGE *	pInputStage,
		TILESET::IMGFORMAT	format,
		const FILEPATH &	filepath,
		INT32	TileSize,
		IMAGE::TILESET::PROFILE	profile
	)

Constructor.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	format	Image tile file format
	filepath	Basepath used for creating TSD and KML files
	TileSize	Tile size
	profile	Tileset profile

SPATMOD::IMAGE::TARGET_TILESET_KML::TARGET_TILESET_KML	(	STAGE *	pInputStage,
		TILESET::IMGFORMAT	format,
		const FILEPATH &	filepath,
		INT32	TileSize,
		INT32	MinLevel,
		INT32	MaxLevel
	)

Constructor. Will create on global grid.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	format	Image tile file format
	filepath	Basepath used for creating TSD and KML files
	TileSize	Tile size
	MinLevel	Minimum zoom level to compute
	MaxLevel	Maximum zoom level to compute

virtual SPATMOD::IMAGE::TARGET_TILESET_KML::~TARGET_TILESET_KML ( ) [virtual]

Destructor.

Member Function Documentation

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ComputeReducedLevel	(	TILESET &	Tileset,
		const FILEPATH &	SourcePath,
		const FILEPATH &	TargetPath,
		INT32	level,
		TILESET::IMGFORMAT	ImgFormat,
		const IMAGE::PIXEL &	PixelProperties,
		UINT16	QualityJPEG = `75`,
		TARGETPARM_TIFF *	pParmsTIFF = `NULL`,
		MISTRING	message = `TEXTID_Creating_ResolutionLevelN`,
		bool	bZipOutput = `false`,
		RESAMPLEMETHOD	ResampleMethod = `RESAMPLEMETHOD_Nearest`
	)			`[static]`

Compute reduced level (tiles must exist at zoom level + 1).

Parameters:

	Tileset	Tileset to use
	SourcePath	Location of source tiles
	TargetPath	Location to output tiles
	level	Level to compute
	ImgFormat	ImgFormat
	PixelProperties	Pixel Properties
	QualityJPEG	Quality of JPEG output
	pParmsTIFF	Tiff settings
	message	Context message to display
	bZipOutput	Zip results
	ResampleMethod	Resample Method to use for zoom filter

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ComputeReducedLevel	(	TILESET &	Tileset,
		INT32	level,
		TILESET::IMGFORMAT	ImgFormat = `TILESET::IMGFORMAT_Invalid`,
		UINT16	QualityJPEG = `75`,
		TARGETPARM_TIFF *	pParmsTIFF = `NULL`,
		MISTRING	message = `TEXTID_Creating_ResolutionLevelN`,
		bool	bZipOutput = `false`
	)			`[static]`

Compute reduced level (tiles must exist at zoom level + 1).

Parameters:

	Tileset	Tileset to use
	level	Level to compute
	ImgFormat	ImgFormat
	QualityJPEG	Quality of JPEG output
	pParmsTIFF	Tiff settings
	message	Context message to display
	bZipOutput	Zip results

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ComputeReducedLevel	(	TILESET &	Tileset,
		const FILEPATH &	SourcePath,
		const FILEPATH &	TargetPath,
		INT32	level,
		MISTRING	message = `TEXTID_Creating_ResolutionLevelN`
	)			`[static]`

Compute reduced level (tiles must exist at zoom level + 1).

Parameters:

	Tileset	Tileset to use
	SourcePath	Location of source tiles
	TargetPath	Location to output tiles
	level	Level to compute
	message	Context message to display

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ComputeReducedLevel	(	TILESET &	Tileset,
		INT32	level,
		MISTRING	message = `TEXTID_Creating_ResolutionLevelN`
	)			`[static]`

Compute reduced level (tiles must exist at zoom level + 1).

Parameters:

	Tileset	Tileset to use
	level	Level to compute
	message	Context message to display

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ComputeStructureLevel	(	TILESET &	Tileset,
		const FILEPATH &	SourcePath,
		const FILEPATH &	TargetPath,
		INT32	level,
		MISTRING	message = `TEXTID_Creating_ResolutionLevelN`,
		bool	bZipOutput = `false`
	)			`[static]`

Compute level for super-overlay structure with links to level + 1.

Parameters:

	Tileset	Tileset to use
	SourcePath	Location of source tiles
	TargetPath	Location to output tiles
	level	Level to compute
	message	Context message to display
	bZipOutput	Zip results

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::CreateHTML	(	TILESET &	Tileset,
		bool	bOverwriteExisting = `true`,
		MISTRING	GoogleAPIKey = `TEXTID__None`
	)			`[static]`

Create GoogleMaps HTML file.

Parameters:

	Tileset	Tileset to use
	bOverwriteExisting	Write over any existing files
	GoogleAPIKey	Google API key

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::CreateHTML	(	TILESET &	Tileset,
		const MISTRING &	ServerURL,
		bool	bOverwriteExisting = `true`,
		MISTRING	GoogleAPIKey = `TEXTID__None`
	)			`[static]`

Create GoogleMaps HTML file.

Parameters:

	Tileset	Tileset to use
	ServerURL	Server location where html will be
	bOverwriteExisting	Write over any existing files
	GoogleAPIKey	Google API key

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::ResolveBranchKML	(	TILESET &	Tileset,
		const FILEPATH &	TileLocation,
		bool	bOverwriteExisting = `true`,
		INT32	MinLevel = `-1`
	)			`[static]`

Produce branch kmls for all upper levels.

Parameters:

	Tileset	Tileset to use
	TileLocation	Location of tiles
	bOverwriteExisting	Write over any existing files
	MinLevel	Minimum zoom level to include

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetCreateFullStructure ( bool bCreateFullStructure ) [inline]

Create entire super-overlay structure.

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetGeogExtents ( const DRECT2D & GeogExtents ) [inline]

Set geographic (lat-lon) extents for overall result.

If not used extents will be derived from total target image, which may include blank areas around outer tiles.

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetParmsJPEG ( INT16 quality ) [inline]

Set parameters specific to JPEG format.

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetParmsTIFF ( const TARGETPARM_TIFF & Parm )

Set parameters specific to TIFF format.

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetProcessBranchKML ( bool bProcessBranchKML ) [inline]

When writing tiles, process the kmls as branch.

void SPATMOD::IMAGE::TARGET_TILESET_KML::SetProcessLeafKML ( bool bProcessLeafKML ) [inline]

When writing tiles, process the kmls as leaf.

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::WriteBranchKML	(	TILESET &	Tileset,
		const FILEPATH &	TileLocation,
		INT32	level,
		const LPOINT2D &	TileIdx,
		bool	bPutGroundOverlay = `true`
	)			`[static]`

Create a branch kml.

Parameters:

	Tileset	Tileset to use
	TileLocation	Location of tiles
	level	Zoom level
	TileIdx	Absolute tile index within defined tile range for zoom level
	bPutGroundOverlay	Include ground overlay

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::WriteLeafKML	(	TILESET &	Tileset,
		const FILEPATH &	TileLocation,
		INT32	level,
		const LPOINT2D &	TileIdx
	)			`[static]`

Create a leaf kml.

Parameters:

	Tileset	Tileset to use
	TileLocation	Location of tiles
	level	Zoom level
	TileIdx	Absolute tile index within defined tile range for zoom level

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::WriteRootKML	(	TILESET &	Tileset,
		const FILEPATH &	KMLLocation,
		const FILEPATH &	TileLocation,
		bool	bOverwriteExisting = `true`,
		INT32	MinLevel = `-1`
	)			`[static]`

Create the root kml.

Parameters:

	Tileset	Tileset to use
	KMLLocation	Location to write KML
	TileLocation	Location of tiles
	bOverwriteExisting	Write over any existing files
	MinLevel	Minimum zoom level to include

static ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_KML::WriteRootKML	(	TILESET &	Tileset,
		const MISTRING &	ServerURL,
		const FILEPATH &	KMLLocation,
		const FILEPATH &	TileLocation,
		bool	bOverwriteExisting = `true`,
		INT32	MinLevel = `-1`
	)			`[static]`

Create the root kml.

Parameters:

	Tileset	Tileset to use
	ServerURL	Server location where kml will be
	KMLLocation	Location to write KML
	TileLocation	Location of tiles
	bOverwriteExisting	Write over any existing files
	MinLevel	Minimum zoom level to include

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

spatmod/imagetargettilesetkml.h

SPATMOD::IMAGE::TARGET_TILESET_KML Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation