pyvisi/py_src/plane.py

"""
The classes associated with Planes

@var __author__: name of author
@var __license__: licence agreement
@var __copyright__: copyrights
@var __url__: url entry point on documentation
@var __version__: version
@var __date__: date of the version
"""

__copyright__="""  Copyright (c) 2006 by ACcESS MNRF
                    http://www.access.edu.au
                Primary Business: Queensland, Australia"""
__license__="""Licensed under the Open Software License version 3.0
             http://www.opensource.org/licenses/osl-3.0.php"""
__author__="Paul Cochrane"
__url__="http://www.iservo.edu.au/esys"
__version__="$Revision$"
__date__="$Date$"

# generic imports
from common import debugMsg, overrideWarning
from item import Item

class Plane(Item):
    """
    Generic class for Plane objects
    """

    def __init__(self, scene):
        """
        Initialisation of the Plane object

        @param scene: the scene object within which the plane is
        @type scene: Scene object
        """
        Item.__init__(self)
        debugMsg("Called Plane.__init__()")

        self.renderer = scene.renderer

    def mapImageToPlane(self, image):
        """
        Maps an Image object onto a Plane object

        @param image: the image object to be mapped
        @type image: Image object
        """
        debugMsg("Called Plane.mapImageToPlane()")

        if image is None:
            raise ValueError, "You must specify an image object"

        # print a warning message if get to here
        overrideWarning("Plane.mapImageToPlane")

        return

    def render(self):
        """
        Perform Plane object specific (pre)rendering tasks
        """
        debugMsg("Called Plane.mapImageToPlane()")

        # print a warning message if get to here
        overrideWarning("Plane.render")

        return
    
# vim: expandtab shiftwidth=4:
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: