pyvisi/py_src/outline.py

"""
@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"
__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"""
__url__="http://www.iservo.edu.au/esys"
__version__="$Revision$"
__date__="$Date$"


import vtk

class Outline:
    """
    Class that defines an outline.
    """

    def __init__(self, object):
        """
        Initialise the outline.

        @type object: vtkUnstructuredGrid, etc
        @param object: Data source to the outline
        """
        
        self.__object = object
        self.__vtk_outline = vtk.vtkOutlineFilter()
        self.__setInput()

    def __setInput(self):
        """
        Set the input for the outline.
        """

        self.__vtk_outline.SetInput(self.__object)
    
    def _getOutlineOutput(self):
        """
        Return the output of the outline.

        @rtype: vtkPolyData
        @return: Polyognal data
        """

        return self.__vtk_outline.GetOutput()
    
1	ksteube	1147	"""
2	jongui	1197	@var __author__: name of author
3			@var __copyright__: copyrights
4			@var __license__: licence agreement
5			@var __url__: url entry point on documentation
6			@var __version__: version
7			@var __date__: date of the version
8	ksteube	1147	"""
9
10	jongui	1197	__author__="John Ngui, john.ngui@uq.edu.au"
11			__copyright__=""" Copyright (c) 2006 by ACcESS MNRF
12			http://www.access.edu.au
13			Primary Business: Queensland, Australia"""
14			__license__="""Licensed under the Open Software License version 3.0
15			http://www.opensource.org/licenses/osl-3.0.php"""
16			__url__="http://www.iservo.edu.au/esys"
17			__version__="$Revision$"
18			__date__="$Date$"
19
20
21	ksteube	1147	import vtk
22
23			class Outline:
24			"""
25			Class that defines an outline.
26			"""
27
28			def __init__(self, object):
29			"""
30			Initialise the outline.
31
32			@type object: vtkUnstructuredGrid, etc
33			@param object: Data source to the outline
34			"""
35
36			self.__object = object
37			self.__vtk_outline = vtk.vtkOutlineFilter()
38			self.__setInput()
39
40			def __setInput(self):
41			"""
42			Set the input for the outline.
43			"""
44
45			self.__vtk_outline.SetInput(self.__object)
46
47	jongui	1148	def _getOutlineOutput(self):
48	ksteube	1147	"""
49			Return the output of the outline.
50
51			@rtype: vtkPolyData
52			@return: Polyognal data
53			"""
54
55			return self.__vtk_outline.GetOutput()
56