deCartaIcon Class Reference
[Classes for map display and map-related functionality]

An icon to overlay onto the map. More...

#import <deCartaIcon.h>

List of all members.

Public Member Functions
(id)	- initWithImage:size:offset:
(id)	- initWithImage:
Properties
deCartaXYInteger *	size
deCartaXYInteger *	offset
UIImage *	image

---

Detailed Description

An icon to overlay onto the map.

The deCartaIcon class is used to create custom icon objects that can be overlayed on a deCartaMap in conjunction with a deCartaPin (a dynamically created point representing a location on the map).

---

Member Function Documentation

- (id) initWithImage:

(UIImage *)

image

Initializes the deCartaIcon object with an image, but does not specify screen coordinates or image size.

Parameters:

image

Source image for the icon

Returns:

The Objective-C ID of the created deCartaIcon object.

- (id) initWithImage:		(UIImage *)	image
size:		(deCartaXYInteger *)	size
offset:		(deCartaXYInteger *)	offset

Initializes the deCartaIcon object with an image, image size, and screen coordinates.

Parameters:

	image	Source image for the icon
	size	Size of the icon (width and height), specified as a deCartaXYInteger
	offset	(X,Y) coordinate indicating the offset to the left and up at which to place the top-left corner of the icon when rendering.

Returns:

The ID of the created deCartaIcon object.

---

Property Documentation

- (UIImage*) image [read, write, retain]

Offset of the icon from the target position. A value of X=20 and Y=30 means that the top-left corner of the icon would be placed 20 pixels to the left and 30 pixels above the specified position.

- (deCartaXYInteger*) offset [read, write, retain]

The icon to display

- (deCartaXYInteger*) size [read, write, retain]

The width(X) and height(Y) of the icon, in pixels

---

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

• D:/decarta_projects/export08122011/iPhoneV2/iPhoneAPI/map/deCartaIcon.h
• D:/decarta_projects/export08122011/iPhoneV2/iPhoneAPI/map/deCartaIcon.m