NCLocationWindow Class Reference

Class is used to interact with the view. More...

#include <com/navigine/idl/objc/NCLocationWindow.h>

Inherits NSObject.

Instance Methods
(void)	- setSublocationId:
	Method is used to switch location view between sublocations (floors).
(nonnull NCPoint *)	- screenPositionToMeters:
	Method is used to convert screen (pixels) coordinates to metrics coordinates.
(CGPoint)	- metersToScreenPosition:clipToViewport:
	Method is used to convert metrics coordinates to screen (pixels) coordinates.
(nullable NCCircleMapObject *)	- addCircleMapObject
	Method is used to create and add circle map object to the location view.
(BOOL)	- removeCircleMapObject:
	Method is used to remove circle map object from the location view.
(nullable NCIconMapObject *)	- addIconMapObject
	Method is used to create and add icon map object to the location view.
(BOOL)	- removeIconMapObject:
	Method is used to remove icon map object from the location view.
(nullable NCFlatIconMapObject *)	- addFlatIconMapObject
	Method is used to create and add flat icon map object to the location view.
(BOOL)	- removeFlatIconMapObject:
	Method is used to remove flat icon map object from the location view.
(nullable NCPolygonMapObject *)	- addPolygonMapObject
	Method is used to create and add polygon map object to the location view.
(BOOL)	- removePolygonMapObject:
	Method is used to remove polygon map object from the location view.
(nullable NCPolylineMapObject *)	- addPolylineMapObject
	Method is used to create and add polyline map object to the location view.
(BOOL)	- removePolylineMapObject:
	Method is used to remove polyline map object from the location view.
(void)	- removeAllMapObjects
	Method is used to remove all object from the location view.
(void)	- pickMapObjectAt:
	Method is used to select a visible map object marked as interactive MapObject. The result will be delivered to the PickListener by onMapObjectPickComplete PickListener.
(void)	- pickMapFeatureAt:
	Method is used to select a visible map features, such as venues etc. The result will be delivered to the PickListener by onMapFeaturePickComplete PickListener.
(void)	- addPickListener:
	Method is used to add PickListener class element which will notify all picking results events.
(void)	- removePickListener:
	Method is used for removing previously added PickListener class element.
(void)	- addInputListener:
	Method is used to add InputListener class element which will notify input events.
(void)	- removeInputListener:
	Method is used for removing previously added InputListener class element.
(void)	- addCameraListener:
	Method is used to add CameraListener class element which will notify camera movements events.
(void)	- removeCameraListener:
	Method is used for removing previously added CameraListener class element.
(void)	- flyTo:duration:callback:
	Move the map camera to a new position with an easing animation.
(BOOL)	- selectMapFeature:
	Selects a map feature with the specified featureId.
(BOOL)	- deselectMapFeature:
	Deselects a map feature with the specified featureId.
(void)	- deselectAllMapFeatures
	Resets the currently selected map features.
(void)	- moveTo:duration:animationType:callback:
	Move the map camera to a new position with an animation that pans and zooms in a smooth arc.

Properties
float	zoomFactor
	Parameter is used to change location view zoom. Value indicates count of pixels in 1 meter (default: approx 100m in screen width).
float	minZoomFactor
	Minimum zoomFactor value (ZoomFactor parameter).
float	maxZoomFactor
	Maximum zoomFactor value (ZoomFactor parameter).
BOOL	stickToBorder
	Parameter is used to enable/disable sublocation content sticking to screen borders. If true image sticking to screen bounds, if false sticking to center of screen (Default: true).
NCCamera *	camera
	Current camera position in meters.
BOOL	rotateGestureEnabled
	Parameter is used to enable/disable rotation gestures, such as rotation with two fingers.
BOOL	tiltGesturesEnabled
	Parameter is used to enable/disable tilt gestures, such as parallel pan with two fingers.
BOOL	scrollGesturesEnabled
	Parameter is used to enable/disable scroll gestures, such as the pan gesture.
BOOL	zoomGesturesEnabled
	Parameter is used to enable/disable zoom gestures, such as the pinch with two fingers.
float	pickRadius
	Radius to use when picking features on the map. The default radius is 0.5 dp (density-independent pixels).
NSArray< NSString * > *	selectedMapFeatures
	List of currently selected map features.

Detailed Description

Class is used to interact with the view.

Referenced from: LocationView,

Definition at line 33 of file NCLocationWindow.h.

Method Documentation

addCameraListener:

- (void) addCameraListener:

(nullable id< NCCameraListener >)

listener

Method is used to add CameraListener class element which will notify camera movements events.

Note

Do not forget to remove listener if it is no longer needed!

Parameters

listener

Сorresponding CameraListener listener class.

