com.visioglobe.libVisioDevKit

Class VgIMapModule

java.lang.Object

com.visioglobe.libVisioDevKit.VgIModule

com.visioglobe.libVisioDevKit.VgIMapModule

public class VgIMapModule
extends VgIModule

The VgIMapModule defines all the needed interfaces to interact with the map module.

Interface:

VgMapModule::VgIMapModule

Date:

25/02/2010

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(VgIPlaceListenerRefPtr pListener) Adds a place listener.
void	delete()
boolean	getHeightRangeForLayer(java.lang.String pLayerName, float[] pHeightMin, float[] pHeightMax)
boolean	getLayerForPosition(VgPosition pPos, java.lang.String[] pLayerNameContainingPosition)
boolean	getPlaceName(java.lang.String pID, java.lang.String[] pPlaceName)
void	queryAllPlaceIDs(VgStringVector pPlaceIDs)
boolean	queryPlaceDescriptor(java.lang.String pID, VgPlaceDescriptor pPlaceDescriptor)
void	removeListener(VgIPlaceListenerRefPtr pListener) Removes a place listener.
void	resetPlaceColor(java.lang.String pID) Resets the original color of a place.
void	resetPlaceColor(VgStringVector pIDs) Resets the original color of a list of place.
void	setPlaceColor(java.lang.String pID, VgPlaceColorDescriptor pColorDescriptor) Sets a place color according to its ID.
void	setPlaceColor(VgStringVector pIDs, VgPlaceColorDescriptor pColorDescriptor) Sets a place color according to a list of place ID's.
void	setPlaceIcon(java.lang.String pID, VgPlaceIconDescriptor pPlaceIconDescriptor)
void	setPlaceName(java.lang.String pID, java.lang.String pName) Sets a place name according to its ID.

Methods inherited from class com.visioglobe.libVisioDevKit.VgIModule

getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class VgIModule

addListener

public void addListener(VgIPlaceListenerRefPtr pListener)

Adds a place listener.

Parameters:

pListener - The place listener to be added.

removeListener

public void removeListener(VgIPlaceListenerRefPtr pListener)

Removes a place listener.

Parameters:

pListener - The place listener to be removed.

setPlaceName

public void setPlaceName(java.lang.String pID,
                java.lang.String pName)

Sets a place name according to its ID.

Parameters:

pID - the place ID.

pName - the place name to be set.

Remark:

It is advised to achieve the best performance to call setPlaceIcon after loadConfiguration, but before loadDataset when updating many places.

setPlaceIcon

public void setPlaceIcon(java.lang.String pID,
                VgPlaceIconDescriptor pPlaceIconDescriptor)

getPlaceName

public boolean getPlaceName(java.lang.String pID,
                   java.lang.String[] pPlaceName)

queryPlaceDescriptor

public boolean queryPlaceDescriptor(java.lang.String pID,
                           VgPlaceDescriptor pPlaceDescriptor)

queryAllPlaceIDs

public void queryAllPlaceIDs(VgStringVector pPlaceIDs)

getLayerForPosition

public boolean getLayerForPosition(VgPosition pPos,
                          java.lang.String[] pLayerNameContainingPosition)

getHeightRangeForLayer

public boolean getHeightRangeForLayer(java.lang.String pLayerName,
                             float[] pHeightMin,
                             float[] pHeightMax)

setPlaceColor

public void setPlaceColor(java.lang.String pID,
                 VgPlaceColorDescriptor pColorDescriptor)

Sets a place color according to its ID.

Parameters:

pID - The place ID to color.

pColorDescriptor - The place color descriptor to be set.

Remark:

With non-extruded maps, only the VgPlaceColorDescriptor.mTopColor will be used., It is advised to achieve the best performance to call setPlaceColor after loadConfiguration, but before loadDataset when updating many places., It is advised to use this method when setting a single place with a unique color.

setPlaceColor

public void setPlaceColor(VgStringVector pIDs,
                 VgPlaceColorDescriptor pColorDescriptor)

Sets a place color according to a list of place ID's.

Parameters:

pIDs - the list of place IDs to color.

pColorDescriptor - the place color descriptor to be set.

Remark:

With non-extruded maps, only the VgPlaceColorDescriptor.mTopColor will be used., It is advised to achieve the best performance to call setPlaceColor after loadConfiguration, but before loadDataset when updating many places., It is advised to use this method when setting two or more places with the same color.

resetPlaceColor

public void resetPlaceColor(java.lang.String pID)

Resets the original color of a place. There are no effect if the place color has not been changed.

Parameters:

pID - The place ID.

resetPlaceColor

public void resetPlaceColor(VgStringVector pIDs)

Resets the original color of a list of place. There are no effect on places whose color has not been changed.

Parameters:

pIDs - A list of place IDs.