pyvisi/py_src/geo.py

"""
Class that defines the positioning of components in the visualization.
"""

class Position:
    """
    @author: John Ngui
    @author: Lutz Gross
    """

    def __init__(self, x_coor, y_coor, z_coor):
        """
        Initialize the x,y and z coordinates.   

        @type x_coor: Number
        @param x_coor: X coordinate in global position
        @type y_coor: Number
        @param y_coor: Y coordinate in global position
        @type z_coor: Number 
        @param z_coor: Z coordinate in global position
        """
        
        self.x_coor = x_coor 
        self.y_coor = y_coor 
        self.z_coor = z_coor

    def getXCoor(self):
        """ 
        Return the x coordinate.

        @rtype: Number
        @return: X coordinate
        """
        return self.x_coor

    def getYCoor(self):
        """
        Return the y coordinate.

        @rtype: Number
        @return: Y coordiante
        """

        return self.y_coor

    def getZCoor(self):
        """
        Return the z coordinate

        @rtype: Number
        @return: Z coordinate
        """

        return self.z_coor


#def Position(object):
"""
A position in global coordinates
"""
pass

def Origin(Position):
    """
    The position of the origin
    """
    pass

def Direction(object):
    """
    A dirction in global coordinates
    """
    pass

def XAxis(Direction):
    """
    The direction of the x-axis
    """
    pass

def YAxis(Direction):
    """
    The direction of the y-axis
    """
    pass

def ZAxis(Direction):
    """
    The direction of the z-axis
    """
    pass

def Plane(object):
    """
    A plane in global coordinates
    """
    pass

def XYPlane(Plane):
    """
    The XY plane orthogonal to the z-axis
    """
    pass

def YZPlane(Plane):
    """
    The YZ plane orthogonal to the x-axis
    """
    pass

def ZXPlane(Plane):
    """
    The ZX plane orthogonal to the y-axis
    """
    pass

def Sphere(object):
    """
    A sphere
    """
    pass

1	"""
2	Class that defines the positioning of components in the visualization.
3	"""
4
5	class Position:
6	"""
7	@author: John Ngui
8	@author: Lutz Gross
9	"""
10
11	def __init__(self, x_coor, y_coor, z_coor):
12	"""
13	Initialize the x,y and z coordinates.
14
15	@type x_coor: Number
16	@param x_coor: X coordinate in global position
17	@type y_coor: Number
18	@param y_coor: Y coordinate in global position
19	@type z_coor: Number
20	@param z_coor: Z coordinate in global position
21	"""
22
23	self.x_coor = x_coor
24	self.y_coor = y_coor
25	self.z_coor = z_coor
26
27	def getXCoor(self):
28	"""
29	Return the x coordinate.
30
31	@rtype: Number
32	@return: X coordinate
33	"""
34	return self.x_coor
35
36	def getYCoor(self):
37	"""
38	Return the y coordinate.
39
40	@rtype: Number
41	@return: Y coordiante
42	"""
43
44	return self.y_coor
45
46	def getZCoor(self):
47	"""
48	Return the z coordinate
49
50	@rtype: Number
51	@return: Z coordinate
52	"""
53
54	return self.z_coor
55
56
57
58	#def Position(object):
59	"""
60	A position in global coordinates
61	"""
62	pass
63
64	def Origin(Position):
65	"""
66	The position of the origin
67	"""
68	pass
69
70	def Direction(object):
71	"""
72	A dirction in global coordinates
73	"""
74	pass
75
76	def XAxis(Direction):
77	"""
78	The direction of the x-axis
79	"""
80	pass
81
82	def YAxis(Direction):
83	"""
84	The direction of the y-axis
85	"""
86	pass
87
88	def ZAxis(Direction):
89	"""
90	The direction of the z-axis
91	"""
92	pass
93
94	def Plane(object):
95	"""
96	A plane in global coordinates
97	"""
98	pass
99
100	def XYPlane(Plane):
101	"""
102	The XY plane orthogonal to the z-axis
103	"""
104	pass
105
106	def YZPlane(Plane):
107	"""
108	The YZ plane orthogonal to the x-axis
109	"""
110	pass
111
112	def ZXPlane(Plane):
113	"""
114	The ZX plane orthogonal to the y-axis
115	"""
116	pass
117
118	def Sphere(object):
119	"""
120	A sphere
121	"""
122	pass
123