AGSOffsetParameters Class Reference


Description

Instances of this class represent parameters for AGSGeometryServiceTask's offsetWithParameters: operation.

Defined in:
AGSGeometryParameters.h ( ArcGIS library)
Since:
1.0
See also:
AGSGeometryServiceTask
Inheritance diagram for AGSOffsetParameters:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:

Static Public Member Functions

(id) + offsetParameters

Properties

double bevelRatio
NSArray * geometries
double offsetDistance
AGSGeometryOffsetType offsetHow
AGSSRUnit offsetUnit
BOOL simplifyResult

Member Function Documentation

- (void) decodeWithJSON: (NSDictionary *)  json   [optional, inherited]

Decode object from JSON representation.

Parameters:
json The JSON representation of the object to be decoded.
Since:
1.0
- (NSDictionary *) encodeToJSON   [optional, inherited]

Encode and return JSON representation for object.

Returns:
JSON representation of object.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json   [optional, inherited]

Initialize and return object from JSON representation.

Parameters:
json The JSON representation of the object to be created.
Returns:
Object decoded from JSON representation.
Since:
1.0
+ (id) offsetParameters  

Returns an autoreleased instance of the AGSOffsetParameters object.

Since:
1.0

Property Documentation

- (double) bevelRatio [read, write, assign]

bevelRatio is multiplied by the offsetDistance and the result determines how far a mitered offset intersection can be located before it is bevelled. When mitered is specified, the input bevel ratio is ignored and 10 is used internally. When bevelled is specified, 1.1 will be used if bevelRatio is not specified. bevelRatio is ignored for rounded.

Since:
1.0
- (NSArray*) geometries [read, write, retain]

The array of geometries to be offset.

Since:
1.0
- (double) offsetDistance [read, write, assign]

Specifies the distance for constructing an offset based on the input geometries. If the offsetDistance parameter is positive the constructed offset will be on the right side of the curve. (Left side offsets are constructed with negative values.)

Since:
1.0
- (AGSGeometryOffsetType) offsetHow [read, write, assign]

Options that determine how the ends intersect.

Possible offsetHow types include:

  • AGSGeometryOffsetTypeMitered
  • AGSGeometryOffsetTypeBevelled
  • AGSGeometryOffsetTypeRounded
Since:
1.0
- (AGSSRUnit) offsetUnit [read, write, assign]

(Optional) A unit for offset distance. If unit is not specified, the units are derived from the spatial reference.

Since:
1.0
- (BOOL) simplifyResult [read, write, assign]

If set to true, the resulting geometries will be simplified.

Since:
1.0