SYMapTrafficSign Class Reference

Traffic sign can be displayed on a geographical position on a map or on a constant position on screen. In order to display the object on the map, the object needs to be added to an SYMapView by calling addMapObject:. More...

#import <SYMapObjects.h>

Inheritance diagram for SYMapTrafficSign:
Collaboration diagram for SYMapTrafficSign:

Instance Methods

(nonnull instancetype) - initWithCoordinate:
 Initializes a SYMapTrafficSign instance with the specified SYGeoCoordinate geographical position. More...
 
(nonnull instancetype) - initWithCoordinate:payload:
 Initializes a SYMapTrafficSign instance with the specified SYGeoCoordinate geographical position. More...
 
(nonnull instancetype) - initWithScreenPosition:
 Initializes a SYMapTrafficSign instance with the specified CGPoint position on screen. More...
 
(nonnull instancetype) - initWithScreenPosition:payload:
 Initializes a SYMapTrafficSign instance with the specified CGPoint position on screen. More...
 
(SYMapTrafficSignType signType) - __deprecated_msg
 Type of SYMapTrafficSign. See the available SYMapTrafficSignType. Default value is SYMapTrafficSignTypeSpeedLimit. More...
 

Properties

SYMapTrafficSignSettingsType trafficSignType
 Type of SYMapTrafficSign. See the available SYMapTrafficSignSettingsType. Default value is SYMapTrafficSignSettingsTypeSpeedLimit. More...
 
SYMapTrafficSignFormType form
 The form of SYMapTrafficSign. See the available SYMapTrafficSignFormType. Default value is SYMapTrafficSignFormTypeSimple. More...
 
float limitValue
 A value to be displayed on SYMapTrafficSign. The value must be set in the following units: SYMapTrafficSignSettingsTypeSpeedLimit - kilometers per hour. SYMapTrafficSignSettingsTypeVehicleGrossWeight, SYMapTrafficSignSettingsTypeAxleWeight - kilograms SYMapTrafficSignSettingsTypeVehicleMaximumHeight, SYMapTrafficSignSettingsTypeVehicleWidth, SYMapTrafficSignSettingsTypeVehicleTotalLength - metres For the other sign types the limit value is ignored. More...
 
SYMapTrafficSignSettingsCountry country
 Visual type of the traffic sign based on the country where it's used. Default value is SYMapTrafficSignSettingsCountryWorld. More...
 
SYMapTrafficSignSettingsUnitSystem unitType
 Unit system used for displaying the limitValue property. Default value is SYMapTrafficSignSettingsCountryWorld. More...
 
CGPoint scale
 SYMapTrafficSign scale. Default value is [1.0, 1.0]. More...
 
CGFloat minZoomLevel
 Minimum zoom level, at which SYMapTrafficSign is displayed. More...
 
CGFloat maxZoomLevel
 Maximum zoom level, at which SYMapTrafficSign is displayed. More...
 
- Properties inherited from SYMapObject
NSInteger tag
 An integer that you can use to identify view objects in your application. Default value is 0. More...
 
SYMapObjectType mapObjectType
 Map object type. See the available SYMapObjectTypes. More...
 
NSUInteger zIndex
 Z-index (stacking order) for the SYMapObject. Objects with the highest value are placed at the top of the stacking order. More...
 
BOOL visibility
 Visibility of the SYMapObject. Can be shown or hidden. More...
 
- Properties inherited from SYViewObject
SYGeoCoordinatecoordinate
 Geographical location of the SYViewObject. The meaning of the location for a particular object depends on that object's type. Objects that don't have a location will return nil. The meaning of the location for certain view objects is as follows: More...
 
CGPoint screenPosition
 Position of the SYViewObject on the screen. More...
 
SYViewObjectType baseType
 Determines which type of this ViewObject it is. More...
 
id< NSCoding > payload
 Optional payload for storing custom data. More...
 

Detailed Description

Traffic sign can be displayed on a geographical position on a map or on a constant position on screen. In order to display the object on the map, the object needs to be added to an SYMapView by calling addMapObject:.

Method Documentation

◆ initWithCoordinate:

- (nonnull instancetype) initWithCoordinate: (nonnull SYGeoCoordinate *)  coordinate

Initializes a SYMapTrafficSign instance with the specified SYGeoCoordinate geographical position.

◆ initWithCoordinate:payload:

- (nonnull instancetype) initWithCoordinate: (nonnull SYGeoCoordinate *)  coordinate
payload: (nullable id< NSCoding >)  payload 

Initializes a SYMapTrafficSign instance with the specified SYGeoCoordinate geographical position.

Parameters
payloadOptional data payload that can be stored in SYMapTrafficSign.

◆ initWithScreenPosition:

- (nonnull instancetype) initWithScreenPosition: (CGPoint)  screenPosition

Initializes a SYMapTrafficSign instance with the specified CGPoint position on screen.

◆ initWithScreenPosition:payload:

- (nonnull instancetype) initWithScreenPosition: (CGPoint)  screenPosition
payload: (nullable id< NSCoding >)  payload 

Initializes a SYMapTrafficSign instance with the specified CGPoint position on screen.

Parameters
payloadOptional data payload that can be stored in SYMapTrafficSign.

◆ __deprecated_msg

- (SYMapTrafficSignType signType) __deprecated_msg ("use trafficSignType instead.") 

Type of SYMapTrafficSign. See the available SYMapTrafficSignType. Default value is SYMapTrafficSignTypeSpeedLimit.

Property Documentation

◆ trafficSignType

- (SYMapTrafficSignSettingsType) trafficSignType
readwritenonatomicassign

Type of SYMapTrafficSign. See the available SYMapTrafficSignSettingsType. Default value is SYMapTrafficSignSettingsTypeSpeedLimit.

◆ form

- (SYMapTrafficSignFormType) form
readwritenonatomicassign

The form of SYMapTrafficSign. See the available SYMapTrafficSignFormType. Default value is SYMapTrafficSignFormTypeSimple.

◆ limitValue

- (float) limitValue
readwritenonatomicassign

A value to be displayed on SYMapTrafficSign. The value must be set in the following units: SYMapTrafficSignSettingsTypeSpeedLimit - kilometers per hour. SYMapTrafficSignSettingsTypeVehicleGrossWeight, SYMapTrafficSignSettingsTypeAxleWeight - kilograms SYMapTrafficSignSettingsTypeVehicleMaximumHeight, SYMapTrafficSignSettingsTypeVehicleWidth, SYMapTrafficSignSettingsTypeVehicleTotalLength - metres For the other sign types the limit value is ignored.

The value will be converted and displayed in the units specified in unitType property. Default value is 0.

◆ country

- (SYMapTrafficSignSettingsCountry) country
readwritenonatomicassign

Visual type of the traffic sign based on the country where it's used. Default value is SYMapTrafficSignSettingsCountryWorld.

◆ unitType

- (SYMapTrafficSignSettingsUnitSystem) unitType
readwritenonatomicassign

Unit system used for displaying the limitValue property. Default value is SYMapTrafficSignSettingsCountryWorld.

◆ scale

- (CGPoint) scale
readwritenonatomicassign

SYMapTrafficSign scale. Default value is [1.0, 1.0].

◆ minZoomLevel

- (CGFloat) minZoomLevel
readwritenonatomicassign

Minimum zoom level, at which SYMapTrafficSign is displayed.

◆ maxZoomLevel

- (CGFloat) maxZoomLevel
readwritenonatomicassign

Maximum zoom level, at which SYMapTrafficSign is displayed.


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