#BlueJ class context
comment0.target=class\ Footprint
comment0.text=Class\ for\ defining\ the\ spatial\ footprint\ of\ an\ object.\nUsing\ this\ class\ to\ wrap\ all\ public\ communication\ of\ locations\nand\ boundaries\ ensures\ maximum\ flexibility.\ Current\ model\ \nassumes\ 2d\ Cartesian\ referencing,\ but\ can\ be\ adapted\ in\ future.\n@author\ Jo\ Wood\n@version\ 1.2,\ 6th\ September,\ 2001.\n\n
comment1.target=width
comment10.params=
comment10.target=float\ getMERWidth()
comment10.text=Reports\ the\ width\ of\ the\ footprint's\ Minimum\ Enclosing\ Rectangle.\n@return\ width\ MER's\ width\ (in\ the\ x\ direction).\n\n
comment11.params=
comment11.target=int\ getType()
comment11.text=Reports\ the\ type\ of\ spatial\ footprint.\n@return\ Type\ of\ spatial\ footprint.\n\n
comment12.target=type
comment13.target=y
comment14.target=x
comment15.target=height
comment16.params=
comment16.target=float\ getMERHeight()
comment16.text=Reports\ the\ height\ of\ the\ footprint's\ Minimum\ Enclosing\ Rectangle.\n@return\ height\ MER's\ height\ (in\ the\ y\ direction).\n\n
comment17.params=xOrigin
comment17.target=void\ setXOrigin(float)
comment17.text=Sets\ the\ x\ origin\ of\ the\ footprint.\n@param\ xOrigin\ New\ x\ origin\ of\ the\ footprint.\n\n
comment18.params=
comment18.target=float\ getXOrigin()
comment18.text=Reports\ the\ x\ origin\ of\ the\ footprint.\n@return\ xOrigin\ Cartesian\ x\ coordinate\ of\ footprint.\n\n
comment2.params=
comment2.target=String\ toString()
comment2.text=Reports\ the\ details\ of\ this\ footprint.\n@return\ Summary\ of\ this\ footprint.\n\n
comment3.params=x\ y
comment3.target=Footprint(float,float)
comment3.text=Creates\ a\ point\ footprint\ with\ given\ x,y\ location.\n@param\ x\ X\ coordinate\ of\ footprint's\ location.\ \n@param\ y\ Y\ coordinate\ of\ footprint's\ location.\n\n
comment4.params=x\ y\ width\ height
comment4.target=Footprint(float,float,float,float)
comment4.text=Creates\ a\ 2d\ areal\ footprint\ with\ given\ origin,\ width\ and\ height.\n@param\ x\ X\ coordinate\ of\ footprint's\ origin.\ \n@param\ y\ Y\ coordinate\ of\ footprint's\ origin.\n@param\ width\ Width\ of\ object\ (in\ x\ direction).\n@param\ height\ Height\ of\ object\ (in\ y\ direction).\n\n
comment5.params=type
comment5.target=void\ setType(int)
comment5.text=Sets\ the\ type\ of\ spatial\ footprint.\n@param\ type\ Type\ of\ spatial\ footprint.\n\n
comment6.params=width
comment6.target=void\ setMERWidth(float)
comment6.text=Sets\ the\ width\ of\ the\ footprint's\ Minimum\ Enclosing\ Rectangle.\n@param\ width\ New\ width\ of\ the\ MER\ (in\ the\ x\ direction).\n\n
comment7.params=height
comment7.target=void\ setMERHeight(float)
comment7.text=Sets\ the\ width\ of\ the\ footprint's\ Minimum\ Enclosing\ Rectangle.\n@param\ width\ New\ width\ of\ the\ MER\ (in\ the\ x\ direction).\n\n
comment8.params=yOrigin
comment8.target=void\ setYOrigin(float)
comment8.text=Sets\ the\ y\ origin\ of\ the\ footprint.\n@param\ yOrigin\ New\ y\ origin\ of\ the\ footprint.\n\n
comment9.params=
comment9.target=float\ getYOrigin()
comment9.text=Reports\ the\ y\ origin\ of\ the\ footprint.\n@return\ yOrigin\ Cartesian\ y\ coordinate\ of\ footprint.\n\n
numComments=19