GeoListener explanation of what GeoListener is and/or does

Inherits from: Object

More detailed prose description of GeoListener.

See also: Object [some other help files]

Some Important Issues Regarding GeoListener (optional)

Explanation of the issues. For more information see Nil and [some other help files].

Creation / Class Methods

*new (runner, a, b, scapeDimx, scapeDimy)

Short prose description of method.

runner - Explanation of runner. Default value is nil. Other information.

a - Explanation of a. Default value is 1000. Other information.

b - Explanation of b. Default value is 700. Other information.

scapeDimx - Explanation of scapeDimx. Default value is nil. Other information.

scapeDimy - Explanation of scapeDimy. Default value is nil. Other information.

// inline example

g = GeoListener.new;

g.doSomething; // explanation

g.cleanUpMethod;

Accessing Instance and Class Variables

runner_(arg1)

runner

Explanation including the type of runner and a link to its help file.

Default value is nil.

offsetAngle_(arg1)

offsetAngle

Explanation including the type of offsetAngle and a link to its help file.

Default value is nil.

la_(arg1)

la

Explanation including the type of la and a link to its help file.

Default value is nil.

perceptionArea_(arg1)

perceptionArea

Explanation including the type of perceptionArea and a link to its help file.

Default value is nil.

newPi_(arg1)

newPi

Explanation including the type of newPi and a link to its help file.

Default value is nil.

lb_(arg1)

lb

Explanation including the type of lb and a link to its help file.

Default value is nil.

scapeDimy_(arg1)

scapeDimy

Explanation including the type of scapeDimy and a link to its help file.

Default value is nil.

lorient_(arg1)

lorient

Explanation including the type of lorient and a link to its help file.

Default value is nil.

scapeDimx_(arg1)

scapeDimx

Explanation including the type of scapeDimx and a link to its help file.

Default value is nil.

offsetVertexStandardListenedArea_(arg1)

offsetVertexStandardListenedArea

Explanation including the type of offsetVertexStandardListenedArea and a link to its help file.

Default value is nil.

Doing Some Task (optional)

A short bit of prose explaining something about the task.

initGeoListener (aRunner, aA, aB, aScapeDimx, aScapeDimy)

Short prose description of method.

aRunner - Explanation of aRunner. Default value is nil. Other information.

aA - Explanation of aA. Default value is nil. Other information.

aB - Explanation of aB. Default value is nil. Other information.

aScapeDimx - Explanation of aScapeDimx. Default value is nil. Other information.

aScapeDimy - Explanation of aScapeDimy. Default value is nil. Other information.

// inline example

g = GeoListener.initGeoListener;

g.doSomething; // explanation

g.cleanUpMethod;

gostraight

Short prose description of method.

// inline example

g = GeoListener.gostraight;

g.doSomething; // explanation

g.cleanUpMethod;

goback

Short prose description of method.

// inline example

g = GeoListener.goback;

g.doSomething; // explanation

g.cleanUpMethod;

turnleft

Short prose description of method.

// inline example

g = GeoListener.turnleft;

g.doSomething; // explanation

g.cleanUpMethod;

turnright

Short prose description of method.

// inline example

g = GeoListener.turnright;

g.doSomething; // explanation

g.cleanUpMethod;

setPosition (x, y)

Short prose description of method.

x - Explanation of x. Default value is nil. Other information.

y - Explanation of y. Default value is nil. Other information.

// inline example

g = GeoListener.setPosition;

g.doSomething; // explanation

g.cleanUpMethod;

getPosition

Short prose description of method.

// inline example

g = GeoListener.getPosition;

g.doSomething; // explanation

g.cleanUpMethod;

filter (aXv, aYv, aA, aB, aOffsetVertexListenedArea)

Short prose description of method.

aXv - Explanation of aXv. Default value is nil. Other information.

aYv - Explanation of aYv. Default value is nil. Other information.

aA - Explanation of aA. Default value is nil. Other information.

aB - Explanation of aB. Default value is nil. Other information.

aOffsetVertexListenedArea - Explanation of aOffsetVertexListenedArea. Default value is nil. Other information.

// inline example

g = GeoListener.filter;

g.doSomething; // explanation

g.cleanUpMethod;

calculatePanning (aXv, aYv, aA, aB, aOrient)

Short prose description of method.

aXv - Explanation of aXv. Default value is nil. Other information.

aYv - Explanation of aYv. Default value is nil. Other information.

aA - Explanation of aA. Default value is nil. Other information.

aB - Explanation of aB. Default value is nil. Other information.

aOrient - Explanation of aOrient. Default value is nil. Other information.

// inline example

g = GeoListener.calculatePanning;

g.doSomething; // explanation

g.cleanUpMethod;

update (theChanged, theChanger, more)

Short prose description of method.

theChanged - Explanation of theChanged. Default value is nil. Other information.

theChanger - Explanation of theChanger. Default value is nil. Other information.

more - Explanation of more. Default value is nil. Other information.

// inline example

g = GeoListener.update;

g.doSomething; // explanation

g.cleanUpMethod;

Examples

// what this example does

e = GeoListener.new;

e.instanceMethod(someObject);

e.cleanUp;

...