A pin to place on a map. More...
#import <deCartaPin.h>
Inherits deCartaEventSource-p.
Public Member Functions | |
| (deCartaPOI *poi) | - __attribute__ |
| (id) | - initWithPosition:icon:message:rotationTilt: |
Properties | |
| deCartaIcon * | icon |
| NSString * | message |
| BOOL | visible |
| deCartaOverlay * | ownerOverlay |
| deCartaRotationTilt * | rotationTilt |
| id | associatedObject |
A pin to place on a map.
Used to define a pin object to place at a specific location on the map. A pin is stored in a deCartaOverlay object (see deCartaOverlay for more information on how to use map overlays).
The deCartaPin class inherits from the deCartaEventSource class, and extends the class by adding functionality for triggering events. When TOUCH event is detected on the deCartaMapView over the deCartaPin's location, the deCartaPin will call it's listeners (deCartaEventLister objects) with the TOUCH event type (defined by the EventTypeEnum).
| - (deCartaPOI* poi) __attribute__ | ((deprecated)) |
This property is deprecated, associatedObject should be used instead.
| - (id) initWithPosition: | (deCartaPosition *) | position | ||
| icon: | (deCartaIcon *) | icon | ||
| message: | (NSString *) | message | ||
| rotationTilt: | (deCartaRotationTilt *) | rt | ||
Initializes a deCartaPin with items that describe the pin's graphic, text, and position.
| position | The geographic position at which to place the pin. | |
| icon | The graphic icon to display at this location. Note that an deCartaIcon object contains both a graphic and the offset for displaying the graphic relative to the map point. | |
| message | A text message that is stored with the pin. | |
| rt | A tilt value for the pin. See the deCartaRotationTilt class for details about how tilt is defined. |
- (id) associatedObject [read, write, retain] |
General object associated with this pin. The caller should be responsible to know the type infomation.
- (deCartaIcon*) icon [read, write, retain] |
The graphical icon (and display details) for the icon associated with this pin.
- (NSString*) message [read, write, retain] |
A text string stored with this pin (generally an address or POI name)
- (deCartaOverlay*) ownerOverlay [read, write, retain] |
In order to display deCartaPin object on the map, they need to be placed into a deCartaOverlay which is a container for one or more deCartaPins, and then that overlay must be added to the overlays of the deCartaMapView. Once added to an overlay, the deCartaPin object uses this property to maintain a pointer the overlay in which it is contained.
- (deCartaRotationTilt*) rotationTilt [read, retain] |
A tilt property for this pin, which defines how much to tilt the pin relative to the map. See the deCartaRotiationTilt class for details about defining tilt.
- (BOOL) visible [read, write, assign] |
Set to TRUE to display this pin on the map.
1.6.1
