Class Index | File Index

Classes


Class Ellipse

represents ellipse
Defined in: raphaeltools.src.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Ellipse(raphael, cx, cz, a, b, angle, nSeg)
Ellipse
Field Summary
Field Attributes Field Name and Description
 
a
x semiaxis
 
rotation
 
b
z semiaxis
 
cx
x coordinate of circle center
 
cz
z coordinate of circle center
 
number of segments
 
raphael instance
Method Summary
Method Attributes Method Name and Description
<static>  
Ellipse.create(raphael, cx, cz, a, b, angle, nSeg)
Creates new Ellipse object, for parameters meaning see Ellipse
 
setA(r)
Sets a (x semiaxis) of receiver
 
setAB(a, b)
Sets a (x semiaxis) and b (z semiaxis) of receiver
 
setAll(cx, cz, a, b, angle)
Sets new coordinates of receiver and new semiaxes
 
Sets rotation of receiver
 
setB(r)
Sets b (z semiaxis) of receiver
 
Sets svg path of receiver
 
setX(cx)
Sets x coordinate of center of receiver
 
setXZ(cx, cz)
Sets new coordinates of receiver
 
setZ(cz)
Sets z coordinate of center of receiver
 
translate(dx, dz)
Translate receiver
 
Translate along x axis of receiver
 
Translate along z axis of receiver
 
up()
Update
Class Detail
Ellipse(raphael, cx, cz, a, b, angle, nSeg)
Ellipse
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} a Optional, Default: 10.
x semiaxis
{float} b Optional, Default: 10.
z semiaxis
{float} angle Optional, Default: 0.
rotation
{int} nSeg Optional, Default: 0.
number of segments
Field Detail
{float} a
x semiaxis

{float} angle
rotation

{float} b
z semiaxis

{float} cx
x coordinate of circle center

{float} cz
z coordinate of circle center

{int} nSeg
number of segments

{Raphael} raphael
raphael instance
Method Detail
<static> {Circle} Ellipse.create(raphael, cx, cz, a, b, angle, nSeg)
Creates new Ellipse object, for parameters meaning see Ellipse
Parameters:
raphael
cx
cz
a
b
angle
nSeg
Returns:
{Circle} new Ellipse object

setA(r)
Sets a (x semiaxis) of receiver
Parameters:
{float} r
new radius

setAB(a, b)
Sets a (x semiaxis) and b (z semiaxis) of receiver
Parameters:
{float} a
new a (x semiaxis)
{float} b
new b (x semiaxis)

setAll(cx, cz, a, b, angle)
Sets new coordinates of receiver and new semiaxes
Parameters:
{float} cx
new x coordinate
{float} cz
new z coordinate
{float} a
new a (x semiaxis)
{float} b
new b (x semiaxis)
{float} angle
new angle

setAngle(cz)
Sets rotation of receiver
Parameters:
{float} cz
new z coordinate

setB(r)
Sets b (z semiaxis) of receiver
Parameters:
{float} r
new radius

setPathList()
Sets svg path of receiver

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

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

setZ(cz)
Sets z coordinate of center of receiver
Parameters:
{float} cz
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)