NCLocationWindow Class Reference

Interface for interacting with the location view. More...

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

Inherits NSObject.

Instance Methods
(void)	- setSublocationId:
	Method is used to switch the location view between sublocations (e.g., floors).
(nonnull NCPoint *)	- screenPositionToMeters:
	Converts screen coordinates (pixels) to metrics coordinates (meters).
(CGPoint)	- metersToScreenPosition:clipToViewport:
	Converts metrics coordinates (meters) to screen coordinates (pixels).
(nullable NCCircleMapObject *)	- addCircleMapObject
	Creates and adds a circle map object to the location view.
(BOOL)	- removeCircleMapObject:
	Removes a circle map object from the location view.
(nullable NCIconMapObject *)	- addIconMapObject
	Creates and adds an icon map object to the location view.
(BOOL)	- removeIconMapObject:
	Removes an icon map object from the location view.
(nullable NCPolygonMapObject *)	- addPolygonMapObject
	Creates and adds a polygon map object to the location view.
(BOOL)	- removePolygonMapObject:
	Removes a polygon map object from the location view.
(nullable NCPolylineMapObject *)	- addPolylineMapObject
	Creates and adds a polyline map object to the location view.
(BOOL)	- removePolylineMapObject:
	Removes a polyline map object from the location view.
(nullable NCDottedPolylineMapObject *)	- addDottedPolylineMapObject
	Creates and adds a polyline points map object to the location view.
(BOOL)	- removeDottedPolylineMapObject:
	Removes a polyline points map object from the location view.
(void)	- removeAllMapObjects
	Removes all map objects from the location view.
(void)	- pickMapObjectAt:
	Selects a visible, interactive map object at the specified screen position.
(void)	- pickMapFeatureAt:
	Selects visible map features (e.g., venues) at the specified screen position.
(void)	- addPickListener:
	Adds a PickListener to receive picking result events.
(void)	- removePickListener:
	Removes a previously added PickListener.
(void)	- addInputListener:
	Adds an InputListener to receive input events.
(void)	- removeInputListener:
	Removes a previously added InputListener.
(void)	- addCameraListener:
	Adds a CameraListener to receive camera movement events.
(void)	- removeCameraListener:
	Removes a previously added CameraListener.
(void)	- flyTo:duration:callback:
	Moves the map camera to a new position with an easing animation.
(BOOL)	- selectMapFeature:
	Selects a map feature by its feature ID.
(BOOL)	- deselectMapFeature:
	Deselects a map feature by its feature ID.
(void)	- deselectAllMapFeatures
	Deselects all currently selected map features.
(void)	- applyFilter:layer:
	Applies a filter to a specific map layer.
(void)	- moveTo:duration:animationType:callback:
	Moves the map camera to a new position with a smooth pan-and-zoom animation.

Class Methods
(void)	+ setDebugFlag:on:
	Sets the state of a debug flag.
(BOOL)	+ getDebugFlag:
	Gets the state of a debug flag.

Properties
float	zoomFactor
	Specifies the zoom level of the location view, in pixels per meter. Default: approximately 100 meters across the screen width.
float	minZoomFactor
	Minimum zoom level for the location view (pixels per meter).
float	maxZoomFactor
	Maximum zoom level for the location view (pixels per meter).
BOOL	stickToBorder
	Specifies whether sublocation content sticks to screen borders. If true, content sticks to screen bounds; if false, content is centered. Default: true.
NCCamera *	camera
	Current camera position in meters. Camera.
BOOL	rotateGestureEnabled
	Specifies whether rotation gestures (e.g., two-finger rotation) are enabled.
BOOL	tiltGesturesEnabled
	Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.
BOOL	scrollGesturesEnabled
	Specifies whether scroll gestures (e.g., pan gesture) are enabled.
BOOL	zoomGesturesEnabled
	Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.
float	pickRadius
	Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.
NSArray< NSString * > *	selectedMapFeatures
	List of currently selected map feature IDs.

Detailed Description

Interface for interacting with the location view.

Referenced from LocationView.

Definition at line 33 of file NCLocationWindow.h.

Method Documentation

addCameraListener:

- (void) addCameraListener:

(nullable id< NCCameraListener >)

listener

Adds a CameraListener to receive camera movement events.

Parameters

listener

The CameraListener instance CameraListener.

Note

Remove the listener when no longer needed.

addCircleMapObject

- (nullable NCCircleMapObject *) addCircleMapObject

Creates and adds a circle map object to the location view.

Returns

A CircleMapObject instance CircleMapObject if successful, null otherwise.

addDottedPolylineMapObject

- (nullable NCDottedPolylineMapObject *) addDottedPolylineMapObject

