Changeset 168


Ignore:
Timestamp:
Apr 19, 2011, 8:56:17 PM (11 years ago)
Author:
jmckenna
Message:

add missing function details

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/api/zoo.txt

    r160 r168  
    8484
    8585removeItem     
    86   Remove an object from an array.
     86  ::
     87 
     88    removeItem: function(array,item)
     89 
     90  Remove an object from an array.  Iterates through the array to find the item, then removes it.
     91 
     92  *Parameters*
     93 
     94  | ``array {Array}``
     95  | ``item {Object}``
     96 
     97  *Returns*
     98   
     99  ``{Array}`` A reference to the array
    87100 
    88101.. _indexOf:
    89102
    90103indexOf
     104  ::
     105 
     106    indexOf: function(array,obj)
     107
     108  *Parameters*
     109   
     110  | ``array {Array}``
     111  | ``obj {Object}``
     112
     113  *Returns*
     114
     115  ``{Integer}`` The index at, which the first object was found in the array.  If not found, returns -1.
    91116
    92117.. _extend:
    93118
    94119extend
    95   Copy all properties of a source object to a destination object.
     120  ::
     121 
     122    extend: function(destination,source)
     123
     124  Copy all properties of a source object to a destination object.  Modifies the passed in destination object. 
     125  Any properties on the source object that are set to undefined will not be (re)set on the destination object.
     126
     127  *Parameters*
     128 
     129  | ``destination {Object}`` The object that will be modified
     130  | ``source {Object}`` The object with properties to be set on the destination
     131
     132  *Returns*
     133
     134  ``{Object}`` The destination object.
    96135 
    97136.. _rad: 
    98137 
    99138rad     
     139  ::
     140 
     141    rad: function(x)
     142
     143  *Parameters*
     144 
     145  | ``x {Float}``
     146
     147  *Returns*
     148
     149  ``{Float}``
    100150
    101151.. _distVincenty:
    102152
    103 distVincenty   
    104   Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid.
     153distVincenty
     154  ::
     155
     156    distVincenty: function(p1,p2)
     157
     158  Given two objects representing points with geographic coordinates, this calculates the distance between
     159  those points on the surface of an ellipsoid.
     160
     161  *Parameters:*
     162
     163  | ``p1`` :ref:`{ZOO.Geometry.Point} <zoo-geometry-point>` (or any object with both .x, .y properties)``
     164  | ``p2`` :ref:`{ZOO.Geometry.Point} <zoo-geometry-point>` (or any object with both .x, .y properties)
    105165
    106166.. _Class:
    107167
    108168Class   
    109   Method used to create ZOO classes.
     169  ::
     170 
     171    Class: function()
     172
     173  Method used to create ZOO classes.  Includes support for multiple inheritance.
    110174 
    111175.. _UpdateStatus: 
    112176 
    113177UpdateStatus   
     178  ::
     179 
     180    UpdateStatus: function(env,value)
     181
    114182  Method used to update the status of the process
    115183
     184  *Parameters*
     185 
     186  | ``env {Object}`` The environment object
     187  | ``value {Float}`` The status value between 0 to 100
     188
Note: See TracChangeset for help on using the changeset viewer.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png