addCircleMapObject

- (nullable NCCircleMapObject *) addCircleMapObject

Method is used to create and add circle map object to the location view.

Returns

CircleMapObject instance CircleMapObject if success, null otherwise.

addFlatIconMapObject

- (nullable NCFlatIconMapObject *) addFlatIconMapObject

Method is used to create and add flat icon map object to the location view.

Returns

FlatIconMapObject instance FlatIconMapObject if success, null otherwise.

addIconMapObject

- (nullable NCIconMapObject *) addIconMapObject

Method is used to create and add icon map object to the location view.

Returns

IconMapObject instance IconMapObject if success, null otherwise.

addInputListener:

- (void) addInputListener:

(nullable id< NCInputListener >)

listener

Method is used to add InputListener class element which will notify input events.

Note

Do not forget to remove listener if it is no longer needed!

Parameters

listener

Сorresponding InputListener listener class.

addPickListener:

- (void) addPickListener:

(nullable id< NCPickListener >)

listener

Method is used to add PickListener class element which will notify all picking results events.

Note

Do not forget to remove listener if it is no longer needed!

Parameters

listener

Сorresponding PickListener listener class.

addPolygonMapObject

- (nullable NCPolygonMapObject *) addPolygonMapObject

Method is used to create and add polygon map object to the location view.

Returns

PolygonMapObject instance PolygonMapObject if success, null otherwise.

addPolylineMapObject

- (nullable NCPolylineMapObject *) addPolylineMapObject

Method is used to create and add polyline map object to the location view.

Returns

PolylineMapObject instance PolylineMapObject if success, null otherwise.

deselectAllMapFeatures

- (void) deselectAllMapFeatures

Resets the currently selected map features.

deselectMapFeature:

- (BOOL) deselectMapFeature:

(nonnull NSString *)

featureId

Deselects a map feature with the specified featureId.

Parameters

featureId

featureId can be extracted from the mapFeaturePickResult container by using onMapFeaturePickComplete callback of PickListener.

Returns

true if success, false otherwise.

flyTo:duration:callback:

- (void) flyTo:		(nonnull NCCamera *)	camera
duration:		(int32_t)	duration
callback:		(nullable NCCameraCallback)	callback

Move the map camera to a new position with an easing animation.

Parameters

camera	The new camera position
duration	The animation duration in milliseconds
callback	completion callback to execute when the animation completes

metersToScreenPosition:clipToViewport:

- (CGPoint) metersToScreenPosition:		(nonnull NCPoint *)	point
clipToViewport:		(BOOL)	clipToViewport

Method is used to convert metrics coordinates to screen (pixels) coordinates.

Parameters

point	(x,y) point in meters coordinates Point.
clipToViewport	if true, results that would be outside the viewport are clipped to a position on the edge of the viewport in the direction of the location.

Returns

(x,y) point in screen pixels.

moveTo:duration:animationType:callback:

- (void) moveTo:		(nonnull NCCamera *)	camera
duration:		(int32_t)	duration
animationType:		(NCAnimationType)	animationType
callback:		(nullable NCCameraCallback)	callback

Move the map camera to a new position with an animation that pans and zooms in a smooth arc.

Note

The animation duration is calculated based on the distance to the new camera position and the specified speed

Parameters

camera	The new camera position
duration	Duration of the animation in milliseconds (-1 for default duration)
animationType	The type of easing animation
callback	A callback to execute when the animation completes

pickMapFeatureAt:

- (void) pickMapFeatureAt:

(CGPoint)

point

Method is used to select a visible map features, such as venues etc. The result will be delivered to the PickListener by onMapFeaturePickComplete PickListener.

Parameters

point

position in the view to pick from, in pixels.

pickMapObjectAt:

- (void) pickMapObjectAt:

(CGPoint)

point

Method is used to select a visible map object marked as interactive MapObject. The result will be delivered to the PickListener by onMapObjectPickComplete PickListener.

Parameters

point

position in the view to pick from, in pixels.

removeAllMapObjects

- (void) removeAllMapObjects

Method is used to remove all object from the location view.

removeCameraListener:

- (void) removeCameraListener:

(nullable id< NCCameraListener >)

listener

Method is used for removing previously added CameraListener class element.

Parameters

listener

Сorresponding CameraListener class to remove.

removeCircleMapObject:

- (BOOL) removeCircleMapObject:

(nullable NCCircleMapObject *)

circleMapObject

Method is used to remove circle map object from the location view.

Parameters

circleMapObject

circle map object instance CircleMapObject.

Returns

true if success, false otherwise.

removeFlatIconMapObject:

- (BOOL) removeFlatIconMapObject:

(nullable NCFlatIconMapObject *)

