/[escript]/trunk/pyvisi/py_src/plane.py
ViewVC logotype

Contents of /trunk/pyvisi/py_src/plane.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 637 - (show annotations)
Thu Mar 23 10:55:31 2006 UTC (14 years ago) by gross
File MIME type: text/x-python
File size: 1875 byte(s)
more copyright statements added
1 """
2 The classes associated with Planes
3
4 @var __author__: name of author
5 @var __license__: licence agreement
6 @var __copyright__: copyrights
7 @var __url__: url entry point on documentation
8 @var __version__: version
9 @var __date__: date of the version
10 """
11
12 __copyright__=""" Copyright (c) 2006 by ACcESS MNRF
13 http://www.access.edu.au
14 Primary Business: Queensland, Australia"""
15 __license__="""Licensed under the Open Software License version 3.0
16 http://www.opensource.org/licenses/osl-3.0.php"""
17 __author__="Paul Cochrane"
18 __url__="http://www.iservo.edu.au/esys"
19 __version__="$Revision$"
20 __date__="$Date$"
21
22 # generic imports
23 from common import debugMsg, overrideWarning
24 from item import Item
25
26 class Plane(Item):
27 """
28 Generic class for Plane objects
29 """
30
31 def __init__(self, scene):
32 """
33 Initialisation of the Plane object
34
35 @param scene: the scene object within which the plane is
36 @type scene: Scene object
37 """
38 Item.__init__(self)
39 debugMsg("Called Plane.__init__()")
40
41 self.renderer = scene.renderer
42
43 def mapImageToPlane(self, image):
44 """
45 Maps an Image object onto a Plane object
46
47 @param image: the image object to be mapped
48 @type image: Image object
49 """
50 debugMsg("Called Plane.mapImageToPlane()")
51
52 if image is None:
53 raise ValueError, "You must specify an image object"
54
55 # print a warning message if get to here
56 overrideWarning("Plane.mapImageToPlane")
57
58 return
59
60 def render(self):
61 """
62 Perform Plane object specific (pre)rendering tasks
63 """
64 debugMsg("Called Plane.mapImageToPlane()")
65
66 # print a warning message if get to here
67 overrideWarning("Plane.render")
68
69 return
70
71 # vim: expandtab shiftwidth=4:

  ViewVC Help
Powered by ViewVC 1.1.26