AGSGraphicsOverlayFenceParameters Class Reference

Description

Geotrigger fence parameters data created from an AGSGraphicsOverlay.

The AGSGraphicsOverlay used to create an AGSGraphicsOverlayFenceParameters provides a dynamic set of graphics that define targets for an AGSFenceGeotrigger condition. For example, if the condition is "notify me when my position comes within 50 meters of one of my target areas", "my target areas" are the graphics in the overlay. Changes to the AGSGraphicsOverlay will be reflected in the fences tracked by the AGSGeotrigger.

An AGSGraphicsOverlayFenceParameters allows you to track all of the graphics displayed on the AGSGeoView in an AGSGraphicsOverlay. This allows you to track new target areas as they are added to the view and to stop tracking areas that are removed. If you wish to track a subset of the graphics displayed in an AGSGraphicsOverlay, or graphics which are not displayed in an AGSGeoView, use an AGSGraphicFenceParameters.

The graphics can have point, line, or polygon geometry. An AGSFenceParameters::bufferDistance must be supplied for points or lines.

Since

100.12

Inheritance diagram for AGSGraphicsOverlayFenceParameters:

Instance Methods
(instancetype)	- initWithGraphicsOverlay:
(instancetype)	- initWithGraphicsOverlay:bufferDistance:

Class Methods
(nullable AGSFenceParameters *)	+ fenceParametersWithGeoElement:bufferDistance:
(instancetype)	+ graphicsOverlayFenceParametersWithGraphicsOverlay:
(instancetype)	+ graphicsOverlayFenceParametersWithGraphicsOverlay:bufferDistance:

Properties
double	bufferDistance
AGSGraphicsOverlay *	graphicsOverlay

Method Documentation

fenceParametersWithGeoElement:bufferDistance:

+ (nullable AGSFenceParameters *) fenceParametersWithGeoElement:		(id< AGSGeoElement >)	geoElement
bufferDistance:		(double)	bufferDistance

Static factory function to create an AGSFenceParameters.

This method creates the appropriate type of AGSFenceParameters based on the type of the AGSGeoElement that was supplied. The supported types of AGSGeoElement are AGSGraphic and AGSFeature.

If passed an unsupported AGSGeoElement, this method will return nil.

Parameters

geoElement	An individual AGSGeoElement used to create an AGSFenceParameters object.
bufferDistance	A buffer distance in meters to apply to the AGSGeoElement when checking if an AGSGeotrigger condition is met.

Returns

An AGSFenceParameters created from an AGSGeoElement.

Since

100.12

graphicsOverlayFenceParametersWithGraphicsOverlay:

+ (instancetype) graphicsOverlayFenceParametersWithGraphicsOverlay:

(AGSGraphicsOverlay *)

graphicsOverlay

Creates an AGSGraphicsOverlayFenceParameters using all of the graphics in the AGSGraphicsOverlay.

Note that the AGSGraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if an AGSGraphic is removed or added to the original AGSGraphicsOverlay, it will be added or removed as a fence.

Parameters

graphicsOverlay

The AGSGraphicsOverlay, to use as the source of graphics for the AGSGraphicFenceParameters.

Since

100.12

graphicsOverlayFenceParametersWithGraphicsOverlay:bufferDistance:

+ (instancetype) graphicsOverlayFenceParametersWithGraphicsOverlay:		(AGSGraphicsOverlay *)	graphicsOverlay
bufferDistance:		(double)	bufferDistance

Creates an AGSGraphicsOverlayFenceParameters using all of the graphics in the AGSGraphicsOverlay buffered by the buffer distance.

Note that the AGSGraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if an AGSGraphic is removed or added to the original AGSGraphicsOverlay, it will be added or removed as a fence.

Parameters

graphicsOverlay	The AGSGraphicsOverlay, to use as the source of graphics for the AGSGraphicFenceParameters.
bufferDistance	A buffer distance in meters to apply to the graphics when checking if an AGSGeotrigger condition is met.

Since

100.12

initWithGraphicsOverlay:

- (instancetype) initWithGraphicsOverlay:

(AGSGraphicsOverlay *)

graphicsOverlay

Creates an AGSGraphicsOverlayFenceParameters using all of the graphics in the AGSGraphicsOverlay.

Note that the AGSGraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if an AGSGraphic is removed or added to the original AGSGraphicsOverlay, it will be added or removed as a fence.

Parameters

graphicsOverlay

The AGSGraphicsOverlay, to use as the source of graphics for the AGSGraphicFenceParameters.

Since

100.12

initWithGraphicsOverlay:bufferDistance:

- (instancetype) initWithGraphicsOverlay:		(AGSGraphicsOverlay *)	graphicsOverlay
bufferDistance:		(double)	bufferDistance

Creates an AGSGraphicsOverlayFenceParameters using all of the graphics in the AGSGraphicsOverlay buffered by the buffer distance.

Note that the AGSGraphicsOverlayFenceParameters will respect any changes made to the supplied graphics overlay - for example, if an AGSGraphic is removed or added to the original AGSGraphicsOverlay, it will be added or removed as a fence.

Parameters

graphicsOverlay	The AGSGraphicsOverlay, to use as the source of graphics for the AGSGraphicFenceParameters.
bufferDistance	A buffer distance in meters to apply to the graphics when checking if an AGSGeotrigger condition is met.

Since

100.12

Property Documentation

bufferDistance

- (double) bufferDistance

readnonatomicassigninherited

A buffer distance in meters to apply when checking if an AGSFenceGeotrigger condition is met.

For example, if the rule is "enters within 50 meters" you use an AGSFenceGeotrigger::ruleType of AGSFenceRuleTypeEnter and set this property to 50.

Buffers are Geodetic and created using the following default values:

• AGSGeodeticCurveTypeShapePreserving
• Max deviation = NAN
• AGSLinearUnitIDMeters

If your fences use a point or polyline geometry then you must set this property to a value greater than 0.

Since

100.12

graphicsOverlay

- (AGSGraphicsOverlay*) graphicsOverlay

readnonatomicstrong

The AGSGraphicsOverlay to use in the AGSGraphicsOverlayFenceParameters.

Changes to the AGSGraphicsOverlay will be reflected in the fences tracked by the AGSGeotrigger.

Since

100.12