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

A circle object. More...

#import <deCartaCircle.h>

Inheritance diagram for deCartaCircle:
deCartaShape

List of all members.

Public Member Functions

(id) - initWithPosition:radius:name:

Properties

deCartaLengthradius
deCartaPositionposition

Detailed Description

A circle object.

deCartaCircle is an extension of deCartaShape, one that is specifically geared towards displaying a circle overlay at a specific coordinate on a deCartaMap. The deCartaCircle class inherits from the deCartaShape class, which inherits from the deCartaEventSource class. So, deCartaCircle could theoretically support event-capturing, but this functionality is not implemented, so a deCartaCircle will not trigger any events.


Member Function Documentation

- (id) initWithPosition: (deCartaPosition *)  inPosition
radius: (deCartaLength *)  inRadius
name: (NSString *)  inName 

Initialize the deCartaCircle object with a center position, radius, and name.

Parameters:
inPosition Geographic position of center of the circle
inRadius Radius of the circle
inName String name for the circle
Returns:
Objective-C ID of the returned deCartaCircle object

Property Documentation

- (deCartaPosition*) position [read, write, retain]

Center position of the circle

- (deCartaLength*) radius [read, write, retain]

Radius of the circle (Units of measure are defined within the deCartaLength class)


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