Trees       Indices       Help   
ESyS-Particle 2.1
Package esys :: Package lsm :: Package vis :: Package core :: Module Arrow :: Class Arrow
[hide private]
[frames] | no frames]

Class Arrow

object --+
         |
        Arrow

Objects of this class represent arrows with conical head and cylindrical tail.

Instance Methods [hide private]
 
__init__(self, tailPt, headPt, tailRadius, headRadius, headLength)
Initialises arrow.
 
getTailPt(self)
Returns the coordinate of the tail of this arrow.
 
getHeadPt(self)
Returns the coordinate of the pointy head of this arrow.
 
getHeadRadius(self)
Returns the max radius of the head of this arrow.
 
getTailRadius(self)
Returns the radius of the cylindrical tail of this arrow.
 
getHeadLength(self)
Returns the height of the cone which forms the head of this arrow.
float
getLength(self)
Returns the distance between this arrows head-point and tail-point.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, tailPt, headPt, tailRadius, headRadius, headLength)
(Constructor)

 

Initialises arrow.

Overrides: object.__init__

getTailPt(self)

 

Returns the coordinate of the tail of this arrow.

Returns:
Tail coordinate of this arrow.

getHeadPt(self)

 

Returns the coordinate of the pointy head of this arrow.

Returns:
Head coordinate of this arrow.

getHeadRadius(self)

 

Returns the max radius of the head of this arrow.

Returns:
Radius of base of this arrow's conical head.

getTailRadius(self)

 

Returns the radius of the cylindrical tail of this arrow.

Returns:
Radius of this arrow's cylindrical tail.

getHeadLength(self)

 

Returns the height of the cone which forms the head of this arrow.

Returns:
Height of cone which forms the head of this arrow.

getLength(self)

 

Returns the distance between this arrows head-point and tail-point.

Returns: float
length of this arrow from head-point to tail-point.

   Trees       Indices       Help   
ESyS-Particle 2.1
Generated by Epydoc 3.0.1 on Tue May 8 19:45:57 2012 http://epydoc.sourceforge.net