flatIconMapObject

Method is used to remove flat icon map object from the location view.

Parameters

flatIconMapObject

flat icon map object instance FlatIconMapObject.

Returns

true if success, false otherwise.

removeIconMapObject:

- (BOOL) removeIconMapObject:

(nullable NCIconMapObject *)

iconMapObject

Method is used to remove icon map object from the location view.

Parameters

iconMapObject

icon map object instance IconMapObject.

Returns

true if success, false otherwise.

removeInputListener:

- (void) removeInputListener:

(nullable id< NCInputListener >)

listener

Method is used for removing previously added InputListener class element.

Parameters

listener

Сorresponding InputListener class to remove.

removePickListener:

- (void) removePickListener:

(nullable id< NCPickListener >)

listener

Method is used for removing previously added PickListener class element.

Parameters

listener

Сorresponding PickListener class to remove.

removePolygonMapObject:

- (BOOL) removePolygonMapObject:

(nullable NCPolygonMapObject *)

polygonMapObject

Method is used to remove polygon map object from the location view.

Parameters

polygonMapObject

polygon map object instance PolygonMapObject.

Returns

true if success, false otherwise.

removePolylineMapObject:

- (BOOL) removePolylineMapObject:

(nullable NCPolylineMapObject *)

polylineMapObject

Method is used to remove polyline map object from the location view.

Parameters

polylineMapObject

polyline map object instance PolylineMapObject.

Returns

true if success, false otherwise.

screenPositionToMeters:

- (nonnull NCPoint *) screenPositionToMeters:

(CGPoint)

point

Method is used to convert screen (pixels) coordinates to metrics coordinates.

Parameters

point

(x,y) point in screen pixels.

Returns

(x,y) point in meters coordinates Point.

selectMapFeature:

- (BOOL) selectMapFeature:

(nonnull NSString *)

featureId

Selects a map feature with the specified featureId.

Parameters

featureId

featureId can be extracted from the mapFeaturePickResult container by using onMapFeaturePickComplete callback of PickListener.

Returns

true if success, false otherwise.

setSublocationId:

- (void) setSublocationId:

(int32_t)

id

Method is used to switch location view between sublocations (floors).

Parameters

id	sublocation unique identifier Sublocation.

Property Documentation

camera

- (NCCamera*) camera

readwritenonatomicassign

Current camera position in meters.

Definition at line 333 of file NCLocationWindow.h.

maxZoomFactor

- (float) maxZoomFactor

readwritenonatomicassign

Maximum zoomFactor value (ZoomFactor parameter).

Definition at line 318 of file NCLocationWindow.h.

minZoomFactor

- (float) minZoomFactor

readwritenonatomicassign

Minimum zoomFactor value (ZoomFactor parameter).

Definition at line 311 of file NCLocationWindow.h.

pickRadius

- (float) pickRadius

readwritenonatomicassign

Radius to use when picking features on the map. The default radius is 0.5 dp (density-independent pixels).

Definition at line 368 of file NCLocationWindow.h.

rotateGestureEnabled

- (BOOL) rotateGestureEnabled

readwritenonatomicassign

Parameter is used to enable/disable rotation gestures, such as rotation with two fingers.

Definition at line 340 of file NCLocationWindow.h.

scrollGesturesEnabled

- (BOOL) scrollGesturesEnabled

readwritenonatomicassign

Parameter is used to enable/disable scroll gestures, such as the pan gesture.

Definition at line 354 of file NCLocationWindow.h.

selectedMapFeatures

- (NSArray<NSString *>*) selectedMapFeatures

readnonatomicassign

List of currently selected map features.

Definition at line 375 of file NCLocationWindow.h.

stickToBorder

- (BOOL) stickToBorder

readwritenonatomicassign

Parameter is used to enable/disable sublocation content sticking to screen borders. If true image sticking to screen bounds, if false sticking to center of screen (Default: true).

Definition at line 326 of file NCLocationWindow.h.

tiltGesturesEnabled

- (BOOL) tiltGesturesEnabled

readwritenonatomicassign

Parameter is used to enable/disable tilt gestures, such as parallel pan with two fingers.

Definition at line 347 of file NCLocationWindow.h.

zoomFactor

- (float) zoomFactor

readwritenonatomicassign

Parameter is used to change location view zoom. Value indicates count of pixels in 1 meter (default: approx 100m in screen width).

Definition at line 304 of file NCLocationWindow.h.

zoomGesturesEnabled

- (BOOL) zoomGesturesEnabled

readwritenonatomicassign

Parameter is used to enable/disable zoom gestures, such as the pinch with two fingers.

Definition at line 361 of file NCLocationWindow.h.

---

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

• NCLocationWindow.h