Class Index | File Index

Classes


Class Circle

represents circle
Defined in: raphaeltools.src.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Circle(raphael, cx, cz, r)
Circle (for easier modifying)
Field Summary
Field Attributes Field Name and Description
 
array of copies of receiver
 
array of shifts of copies of receiver
 
obj
actual raphael object
 
r
radius of the circle
 
raphael instance
 
x
x coordinate of circle center
 
z
z coordinate of circle center
Method Summary
Method Attributes Method Name and Description
 
copy(shifts)
Copy of receiver
<static>  
Circle.create(raphael, x, z, r)
Creates new Circle object, for parameters meaning see Circle
 
setR(r)
Sets radius of receiver
 
setX(x)
Sets x coordinate of receiver
 
setXZ(x, z)
Sets new coordinates of receiver
 
setZ(z)
Sets z coordinate of receiver
 
translate(dx, dz)
Translate receiver
 
Translate along x axis of receiver
 
Translate along z axis of receiver
 
up()
Update
Class Detail
Circle(raphael, cx, cz, r)
Circle (for easier modifying)
Parameters:
{Raphael} raphael
raphael instance
{float} cx Optional, Default: 0.
x coordinate of circle center
{float} cz Optional, Default: 0.
z coordinate of circle center
{float} r Optional, Default: 10.
circle radius
Field Detail
{[Circles]} copies
array of copies of receiver

{[[float|float]]} copiesShifts
array of shifts of copies of receiver

{Raphael.circle} obj
actual raphael object

{float} r
radius of the circle

{Raphael} raphael
raphael instance

{float} x
x coordinate of circle center

{float} z
z coordinate of circle center
Method Detail
copy(shifts)
Copy of receiver
Parameters:
{[[float|float]]} shifts
shifts of copies

<static> {Circle} Circle.create(raphael, x, z, r)
Creates new Circle object, for parameters meaning see Circle
Parameters:
raphael
x
z
r
Returns:
{Circle} new Circle object

setR(r)
Sets radius of receiver
Parameters:
{float} r
new radius

setX(x)
Sets x coordinate of receiver
Parameters:
{float} x
new x coordinate

setXZ(x, z)
Sets new coordinates of receiver
Parameters:
{float} x
new x coordinate
{float} z
new z coordinate

setZ(z)
Sets z coordinate of receiver
Parameters:
{float} z
new z coordinate

translate(dx, dz)
Translate receiver
Parameters:
{float} dx
x distance of translation
{float} dz
z distance of translation

translateX(dx)
Translate along x axis of receiver
Parameters:
{float} dx
x distance of translation

translateZ(dz)
Translate along z axis of receiver
Parameters:
{float} dz
z distance of translation

up()
Update

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Oct 23 2011 11:06:07 GMT+0200 (CEST)