pyvisi/py_src/plane.py

"""
@author: John NGUI
"""

import vtk
from position import GlobalPosition

class Plane:
    """
    Class that defines a plane that cuts through rendered objects. 
    """

    def __init__(self, transform):
        """
        Initialise the plane.   

        @type transform: L{Transform <transform.Transform>} object
        @param transform: Specifies the orientation of the plane
        """

        self.__transform = transform
        self.__vtk_plane = vtk.vtkPlane()
        self.__setupPlane()
    
    def __setupPlane(self): 
        """
        Setup the plane.
        """

        # Default origin of the of the plane is (0,0,0).
        self.__setOrigin(GlobalPosition(0,0,0))
        # Default normal of the plane is parrallel to the z-axis.
        self.__setNormal(GlobalPosition(0, 0, 1))
        self.__setTransform()

    def __setOrigin(self, position):
        """
        Set the origin of the plane.

        @type position: L{GlobalPosition <position.GlobalPosition>} object
        @param position: Origin of the plane
        """
        self.__vtk_plane.SetOrigin(position._getGlobalPosition())

    def __setNormal(self, position):
        """
        Set the normal of the plane.

        @type position: L{GlobalPosition <position.GlobalPosition>} object
        @param position: Normal of the plane
        """

        self.__vtk_plane.SetNormal(position._getGlobalPosition())

    def __setTransform(self):
        """
        Set the transformation of the plane.
        """

        self.__vtk_plane.SetTransform(self.__transform)

    def _getPlane(self):
        """
        Return the plane.

        @rtype: vtkPlane
        @return: Plane that cuts through rendered objects
        """

        return self.__vtk_plane


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


class PlaneSource:
    """
    Class that defines a plane source.
    """

    def __init__(self):
        """
        Initialise the plane source.
        """

        self.__vtk_plane_source = vtk.vtkPlaneSource()
    
    def _getOutput(self):
        """
        Return the output of the plance source.

        @rtype: vtkPolyData
        @return: Polygonal data
        """

        return self.__vtk_plane_source.GetOutput()


1	"""
2	@author: John NGUI
3	"""
4
5	import vtk
6	from position import GlobalPosition
7
8	class Plane:
9	"""
10	Class that defines a plane that cuts through rendered objects.
11	"""
12
13	def __init__(self, transform):
14	"""
15	Initialise the plane.
16
17	@type transform: L{Transform <transform.Transform>} object
18	@param transform: Specifies the orientation of the plane
19	"""
20
21	self.__transform = transform
22	self.__vtk_plane = vtk.vtkPlane()
23	self.__setupPlane()
24
25	def __setupPlane(self):
26	"""
27	Setup the plane.
28	"""
29
30	# Default origin of the of the plane is (0,0,0).
31	self.__setOrigin(GlobalPosition(0,0,0))
32	# Default normal of the plane is parrallel to the z-axis.
33	self.__setNormal(GlobalPosition(0, 0, 1))
34	self.__setTransform()
35
36	def __setOrigin(self, position):
37	"""
38	Set the origin of the plane.
39
40	@type position: L{GlobalPosition <position.GlobalPosition>} object
41	@param position: Origin of the plane
42	"""
43	self.__vtk_plane.SetOrigin(position._getGlobalPosition())
44
45	def __setNormal(self, position):
46	"""
47	Set the normal of the plane.
48
49	@type position: L{GlobalPosition <position.GlobalPosition>} object
50	@param position: Normal of the plane
51	"""
52
53	self.__vtk_plane.SetNormal(position._getGlobalPosition())
54
55	def __setTransform(self):
56	"""
57	Set the transformation of the plane.
58	"""
59
60	self.__vtk_plane.SetTransform(self.__transform)
61
62	def _getPlane(self):
63	"""
64	Return the plane.
65
66	@rtype: vtkPlane
67	@return: Plane that cuts through rendered objects
68	"""
69
70	return self.__vtk_plane
71
72
73	###############################################################################
74
75
76	class PlaneSource:
77	"""
78	Class that defines a plane source.
79	"""
80
81	def __init__(self):
82	"""
83	Initialise the plane source.
84	"""
85
86	self.__vtk_plane_source = vtk.vtkPlaneSource()
87
88	def _getOutput(self):
89	"""
90	Return the output of the plance source.
91
92	@rtype: vtkPolyData
93	@return: Polygonal data
94	"""
95
96	return self.__vtk_plane_source.GetOutput()
97
98