FormIt.ImageManager API

Description

Functions
json	FormIt.ImageManager.ReloadImageLayerWithImage (nHistoryID, nLayerID, imageFile)
json	FormIt.ImageManager.ReloadImageLayerWithPlaceholder (nHistoryID, nLayerID)
	Reloads a layer with a placeholder image. More...
json	FormIt.ImageManager.GetData (nHistoryID, nImageID, aIncludeSatelliteData)
	Gets ImageData for a single image. More...
json	FormIt.ImageManager.GetAllImages (nHistoryID, nSort)
	Gets all images in given history. More...
json	FormIt.ImageManager.ImportImage (nHistoryID, fileName, pixelWidth, pixelHeight, worldWidth, worldHeight, isSatelliteImage, addToSelections)
	Gets all images in given history. More...
json	FormIt.ImageManager.SetImageName (nHistoryID, imageID, name)
	Set the Image name. More...
json	FormIt.ImageManager.SetImageAlpha (nHistoryID, imageID, fAlpha, bFinalChange)
	Set the Image alpha. More...
json	FormIt.ImageManager.SetImagePosition (nHistoryID, imageID, nPosition)
	Set the Image Position. More...
json	FormIt.ImageManager.ReloadTerrain (nHistoryID, nImageID, imageFile, nRows, nCols, elevations)
	Reloads terrain based on elevation data and an image. More...

Function Documentation

json FormIt.ImageManager.GetAllImages	(	nHistoryID	,
		nSort
	)

Gets all images in given history.

Parameters

[in]	nHistoryID	size_t
[in]	nSort	enum

Returns

FormIt.AllImageData

json FormIt.ImageManager.GetData	(	nHistoryID	,
		nImageID	,
		aIncludeSatelliteData
	)

Gets ImageData for a single image.

Parameters

[in]	nHistoryID	size_t
[in]	nImageID	size_t
[in]	aIncludeSatelliteData	bool

Returns

Image Data

json FormIt.ImageManager.ImportImage	(	nHistoryID	,
		fileName	,
		pixelWidth	,
		pixelHeight	,
		worldWidth	,
		worldHeight	,
		isSatelliteImage	,
		addToSelections
	)

Gets all images in given history.

Parameters

[in]	fileName,pixelWidth,pixelHeight,worldWidth,worldHeight,isSatelliteImage,addToSelections
[in]	nHistoryID	int
[in]	fileName	String
[in]	pixelWidth	int
[in]	pixelHeight	int
[in]	worldWidth	double
[in]	worldHeight	double
[in]	isSatelliteImage	bool
[in]	addToSelections	(OPTIONAL, default = true) bool

Returns

imageID New Image ID

json FormIt.ImageManager.ReloadImageLayerWithImage	(	nHistoryID	,
		nLayerID	,
		imageFile
	)

json FormIt.ImageManager.ReloadImageLayerWithPlaceholder	(	nHistoryID	,
		nLayerID
	)

Reloads a layer with a placeholder image.

Parameters

[in]	nHistoryID	size_t
[in]	nLayerID	size_t

Returns

JSON_UNDEFINED

json FormIt.ImageManager.ReloadTerrain	(	nHistoryID	,
		nImageID	,
		imageFile	,
		nRows	,
		nCols	,
		elevations
	)

Reloads terrain based on elevation data and an image.

If the image file is not specified, re-uses the existing image.

Parameters

[in]	nHistoryID	size_t
[in]	nImageID	size_t
[in]	imageFile	std.string
[in]	nRows	size_t - the number of rows of elevation data
[in]	nCols	size_t - the number of columns of elevation data
[in]	elevations	std.vector<double>

Returns

JSON_UNDEFINED

json FormIt.ImageManager.SetImageAlpha	(	nHistoryID	,
		imageID	,
		fAlpha	,
		bFinalChange
	)

Set the Image alpha.

Parameters

[in]	nHistoryID,imageID,fAlpha,bFinalChange
[in]	nHistoryID	int
[in]	imageID	int
[in]	fAlpha	float
[in]	bFinalChange	bool

Returns

success

json FormIt.ImageManager.SetImageName	(	nHistoryID	,
		imageID	,
		name
	)

Set the Image name.

Parameters

[in]	nHistoryID,imageID,name
[in]	nHistoryID	int
[in]	imageID	int
[in]	name	String

Returns

success

json FormIt.ImageManager.SetImagePosition	(	nHistoryID	,
		imageID	,
		nPosition
	)

Set the Image Position.

Parameters

[in]	nHistoryID,imageID,nPosition
[in]	nHistoryID	int
[in]	imageID	int
[in]	nPosition	int

Returns

success