pyvisi/py_src/clipper.py

"""
@author: John NGUI
"""

import vtk

class Clipper:
    """
    Class that defines a clipper.
    """
    
    def __init__(self):
        """
        Initialise the clipper.
        """
        
        self.__vtk_clipper = vtk.vtkClipDataSet()

    def _setupClipper(self, object, plane):
        """
        Setup the clipper.

        @type object: vtkUnstructuredGrid, etc
        @param object: Input for the clipper
        @type plane: vtkPlane
        @param plane: Plane to clip the object 
        """

        self.__object = object 
        # True only if a plane is used to perform clipping. False for 
        # scalar clipping.
        if(plane != None): 
            self.__plane = plane
        
        self.__setInput()
        self.setInsideOutOn()

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

        self.__vtk_clipper.SetInput(self.__object)

    def _setClipFunction(self):
        """
        Set the clip function (using a plane) for the clipper.
        """

        self.__vtk_clipper.SetClipFunction(self.__plane)

    def setInsideOutOn(self):
        """
        Clip one side of the rendered object.       
        """

        self.__vtk_clipper.InsideOutOn()

    def setInsideOutOff(self):
        """
        Clips the other side of the rendered object.        
        """

        self.__vtk_clipper.InsideOutOff()

    def setClipValue(self, value):
        """
        Set the scalar clip value (intead of using a plane) for the clipper.

        @type value: Number
        @param value: Scalar clip value
        """

        self.__vtk_clipper.SetValue(value)

    def _getClipperOutput(self):
        """
        Return the output of the clipper.

        @rtype: vtkUnstructuredGrid
        @return: Unstructured grid
        """

        return self.__vtk_clipper.GetOutput()

1	ksteube	1147	"""
2			@author: John NGUI
3			"""
4
5			import vtk
6
7			class Clipper:
8			"""
9			Class that defines a clipper.
10			"""
11
12	jongui	1148	def __init__(self):
13	ksteube	1147	"""
14			Initialise the clipper.
15	jongui	1148	"""
16
17			self.__vtk_clipper = vtk.vtkClipDataSet()
18	ksteube	1147
19	jongui	1148	def _setupClipper(self, object, plane):
20			"""
21			Setup the clipper.
22
23	ksteube	1147	@type object: vtkUnstructuredGrid, etc
24			@param object: Input for the clipper
25			@type plane: vtkPlane
26			@param plane: Plane to clip the object
27			"""
28
29			self.__object = object
30			# True only if a plane is used to perform clipping. False for
31			# scalar clipping.
32			if(plane != None):
33			self.__plane = plane
34	jongui	1148
35	ksteube	1147	self.__setInput()
36			self.setInsideOutOn()
37
38			def __setInput(self):
39			"""
40			Set the input for the clipper.
41			"""
42
43			self.__vtk_clipper.SetInput(self.__object)
44
45			def _setClipFunction(self):
46			"""
47			Set the clip function (using a plane) for the clipper.
48			"""
49
50			self.__vtk_clipper.SetClipFunction(self.__plane)
51
52			def setInsideOutOn(self):
53			"""
54			Clip one side of the rendered object.
55			"""
56
57			self.__vtk_clipper.InsideOutOn()
58
59			def setInsideOutOff(self):
60			"""
61			Clips the other side of the rendered object.
62			"""
63
64			self.__vtk_clipper.InsideOutOff()
65
66			def setClipValue(self, value):
67			"""
68			Set the scalar clip value (intead of using a plane) for the clipper.
69
70			@type value: Number
71			@param value: Scalar clip value
72			"""
73
74			self.__vtk_clipper.SetValue(value)
75
76	jongui	1148	def _getClipperOutput(self):
77	ksteube	1147	"""
78			Return the output of the clipper.
79
80			@rtype: vtkUnstructuredGrid
81			@return: Unstructured grid
82			"""
83
84			return self.__vtk_clipper.GetOutput()
85