MapSDK

Before using any MapSDK listed below, please verify that you have : - Setup correctly your map and our SDK - Instantiated and initialized a MapFNO's object

Display a map with a given identifier :

This method is used to display a map for a given unique identifier.

@param mapID: integer representing the map's unique identifier

@param callback: CallbackLoadMap called when map is ready to be displayed

@return void

map.displayMapWithId(mapID, new MapFNO.CallbackLoadMap() { @Override public void onMapReady() { //Interact with your map } });

map.displayMapWithId(mapID) { //Interact with your map }

Change container color

This method permits to change the color of a specific container.

map.setContainerColor("#FF0000", idContainer);

map.setContainerColor("#FF0000", idContainer)

Set an itinerary with a destination point :

This method is used to set an itinerary to a destination point without knowing the starting point.

@param destinationID: integer representing the destination point of the itinerary

@param callback: CallbackInt called with the floor info

@return void

map.setItineraryToEntityWithId(destinationID, new MapFNO.CallbackInt() { @Override public void onValue(int floor) { //Interact with your floor info } });

map.setItineraryToEntityWithId(destinationID) { floor -> //Interact with your floor info }

Set an itinerary from a starting point to a destination point :

This method is used to set an itinerary from a starting point to a destination point.

@param startID: Integer representing the starting point of the itinerary

@param destinationID: integer representing the destination point of the itinerary

@param callback: CallbackInt called with the floor info

@return void

map.setItineraryToEntityWithId(startID, destinationID, new MapFNO.CallbackInt() { @Override public void onValue(int floor) { //Interact with your floor info } });

map.setItineraryToEntityWithId(startID, destinationID) { floor -> //Interact with your floor info }

Highlight/Unhighlight a specific object on the map :

This method is used to highlight or unhighlight a specific object in the map.

@param isOutline: boolean representing if the object needs to be highlighted

@param idContainer: string representing the unique identifier of the map's object

@return void

map.setOutlineContainer(true, idContainer) //Highlight the specific idContainer's object map.setOutlineContainer(false, idContainer) //Unhighlight the specific idContainer's object map.setContainerColor("#FF0000", idContainer) //Change container color

map.setOutlineContainer(true, idContainer) //Highlight the specific idContainer's object map.setOutlineContainer(false, idContainer) //Unhighlight the specific idContainer's object

Clear an highlighted object on the map :

This method is used to clear the highlight of a specific object in the map.

@return void

map.clearOutlineContainer()

Enable/Disable free planar movements on the map :

This method is used to enable free planar movements on the map. If you enable them, you can move around the map using two fingers. By default, the free planar movements are not enabled.

@param state: boolean representing if the free planar movements are enabled or not

@return void

map.enableFreePlanarMovement(true); //Enable free planar movements on map map.enableFreePlanarMovement(false); //Disable free planar movements on map

Zoom in the map :

This method is used to zoom in the map.

@return void

map.zoomIn()

Zoom out the map :

This method is used to zoom out the map.

@return void

map.zoomOut()

Zoom on Container

This method is used to zoom on a Container

@param idContainer: String identifiant of Container

@return void

map.zoomOnContainer(idContainer)

Take a screenshot of the map :

This method is used to take a screenshot of the map and generates a QRCode in order to retrieve your screenshot.

@param callback: CallbackTakeScreenshot representing the screenshot taken as a Bitmap's image

@return void

map.takeScreenshot(new MapFNO.CallbackTakeScreenshot() { @Override public void onScreenshot(Bitmap image) { //Interact with your screenshot's image } });

map.takeScreenshot { image -> //Interact with your screenshot's image }

Get optimized products' itinerary from EANs :

This method is used to get an optimized itinerary for a list of products based on a list of EANs.

@param listOfEANs: ArrayList representing the list of EANs

@param callback: CallbackContainersFromEANS representing the list of products optimized for an itinerary

@return void

map.getProductFromEANs(listOfEANs, new MapFNO.CallbackContainersFromEANS() { @Override public void onSuccess(ArrayList<Integer> idContainersFromEANS) { //Interact with your products } @Override public void onError(String error) { //Interact with the error } });

map.getProductFromEANs(listOfEANs, object: MapFNO.CallbackContainersFromEANS { override fun onSuccess(idContainersFromEANS: java.util.ArrayList<Int>?) { ////Interact with your products } override fun onError(error: String?) { //Interact with the error } })

Get optimized products' itinerary from product references :

This method is used to get an optimized itinerary for a list of products based on a list of product references.

@param listOfReferences: ArrayList representing the list of product references

@param callback: CallbackContainersFromEANS representing the list of products optimized for an itinerary

@return void

map.getProductFromReferences(listOfReferences, new MapFNO.CallbackContainersFromEANS() { @Override public void onSuccess(ArrayList<Integer> idContainersFromEANS) { //Interact with your products } @Override public void onError(String error) { //Interact with the error } });

map.getProductFromReferences(listOfReferences, object: MapFNO.CallbackContainersFromEANS { override fun onSuccess(idContainersFromEANS: java.util.ArrayList<Int>?) { ////Interact with your products } override fun onError(error: String?) { //Interact with the error } })

Change camera's perspective of the map :

This method is used to change the camera's perspective of the map.

You can choose between two camera options :

TOP : Map camera is placed above the scene without perspective like in 2D
FPS : See map or Itinerary at the first person
GLOBAL3D : Broad 3D scene view
ITINERARY3D : 3D view focus on the itinerary
ITINERARY2D : 2D view focus on the itinerary

@param option: .CAMERA_VIEW___OPTIONS representing the camera view option chosen

@return void

map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.TOP) map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.FPS) map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.GLOBAL3D) map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.ITINERARY3D) map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.ITINERARY2D)

map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.TOP) map.setCameraPerspective(UnityManager.CAMERA_VIEW_OPTIONS.PERSPECTIVE)

Enable/Disable FPS camera mode :

This method is used to enable/disable FPS camera mode. By default the FPS mode is disabled.

@param state: boolean representing if enable/disable FPS camera mode

@return void

map.toogleItineraryView(true) //Enable FPS mode map.toogleItineraryView(false) //Disable FPS mode

Clear current itinerary set on the map :

This method is used to clear the current itinerary set on the map.

@return void

map.clearItinerary()

Set a clic listener on the map :

This method is used to set a clic listener on the map.

@param listener: MapFNO.CallbackJSON

@return void

map.setMouseListener(boolean state, new MapFNO.CallbackJSON() { @Override public void onValue(JSONObject jsonObject) { } });

map.setOnMapClicListener { idPlace -> //Interact with your idPlace clicked }

Adjust camera's speed rotation on the map :

This method is used to adjust the speed of the camera's rotation on the map.

@param speed: float representing the speed of the camera's rotation

@return void

map.startCameraRotation(speed)

Stop camera's rotation on the map :

This method is used to stop the camera's rotation on the map.

@return void

map.stopCameraRotation()

Get itinerary details displayed on the map :

This method is used to get the itinerary details displayed on the map.

@param callback: CallbackItineraryDetails representing the callback with the itinerary details

@return void

map.getItineraryDetails(new MapFNO.CallbackItineraryDetails() { @Override public void onSuccess(ArrayList<ItineraryDetail> details) { //Interact with your list of itinerary details } });

map.getItineraryDetails { itineraryDetails -> //Interact with your list of itinerary details }

Show all waypoints on the map :

This method is used to show all the waypoints on the map. A waypoint is a point of interest where something important is represented. For example, an event or an action to realize.

@param void

@return void

map.showAllWaypoints();

map.showAllWaypoints()

Hide all waypoints on the map :

This method is used to hide all the waypoints on the map. A waypoint is a point of interest where something important is represented. For example, an event or an action to realize.

@param void

@return void

map.hideAllWaypoints();

map.hideAllWaypoints()

Get all the waypoints displayed on the map :

This method is used to get the list of all the waypoints displayed on the map. A waypoint is a point of interest where something important is represented. For example, an event or an action to realize.

@param CallbackWaypoints representing the callback with the list of waypoints

@return void

map.getWaypoints(new MapFNO.CallbackWaypoints() { @Override public void onSuccess(ArrayList<JsonLightWayPoint> waypoints) { //Get the list of waypoints } @Override public void onFailure(String errorLocalized) { //Error when trying to get list of waypoints } });

map.getWaypoints(object : MapFNO.CallbackWaypoints { override fun onSuccess(waypoints: ArrayList<JsonLightWayPoint>?) { //Get the list of waypoints } override fun onFailure(errorLocalized: String?) { //Error when trying to get list of waypoints } })

Enable magnetic geolocalization :

This method is used to enable magnetic geolozalisation on the map.

@param void

@return void

map.enableMagneticGeolocalization();

map.enableMagneticGeolocalization()

Disable magnetic geolocalization :

This method is used to disable magnetic geolocalization on the map.

@param void

@return void

map.disableMagneticGeolocalization();

map.disableMagneticGeolocalization()

Check if magnetic geolocalization is active :

This method is used to check if magnetic geolocalization on the map is active.

@param CallbackBoolean representing the callback with the activation state

@return void

map.isMagneticGeolocalizationActive(new MapFNO.CallbackBoolean() { @Override public void onValue(boolean state) { //Interact with your activation state } });

map.isMagneticGeolocalizationActive { state -> //Interact with your activation state }

Get TCP server delay :

This method is used to get TCP server delay connexion.

@param CallbackFloat representing the callback with the server delay

@return void

map.getTCPServerDelay(new MapFNO.CallbackFloat() { @Override public void onValue(Float serverDelay) { //Interact with your server delay } });

map.getTCPServerDelay { serverDelay -> //Interact with your server delay }

Datas

This method is used to get all information about the map, as :

ID
Rooms name
Description
Type
Asset's information
Logos

@param CallbackJSON representing the callback with meta datas

@return void

map.getAllMetaData(new MapFNO.CallbackJSON() { @Override public void onValue(JSONObject jsonObject) { } });

Get map floor datas

Methods used to manage with map floors

map.getFloors(new MapFNO.CallbackJSON() { // get all available floors @Override public void onValue(JSONObject jsonObject) { } }); map.setFloors(int floor) // set current floor. All other floors are hidden map.resetFloors() // show all floors map.setFloorSelectedListener(new MapFNO.CallbackJSON() { @Override public void onValue(JSONObject jsonObject) { } });

Last updated on