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

Base class for all shapes (deCartaPolyline, deCartaPolygon, deCartaCircle). More...

#import <deCartaShape.h>

Inheritance diagram for deCartaShape:
deCartaCircle deCartaPolygon deCartaPolyline

List of all members.

Public Member Functions

(id) - initWithName:

Properties

NSString * name
BOOL visible
int fillColor
float opacity

Detailed Description

Base class for all shapes (deCartaPolyline, deCartaPolygon, deCartaCircle).

A deCartaShape, and the subclasses deCartaCircle, deCartaPolyline and deCartaPolygon, are used to visually display an overlay on an initialized deCartaMap. To use, simply create the shape, sometimes referred to as overlays, and add the shape to an instance of a deCartaMap with deCartaMap.addOverlay:.

Note:
Only the extended classes of deCartaShape can be drawn on a map. This class merely provides common methods shared by all shapes. The deCartaShape class is inherited from deCartaEventSource, but does not currently trigger any events.

Member Function Documentation

- (id) initWithName: (NSString *)  inShapeName  

Initializes a deCartaShape object with a name

Parameters:
inShapeName String indicating the name of the shape instance
Returns:
Objective-C ID of the returned deCartaShape object

Property Documentation

- (int) fillColor [read, write, assign]

The color of the shape or line. Defined in RGB format: 0xXXRRGGBB

- (NSString*) name [read, retain]

Name of the deCartaShape

- (float) opacity [read, write, assign]

Opacity of the shape, ranging from 0.0 (transparent) to 1.0 (opaque)

- (BOOL) visible [read, write, assign]

TRUE/FALSE visibility property


The documentation for this class was generated from the following files:
 All Classes Functions Variables Properties

Generated on Fri Aug 12 16:23:01 2011 for deCarta iPhone API by  doxygen 1.6.1