/[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 600 - (show annotations)
Fri Mar 17 05:53:59 2006 UTC (14 years, 8 months ago) by gross
File MIME type: text/x-python
File size: 2148 byte(s)
some renaming
1 # Copyright (C) 2004-2005 Paul Cochrane
2 #
3 # This program is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU General Public License
5 # as published by the Free Software Foundation; either version 2
6 # of the License, or (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
16
17 # $Id: plane.py,v 1.10 2005/03/07 07:45:48 paultcochrane Exp $
18
19 ## @file plane.py
20
21 """
22 The classes associated with Planes
23 """
24
25 # generic imports
26 from pyvisi.common import debugMsg, overrideWarning
27
28 from pyvisi.item import Item
29
30 __revision__ = '$Revision: 1.10 $'
31
32 class Plane(Item):
33 """
34 Generic class for Plane objects
35 """
36
37 def __init__(self, scene):
38 """
39 Initialisation of the Plane object
40
41 @param scene: the scene object within which the plane is
42 @type scene: Scene object
43 """
44 Item.__init__(self)
45 debugMsg("Called Plane.__init__()")
46
47 self.renderer = scene.renderer
48
49 def mapImageToPlane(self, image):
50 """
51 Maps an Image object onto a Plane object
52
53 @param image: the image object to be mapped
54 @type image: Image object
55 """
56 debugMsg("Called Plane.mapImageToPlane()")
57
58 if image is None:
59 raise ValueError, "You must specify an image object"
60
61 # print a warning message if get to here
62 overrideWarning("Plane.mapImageToPlane")
63
64 return
65
66 def render(self):
67 """
68 Perform Plane object specific (pre)rendering tasks
69 """
70 debugMsg("Called Plane.mapImageToPlane()")
71
72 # print a warning message if get to here
73 overrideWarning("Plane.render")
74
75 return
76
77 # vim: expandtab shiftwidth=4:

  ViewVC Help
Powered by ViewVC 1.1.26