Class Index | File Index

Classes


Class FixedSupport

represents fixed support
Defined in: raphaelsm.src.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
FixedSupport(raphael, params)
Fixed support
Field Summary
Field Attributes Field Name and Description
 
angle of the object
 
cos
cos of this.angle
 
number of flags
 
obj
actual raphael object
 
svg array (list) of the object
 
raphael instance connected to the object
 
ratio between length of support and 'flag'
 
if flags are reversed or not
 
sin
sin of this.angle
 
size of the object
 
x
x coordinate of the object
 
z
z coordinate of the object
Method Summary
Method Attributes Method Name and Description
 
constructorFixedSupport(raphael, params)
Constructor, see FixedSupport for parameters description
<static>  
FixedSupport.create(raphael, params)
Creates new FixedSupport object, for parameters meaning see PinSupport
 
Returns copy of receiver
 
rotate(phi)
Rotate receiver by given angle (this.angle += phi)
 
setAngle(phi)
Set angle of receiver (this.angle = phi)
 
Sets svg path of receiver
 
setX(x)
Sets new x position of receiver (this.x = x)
 
setXZ(x, z)
Sets new x and z position of receiver (this.x = x; this.z = z)
 
setZ(z)
Sets new z position of receiver (this.z = z)
 
translate(dx, dz)
Translate receiver in x and z direction (this.x += dx; this.z += dz)
 
Translate receiver in x direction (this.x += x)
 
Translate receiver in x direction (this.z += dz)
 
up()
Update receiver (set this.pathList for given internal variables - x,z,angle.
Class Detail
FixedSupport(raphael, params)
Fixed support
Parameters:
{Raphael} raphael
raphael instance
{Object} params
parameters, see below
{float} params.x Optional, Default: 0.
x coordinate of the support center [pixel]
{float} params.z Optional, Default: 0.
z coordinate of the support center [pixel]
{float} params.size Optional, Default: 30.
size (height) of the support [pixel]
{float} params.angle Optional, Default: 0.
the support will be rotated by angle [deg]
{float} params.ratio Optional, Default: 2.
height/width (width of the 'flags')
{int} params.nFlags Optional, Default: 5
number of 'flags'
{bool|int} params.reversed Optional, Default: false
reversed direction of 'flags'
Field Detail
angle
angle of the object

cos
cos of this.angle

{int} nFlags
number of flags

obj
actual raphael object

pathList
svg array (list) of the object

raphael
raphael instance connected to the object

{float} ratio
ratio between length of support and 'flag'

{bool} reversed
if flags are reversed or not

sin
sin of this.angle

size
size of the object

x
x coordinate of the object

z
z coordinate of the object
Method Detail
constructorFixedSupport(raphael, params)
Constructor, see FixedSupport for parameters description
Parameters:
raphael
params

<static> {FixedSupport} FixedSupport.create(raphael, params)
Creates new FixedSupport object, for parameters meaning see PinSupport
Parameters:
raphael
params
Returns:
{FixedSupport} new FixedSupport object

{FixedSupport} makeCopy()
Returns copy of receiver
Returns:
{FixedSupport} copy of receiver

rotate(phi)
Rotate receiver by given angle (this.angle += phi)
Parameters:
{float} phi
angle of rotation

setAngle(phi)
Set angle of receiver (this.angle = phi)
Parameters:
{float} phi
angle of rotation

setPathList()
Sets svg path of receiver

setX(x)
Sets new x position of receiver (this.x = x)
Parameters:
{float} x
new x coordinate [pixel]

setXZ(x, z)
Sets new x and z position of receiver (this.x = x; this.z = z)
Parameters:
{float} x
new x coordinate [pixel]
{float} z
new z coordinate [pixel]

setZ(z)
Sets new z position of receiver (this.z = z)
Parameters:
{float} z
new z coordinate [pixel]

translate(dx, dz)
Translate receiver in x and z direction (this.x += dx; this.z += dz)
Parameters:
{float} dx
distance to be translated in x direction [pixel]
{float} dz
distance to be translated in z direction [pixel]

translateX(dx)
Translate receiver in x direction (this.x += x)
Parameters:
{float} dx
distance to be translated [pixel]

translateZ(dz)
Translate receiver in x direction (this.z += dz)
Parameters:
{float} dz
distance to be translated [pixel]

up()
Update receiver (set this.pathList for given internal variables - x,z,angle... - as well as its copies)

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