pyvisi/py_src/image.py

"""
@author: John NGUI
"""

import vtk
from mapper import DataSetMapper
from actor import Actor3D
from constant import Viewport
from texture import Texture
from plane import PlaneSource
from transform import Transform, TransformFilter

# NOTE: DataSetMapper, Actor3D, Texture, PlaneSource, Transform and
# TransformFilter were inherited to  allow access to their public methods 
# from the driver.
class Image(DataSetMapper, Actor3D, Texture, PlaneSource, Transform,
        TransformFilter):
    """
    Class that displays an image which can be scaled (upwards and downwards)
    and has interaction capability. The image can also be translated and 
    rotated along the X, Y and Z axes.

    @bug: Translating an image works differently (opposite) compared to 
    translating a plane. For example, a positive translation along the 
    z-axis moves a plane up. However, if the identical translation is applied on
    an image, the image moves down.
    """

    # The SOUTH_WEST default viewport is used when there is only one viewport.
    # This saves the user from specifying the viewport when there is only one.
    def __init__(self, scene, image_reader, viewport = Viewport.SOUTH_WEST):
        """
        @type scene: L{Scene <scene.Scene>} object
        @param scene: Scene in which the image is to be displayed
        @type image_reader: L{ImageReader <imagereader.ImageReader>}
                object
        @param image_reader: Deal with source of data for vizualisation
        @type viewport: L{Viewport <constant.Viewport>} constant  
        @param viewport: Viewport in which the image is to be displayed
        """

        # ----- Image -----

        Texture.__init__(self, image_reader._getOutput())
        PlaneSource.__init__(self)

        Transform.__init__(self)
        TransformFilter.__init__(self, PlaneSource._getOutput(self),
                Transform._getTransform(self))

        DataSetMapper.__init__(self, TransformFilter._getOutput(self))

        Actor3D.__init__(self, DataSetMapper._getDataSetMapper(self))
        Actor3D._setTexture(self, Texture._getTexture(self))

        scene._addActor3D(viewport, Actor3D._getActor3D(self))

1	"""
2	@author: John NGUI
3	"""
4
5	import vtk
6	from mapper import DataSetMapper
7	from actor import Actor3D
8	from constant import Viewport
9	from texture import Texture
10	from plane import PlaneSource
11	from transform import Transform, TransformFilter
12
13	# NOTE: DataSetMapper, Actor3D, Texture, PlaneSource, Transform and
14	# TransformFilter were inherited to allow access to their public methods
15	# from the driver.
16	class Image(DataSetMapper, Actor3D, Texture, PlaneSource, Transform,
17	TransformFilter):
18	"""
19	Class that displays an image which can be scaled (upwards and downwards)
20	and has interaction capability. The image can also be translated and
21	rotated along the X, Y and Z axes.
22
23	@bug: Translating an image works differently (opposite) compared to
24	translating a plane. For example, a positive translation along the
25	z-axis moves a plane up. However, if the identical translation is applied on
26	an image, the image moves down.
27	"""
28
29	# The SOUTH_WEST default viewport is used when there is only one viewport.
30	# This saves the user from specifying the viewport when there is only one.
31	def __init__(self, scene, image_reader, viewport = Viewport.SOUTH_WEST):
32	"""
33	@type scene: L{Scene <scene.Scene>} object
34	@param scene: Scene in which the image is to be displayed
35	@type image_reader: L{ImageReader <imagereader.ImageReader>}
36	object
37	@param image_reader: Deal with source of data for vizualisation
38	@type viewport: L{Viewport <constant.Viewport>} constant
39	@param viewport: Viewport in which the image is to be displayed
40	"""
41
42	# ----- Image -----
43
44	Texture.__init__(self, image_reader._getOutput())
45	PlaneSource.__init__(self)
46
47	Transform.__init__(self)
48	TransformFilter.__init__(self, PlaneSource._getOutput(self),
49	Transform._getTransform(self))
50
51	DataSetMapper.__init__(self, TransformFilter._getOutput(self))
52
53	Actor3D.__init__(self, DataSetMapper._getDataSetMapper(self))
54	Actor3D._setTexture(self, Texture._getTexture(self))
55
56	scene._addActor3D(viewport, Actor3D._getActor3D(self))
57