Creates and adds a polyline points map object to the location view.

Returns

A DottedPolylineMapObject instance DottedPolylineMapObject if successful, null otherwise.

addIconMapObject

- (nullable NCIconMapObject *) addIconMapObject

Creates and adds an icon map object to the location view.

Returns

An IconMapObject instance IconMapObject if successful, null otherwise.

addInputListener:

- (void) addInputListener:

(nullable id< NCInputListener >)

listener

Adds an InputListener to receive input events.

Parameters

listener

The InputListener instance InputListener.

Note

Remove the listener when no longer needed.

addPickListener:

- (void) addPickListener:

(nullable id< NCPickListener >)

listener

Adds a PickListener to receive picking result events.

Parameters

listener

The PickListener instance PickListener.

Note

Remove the listener when no longer needed.

addPolygonMapObject

- (nullable NCPolygonMapObject *) addPolygonMapObject

Creates and adds a polygon map object to the location view.

Returns

A PolygonMapObject instance PolygonMapObject if successful, null otherwise.

addPolylineMapObject

- (nullable NCPolylineMapObject *) addPolylineMapObject

Creates and adds a polyline map object to the location view.

Returns

A PolylineMapObject instance PolylineMapObject if successful, null otherwise.

applyFilter:layer:

- (void) applyFilter:		(nonnull NSString *)	filter
layer:		(nonnull NSString *)	layer

Applies a filter to a specific map layer.

Parameters

filter	The filter stringю
layer	The map layer to apply the filter to.

Returns

true if the operation is successful, false otherwise.

deselectAllMapFeatures

- (void) deselectAllMapFeatures

Deselects all currently selected map features.

deselectMapFeature:

- (BOOL) deselectMapFeature:

(nonnull NSString *)

featureId

Deselects a map feature by its feature ID.

Parameters

featureId

The feature ID from the mapFeaturePickResult PickListener.

Returns

true if the operation is successful, false otherwise.

flyTo:duration:callback:

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

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

Parameters

camera	The new camera position Camera.
duration	Animation duration in milliseconds.
callback	Callback to execute when the animation completes CameraCallback.

getDebugFlag:

+ (BOOL) getDebugFlag:

(NCDebugFlag)

flag

Gets the state of a debug flag.

Parameters

flag	The debug flag to query DebugFlag.

Returns

true if the debug flag is enabled, false otherwise.

metersToScreenPosition:clipToViewport:

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

Converts metrics coordinates (meters) to screen coordinates (pixels).

Parameters

point	(x,y) coordinates in meters Point.
clipToViewport	If true, coordinates outside the viewport are clipped to the viewport edge.

Returns

(x,y) coordinates in screen pixels ScreenPoint.

moveTo:duration:animationType:callback:

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

Moves the map camera to a new position with a smooth pan-and-zoom animation.

Parameters

camera	The new camera position Camera.
duration	Animation duration in milliseconds (-1 for default duration).
animationType	The type of easing animation AnimationType.
callback	Callback to execute when the animation completes CameraCallback.

pickMapFeatureAt:

- (void) pickMapFeatureAt:

(CGPoint)

point

Selects visible map features (e.g., venues) at the specified screen position.

Parameters

point

Position in screen pixels to pick from ScreenPoint. Results are delivered to the PickListener via onMapFeaturePickComplete PickListener.

pickMapObjectAt:

- (void) pickMapObjectAt:

(CGPoint)

point

Selects a visible, interactive map object at the specified screen position.

Parameters

point

Position in screen pixels to pick from ScreenPoint. Results are delivered to the PickListener via onMapObjectPickComplete PickListener.

removeAllMapObjects

- (void) removeAllMapObjects

Removes all map objects from the location view.

removeCameraListener:

- (void) removeCameraListener:

(nullable id< NCCameraListener >)

listener

Removes a previously added CameraListener.

Parameters

listener

The CameraListener instance to remove CameraListener.

removeCircleMapObject:

- (BOOL) removeCircleMapObject:

(nullable NCCircleMapObject *)

circleMapObject

Removes a circle map object from the location view.

Parameters

circleMapObject

The circle map object instance CircleMapObject.

Returns

true if the operation is successful, false otherwise.

removeDottedPolylineMapObject:

- (BOOL) removeDottedPolylineMapObject:

(nullable NCDottedPolylineMapObject *)

dottedPolylineMapObject

Removes a polyline points map object from the location view.

Parameters

dottedPolylineMapObject

The polyline points map object instance DottedPolylineMapObject.

Returns

true if the operation is successful, false otherwise.

removeIconMapObject:

- (BOOL) removeIconMapObject:

(nullable NCIconMapObject *)

iconMapObject

Removes an icon map object from the location view.

Parameters

iconMapObject

The icon map object instance IconMapObject.

Returns

true if the operation is successful, false otherwise.

removeInputListener:

- (void) removeInputListener:

(nullable id< NCInputListener >)

listener

Removes a previously added InputListener.

Parameters

listener

The InputListener instance to remove InputListener.

removePickListener:

- (void) removePickListener:

(nullable id< NCPickListener >)

listener

Removes a previously added PickListener.

Parameters

listener

The PickListener instance to remove PickListener.

removePolygonMapObject:

- (BOOL) removePolygonMapObject:

(nullable NCPolygonMapObject *)

polygonMapObject

Removes a polygon map object from the location view.

Parameters

polygonMapObject

The polygon map object instance PolygonMapObject.

Returns

true if the operation is successful, false otherwise.

removePolylineMapObject:

- (BOOL) removePolylineMapObject:

(nullable NCPolylineMapObject *)

polylineMapObject

Removes a polyline map object from the location view.

Parameters

polylineMapObject

The polyline map object instance PolylineMapObject.

Returns

true if the operation is successful, false otherwise.

screenPositionToMeters:

- (nonnull NCPoint *) screenPositionToMeters:

(CGPoint)

point

Converts screen coordinates (pixels) to metrics coordinates (meters).

Parameters

point

(x,y) coordinates in screen pixels ScreenPoint.

Returns

(x,y) coordinates in meters Point.

selectMapFeature:

- (BOOL) selectMapFeature:

(nonnull NSString *)

featureId

Selects a map feature by its feature ID.

Parameters

featureId

The feature ID from the mapFeaturePickResult PickListener.

Returns

true if the operation is successful, false otherwise.

setDebugFlag:on:

+ (void) setDebugFlag:		(NCDebugFlag)	flag
on:		(BOOL)	on

Sets the state of a debug flag.

Parameters

flag	The debug flag to set DebugFlag.
on	Specifies whether the debug flag is enabled (true) or disabled (false).

setSublocationId:

- (void) setSublocationId:

(int32_t)

id

Method is used to switch the location view between sublocations (e.g., floors).

Parameters

id	Sublocation unique identifier Sublocation.

Property Documentation

camera

- (NCCamera*) camera

readwritenonatomicassign

Current camera position in meters. Camera.

Definition at line 341 of file NCLocationWindow.h.

maxZoomFactor

- (float) maxZoomFactor

readwritenonatomicassign

Maximum zoom level for the location view (pixels per meter).

Definition at line 325 of file NCLocationWindow.h.

minZoomFactor

- (float) minZoomFactor

readwritenonatomicassign

Minimum zoom level for the location view (pixels per meter).

Definition at line 318 of file NCLocationWindow.h.

pickRadius

- (float) pickRadius

readwritenonatomicassign

Radius for picking features on the map, in density-independent pixels. Default: 0.5 dp.

Definition at line 377 of file NCLocationWindow.h.

rotateGestureEnabled

- (BOOL) rotateGestureEnabled

readwritenonatomicassign

Specifies whether rotation gestures (e.g., two-finger rotation) are enabled.

Definition at line 348 of file NCLocationWindow.h.

scrollGesturesEnabled

- (BOOL) scrollGesturesEnabled

readwritenonatomicassign

Specifies whether scroll gestures (e.g., pan gesture) are enabled.

Definition at line 362 of file NCLocationWindow.h.

selectedMapFeatures

- (NSArray<NSString *>*) selectedMapFeatures

readnonatomicassign

List of currently selected map feature IDs.

Definition at line 384 of file NCLocationWindow.h.

stickToBorder

- (BOOL) stickToBorder

readwritenonatomicassign

Specifies whether sublocation content sticks to screen borders. If true, content sticks to screen bounds; if false, content is centered. Default: true.

Definition at line 333 of file NCLocationWindow.h.

tiltGesturesEnabled

- (BOOL) tiltGesturesEnabled

readwritenonatomicassign

Specifies whether tilt gestures (e.g., two-finger parallel pan) are enabled.

Definition at line 355 of file NCLocationWindow.h.

zoomFactor

- (float) zoomFactor

readwritenonatomicassign

Specifies the zoom level of the location view, in pixels per meter. Default: approximately 100 meters across the screen width.

Definition at line 311 of file NCLocationWindow.h.

zoomGesturesEnabled

- (BOOL) zoomGesturesEnabled

readwritenonatomicassign

Specifies whether zoom gestures (e.g., two-finger pinch) are enabled.

Definition at line 369 of file NCLocationWindow.h.

---

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

• NCLocationWindow.h