SYViewObject Class Reference

Base class for objects shown in an SYMapView view. All objects displayed by an Sygic SDK view have SYViewObject as their base class. All such objects fall into one of two categories: proxy objects, created by the SDK, and user objects, created by the client application. These objects additionally inherit from SYViewObjects. More...

#import <SYViewObjects.h>

Inheritance diagram for SYViewObject:
Collaboration diagram for SYViewObject:

Instance Methods

(instancetype) - initWithCoordinate:baseType: [implementation]
 
(instancetype) - initWithCoordinate:baseType:payload: [implementation]
 

Class Methods

(std::vector< uint8_t >) + serializePayload: [implementation]
 
(id< NSCoding >) + deserializePayload: [implementation]
 

Properties

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...
 
SYViewObjectType baseType
 Determines which type of this ViewObject it is. More...
 
id< NSCoding > payload
 Optional payload for storing custom data. More...
 

Detailed Description

Base class for objects shown in an SYMapView view. All objects displayed by an Sygic SDK view have SYViewObject as their base class. All such objects fall into one of two categories: proxy objects, created by the SDK, and user objects, created by the client application. These objects additionally inherit from SYViewObjects.

Method Documentation

◆ deserializePayload:()

+ (id<NSCoding>) deserializePayload: (std::vector< uint8_t >)  payloadData
implementation

◆ initWithCoordinate:baseType:()

- (instancetype) initWithCoordinate: (SYGeoCoordinate *)  coordinate
baseType: (SYViewObjectType)  baseType 
implementation

◆ initWithCoordinate:baseType:payload:()

- (instancetype) initWithCoordinate: (SYGeoCoordinate *)  coordinate
baseType: (SYViewObjectType)  baseType
payload: (id< NSCoding >)  payload 
implementation

◆ serializePayload:()

+ (vector<uint8_t> SYViewObject()): (id< NSCoding >)  payloadData
implementation

Property Documentation

◆ baseType

- (SYViewObjectType) baseType
readnonatomicassign

Determines which type of this ViewObject it is.

◆ coordinate

- (SYGeoCoordinate*) coordinate
readnonatomicassign

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:

SYMapView objects: SYMapObjectTypePoint - has location. SYMapObjectTypeSafetySpot - has location SYMapObjectTypeReserved - has location SYMapObjectTypeCircle - the center of the circle SYMapObjectTypeContainer - no location SYMapObjectTypeMarker - has location SYMapObjectTypeLabelMarker - has location SYMapObjectTypePolygon - the center of the polygon SYMapObjectTypePolyline - the first vertex SYMapObjectTypeRoute - the first waypoint of the route

◆ payload

- (id<NSCoding>) payload
readwritenonatomicstrong

Optional payload for storing custom data.


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