pyvisi/py_src/actor.py


########################################################
#
# Copyright (c) 2003-2009 by University of Queensland
# Earth Systems Science Computational Center (ESSCC)
# http://www.uq.edu.au/esscc
#
# Primary Business: Queensland, Australia
# Licensed under the Open Software License version 3.0
# http://www.opensource.org/licenses/osl-3.0.php
#
########################################################

__copyright__="""Copyright (c) 2003-2009 by University of Queensland
Earth Systems Science Computational Center (ESSCC)
http://www.uq.edu.au/esscc
Primary Business: Queensland, Australia"""
__license__="""Licensed under the Open Software License version 3.0
http://www.opensource.org/licenses/osl-3.0.php"""
__url__="https://launchpad.net/escript-finley"

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

__author__="John Ngui, john.ngui@uq.edu.au"


from esys.escript import getMPISizeWorld
if getMPISizeWorld()==1: import vtk

class Actor3D:
    """
    Class that defines a 3D actor.
    """
    
    def __init__(self):
        """
        Initialise the 3D actor.
        """
                if getMPISizeWorld()>1:
                     raise ValueError,"pyvisi.Actor3D is not running on more than one processor."
        self.__vtk_actor3D = vtk.vtkActor()

    def _setupActor3D(self, mapper):
        """
        Setup the 3D actor.

        @type mapper: vtkDataSetMapper
        @param mapper: Mapped data
        """

        self.__mapper = mapper
        self.__setMapper()
        
    def __setMapper(self):
        """
        Set the mapper of the 3D actor.
        """

        self.__vtk_actor3D.SetMapper(self.__mapper)

    def _setTexture(self, texture):
        """
        Set the texture of the 3D actor.    

        @type texture: vtkTexture
        @param texture: Texture of the rendered object 
        """

        self.__vtk_actor3D.SetTexture(texture)

    def setOpacity(self, opacity):
        """
        Set the opacity (transparency) of the 3D actor.

        @type opacity: Number (between 0 and 1)
        @param opacity: Opacity (transparency) of the 3D actor
        """
    
        self.__vtk_actor3D.GetProperty().SetOpacity(opacity)

    def setColor(self, color):
        """
        Set the color of the 3D actor.

        @type color: L{Color <constant.Color>} constant
        @param color: Color of the 3D actor 
        """

        # NOTE: Must be used before actor.GetProperty().SetColor()
        # in order for the change of color to take effect.
        self.__mapper.ScalarVisibilityOff()
        self.__vtk_actor3D.GetProperty().SetColor(color) 

    def setRepresentationToWireframe(self):
        """
        Set the representation of the 3D actor to wireframe.
        """

        self.__vtk_actor3D.GetProperty().SetRepresentationToWireframe()
    
    def _setLineWidth(self, line_width):
        """
        Set the line width of the 3D actor.

        @type line_width: Number
        @param line_width: 3D actor line width
        """

        self.__vtk_actor3D.GetProperty().SetLineWidth(line_width)       
    
    def _getActor3D(self):
        """
        Return the 3D actor.

        @rtype: vtkActor
        @return: 3D actor
        """

        return self.__vtk_actor3D


###############################################################################


class Actor2D:
    """
    Class that defines a 2D actor.
    """

    def __init__(self):
        """
        Initialise the 2D actor.
        """
                if getMPISizeWorld()>1:
                     raise ValueError,"pyvisi.Actor2D is not running on more than one processor."
        self._vtk_actor2D = vtk.vtkActor2D()

    def _setupActor2D(self, mapper):
        """
        Setup the 2D actor.

        @type mapper: vtkMapper2D
        @param mapper: Mapped data
        """

        self.__mapper = mapper
        self.__setMapper()

    def __setMapper(self):
        """
        Set the mapper for the 2D actor.    
        """

        self._vtk_actor2D.SetMapper(self.__mapper)

    def setPosition(self, position):
        """
        Set the position (XY) of the 2D actor. Default position is the lower 
        left hand corner of the window / viewport.

        @type position: L{LocalPosition <position.LocalPosition>} object
        @param position: Position of the 2D actor 
        """

        self._vtk_actor2D.SetPosition(position._getLocalPosition())

    def _getActor2D(self):
        """
        Return the 2D actor.    

        @rtype: vtkActor2D
        @return 2D actor
        """

        return self._vtk_actor2D

