Shape Class Reference

Inheritance diagram for Shape:

Inheritance graph

Public Member Functions

def __init__(self, reference=None)
def addHandler(self, handler)[Inherited from _EventTrigger]
def adjustReference(self, dx, dy)[Inherited from Drawable]
def clone(self)[Inherited from Drawable]
def flip(self, angle=0)[Inherited from Drawable]
def getBorderColor(self)
def getBorderWidth(self)
def getDepth(self)[Inherited from Drawable]
def getReferencePoint(self)[Inherited from Drawable]
def move(self, dx, dy)[Inherited from Drawable]
def moveTo(self, x, y)[Inherited from Drawable]
def removeHandler(self, handler)[Inherited from _EventTrigger]
def rotate(self, angle)[Inherited from Drawable]
def scale(self, factor)[Inherited from Drawable]
def setBorderColor(self, color)
def setBorderWidth(self, width)
def setDepth(self, depth)[Inherited from Drawable]
def shear(self, shear, angle=0)[Inherited from Drawable]
def stretch(self, xFactor, yFactor, angle=0)[Inherited from Drawable]
def wait(self)[Inherited from _EventTrigger]

Detailed Description

A drawable objects that has a border.

Member Function Documentation

def __init__ (   self,
  reference = None 

Construct a Shape instance.

reference  the initial placement of the shape's reference point.
       (default Point(0,0) )

Reimplemented from Drawable.

Reimplemented in FillableShape, Path, and Polygon.

def addHandler (   self,
) [inherited]

Register an EventHandler instance with this object.

def adjustReference (   self,
) [inherited]

Move the local reference point relative to its current position.

Note that the object is not moved at all.

def clone (   self  )  [inherited]

Return a duplicate of the drawable object.

Note that the duplicate is not automatically added to any
canvases or layers, even if original is currently so.

def flip (   self,
  angle = 0 
) [inherited]

Flip the object reflected about its current reference point.

By default the flip is a left-to-right flip with a vertical axis of symmetry.

angle     a clockwise rotation of the axis of symmetry away from vertical

def getBorderColor (   self  ) 

Return the color of the object's border.

def getBorderWidth (   self  ) 

Return the width of the border.

def getDepth (   self  )  [inherited]

Return the depth of the object.

def getReferencePoint (   self  )  [inherited]

Return a copy of the current reference point.

Note that mutating that copy has no effect on the Drawable object.

def move (   self,
) [inherited]

Move the object dx units along X-axis and dy units along Y-axis.

For the default coordinate system, positive dx is rightward and
negative is leftward; positive dy is downard and negative is upward.

def moveTo (   self,
) [inherited]

Move the object to align its reference point with (x,y)

def removeHandler (   self,
) [inherited]

Unregister an EventHandler instance from this object.

def rotate (   self,
) [inherited]

Rotate the object around its current reference point.

angle  number of degrees of clockwise rotation

Reimplemented in Text.

def scale (   self,
) [inherited]

Scale the object relative to its current reference point.

factor      scale is multiplied by this number (must be positive)

Reimplemented in Text.

def setBorderColor (   self,

Set the border color to a copy of the indicated color.

The parameter can be either:
   - a string with the name of the color
   - an (r,g,b) tuple
   - an existing Color instance

def setBorderWidth (   self,

Set the width of the border to the indicated width.

Reimplemented in Button.

def setDepth (   self,
) [inherited]

Set the depth of the object.

Objects with a higher depth will be rendered behind those with lower depths.

def shear (   self,
  angle = 0 
) [inherited]

Shear the object relative to its current reference point.

By default, points with the same y-coordinate as the reference point are left
unchanged.  A point d units above the reference point is shifted d * shear
units to the right.  The optional angle parameter rotates the axis
that the shearing occurs along.

angle      clockwise angle for shear

def stretch (   self,
  angle = 0 
) [inherited]

Stretch the shape in mutltiple direction.

By default the x-axis is scaled by a factor of xFactor and the
y-axis is scaled by a factor of yFactor.  The optional
parameter rotates the directions that the streching is performed

def wait (   self  )  [inherited]

Wait for an event to occur.

When an event occurs, an Event instance is returned
with information about what has happened.

The documentation for this class was generated from the following file:
Generated on Fri Dec 21 18:19:34 2007 by  doxygen 1.5.3