1	ksteube	1809
2			########################################################
3			#
4	jfenwick	2548	# Copyright (c) 2003-2009 by University of Queensland
5	ksteube	1809	# Earth Systems Science Computational Center (ESSCC)
6			# http://www.uq.edu.au/esscc
7			#
8			# Primary Business: Queensland, Australia
9			# Licensed under the Open Software License version 3.0
10			# http://www.opensource.org/licenses/osl-3.0.php
11			#
12			########################################################
13
14	jfenwick	2549	__copyright__="""Copyright (c) 2003-2009 by University of Queensland
15	ksteube	1809	Earth Systems Science Computational Center (ESSCC)
16			http://www.uq.edu.au/esscc
17			Primary Business: Queensland, Australia"""
18			__license__="""Licensed under the Open Software License version 3.0
19			http://www.opensource.org/licenses/osl-3.0.php"""
20	jfenwick	2344	__url__="https://launchpad.net/escript-finley"
21	ksteube	1809
22	ksteube	1147	"""
23	jongui	1197	@var __author__: name of author
24			@var __copyright__: copyrights
25			@var __license__: licence agreement
26			@var __url__: url entry point on documentation
27			@var __version__: version
28			@var __date__: date of the version
29	ksteube	1147	"""
30
31	jongui	1197	__author__="John Ngui, john.ngui@uq.edu.au"
32
33
34	gross	2313	from esys.escript import getMPISizeWorld
35	gross	2365	if getMPISizeWorld()==1: import vtk
36	ksteube	1147
37			class Actor3D:
38			"""
39			Class that defines a 3D actor.
40			"""
41
42	jongui	1148	def __init__(self):
43	ksteube	1147	"""
44			Initialise the 3D actor.
45	jongui	1148	"""
46	gross	2313	if getMPISizeWorld()>1:
47			raise ValueError,"pyvisi.Actor3D is not running on more than one processor."
48	jongui	1148	self.__vtk_actor3D = vtk.vtkActor()
49
50			def _setupActor3D(self, mapper):
51			"""
52			Setup the 3D actor.
53
54	ksteube	1147	@type mapper: vtkDataSetMapper
55			@param mapper: Mapped data
56			"""
57
58			self.__mapper = mapper
59			self.__setMapper()
60	jongui	1148
61	ksteube	1147	def __setMapper(self):
62			"""
63			Set the mapper of the 3D actor.
64			"""
65
66			self.__vtk_actor3D.SetMapper(self.__mapper)
67
68			def _setTexture(self, texture):
69			"""
70			Set the texture of the 3D actor.
71
72			@type texture: vtkTexture
73			@param texture: Texture of the rendered object
74			"""
75
76			self.__vtk_actor3D.SetTexture(texture)
77
78			def setOpacity(self, opacity):
79			"""
80			Set the opacity (transparency) of the 3D actor.
81
82			@type opacity: Number (between 0 and 1)
83			@param opacity: Opacity (transparency) of the 3D actor
84			"""
85
86			self.__vtk_actor3D.GetProperty().SetOpacity(opacity)
87
88			def setColor(self, color):
89			"""
90			Set the color of the 3D actor.
91
92			@type color: L{Color <constant.Color>} constant
93			@param color: Color of the 3D actor
94			"""
95
96			# NOTE: Must be used before actor.GetProperty().SetColor()
97			# in order for the change of color to take effect.
98			self.__mapper.ScalarVisibilityOff()
99			self.__vtk_actor3D.GetProperty().SetColor(color)
100
101			def setRepresentationToWireframe(self):
102			"""
103	jongui	1199	Set the representation of the 3D actor to wireframe.
104	ksteube	1147	"""
105
106			self.__vtk_actor3D.GetProperty().SetRepresentationToWireframe()
107
108			def _setLineWidth(self, line_width):
109			"""
110			Set the line width of the 3D actor.
111
112			@type line_width: Number
113			@param line_width: 3D actor line width
114			"""
115
116			self.__vtk_actor3D.GetProperty().SetLineWidth(line_width)
117
118			def _getActor3D(self):
119			"""
120			Return the 3D actor.
121
122			@rtype: vtkActor
123			@return: 3D actor
124			"""
125
126			return self.__vtk_actor3D
127
128
129			###############################################################################
130
131
132			class Actor2D:
133			"""
134			Class that defines a 2D actor.
135			"""
136
137	jongui	1148	def __init__(self):
138	ksteube	1147	"""
139			Initialise the 2D actor.
140	jongui	1148	"""
141	gross	2313	if getMPISizeWorld()>1:
142			raise ValueError,"pyvisi.Actor2D is not running on more than one processor."
143	jongui	1148	self._vtk_actor2D = vtk.vtkActor2D()
144
145			def _setupActor2D(self, mapper):
146			"""
147			Setup the 2D actor.
148
149	ksteube	1147	@type mapper: vtkMapper2D
150			@param mapper: Mapped data
151			"""
152
153			self.__mapper = mapper
154			self.__setMapper()
155
156			def __setMapper(self):
157			"""
158			Set the mapper for the 2D actor.
159			"""
160
161			self._vtk_actor2D.SetMapper(self.__mapper)
162
163			def setPosition(self, position):
164			"""
165			Set the position (XY) of the 2D actor. Default position is the lower
166			left hand corner of the window / viewport.
167
168			@type position: L{LocalPosition <position.LocalPosition>} object
169			@param position: Position of the 2D actor
170			"""
171
172			self._vtk_actor2D.SetPosition(position._getLocalPosition())
173
174			def _getActor2D(self):
175			"""
176			Return the 2D actor.
177
178			@rtype: vtkActor2D
179			@return 2D actor
180			"""
181
182			return self._vtk_actor2D
183