pyvisi/py_src/text.py

"""
@author: John NGUI
"""

import vtk
from actor import Actor2D
from constant import Viewport, Color

# NOTE: Actor2D was inherited to allow access to its public methods from 
# the driver.
class Text2D(Actor2D):
    """
    Class that defines a 2D text actor. A two-dimensional text is used to
    annotate the rendered object (i.e. inserting titles, authors and labels).
    """

    def __init__(self, scene, text, viewport = Viewport.SOUTH_WEST):
        """
        Initialise the 2D text actor.

        @type scene: L{Scene <scene.Scene>} object
        @param scene: Scene in which objects are to be rendered on
        @type text: String
        @param text: 2D text to be displayed
        @type viewport: L{Viewport <constant.Viewport>} constant
        @param viewport: Viewport in which objects are to be rendered on
        """

        self.__text = text
        self.__viewport = viewport
        self._vtk_actor2D = vtk.vtkTextActor()

        self.__setupText2D(scene)
    
    def __setupText2D(self, scene):
        """
        Setup the 2D text.

        @type scene: L{Scene <scene.Scene>} object
        @param scene: Scene in which objects are to be rendered on
        """

        self.__setInput()
        # Add the 2D text to the appropriate renderer.
        scene._addActor2D(self.__viewport, self._vtk_actor2D)

    def __setInput(self):
        """
        Set the input for the 2D text.
        """

        self._vtk_actor2D.SetInput(self.__text)

    def setFontSize(self, size):
        """
        Set the 2D text size.

        @type size: Number
        @param size: Size of the 2D text
        """

        self._vtk_actor2D.GetTextProperty().SetFontSize(size)

    def setFontToTimes(self):
        """
        Set the 2D text font type to Times New Roman.
        """

        self._vtk_actor2D.GetTextProperty().SetFontFamilyToTimes()

    def setFontToArial(self):
        """
        Set the 2D text font type to Arial.
        """

        self._vtk_actor2D.GetTextProperty().SetFontFamilyToArial()

    def setFontToCourier(self):
        """
        Set the 2D text front type to Courier.
        """

        self._vtk_actor2D.GetTextProperty().SetFontFamilyToCourier()

    def boldOn(self):
        """
        Bold the 2D text.
        """

        self._vtk_actor2D.GetTextProperty().BoldOn()

    def shadowOn(self):
        """
        Apply shadow onto the 2D text to ease visibility.
        """

        self._vtk_actor2D.GetTextProperty().ShadowOn()

    def setColor(self, color):
        """
        Set the color of the 2D text.

        @type color: L{Color <constant.Color>} constant
        @param color: 2D text color
        """

        self._vtk_actor2D.GetTextProperty().SetColor(color)

1	"""
2	@author: John NGUI
3	"""
4
5	import vtk
6	from actor import Actor2D
7	from constant import Viewport, Color
8
9	# NOTE: Actor2D was inherited to allow access to its public methods from
10	# the driver.
11	class Text2D(Actor2D):
12	"""
13	Class that defines a 2D text actor. A two-dimensional text is used to
14	annotate the rendered object (i.e. inserting titles, authors and labels).
15	"""
16
17	def __init__(self, scene, text, viewport = Viewport.SOUTH_WEST):
18	"""
19	Initialise the 2D text actor.
20
21	@type scene: L{Scene <scene.Scene>} object
22	@param scene: Scene in which objects are to be rendered on
23	@type text: String
24	@param text: 2D text to be displayed
25	@type viewport: L{Viewport <constant.Viewport>} constant
26	@param viewport: Viewport in which objects are to be rendered on
27	"""
28
29	self.__text = text
30	self.__viewport = viewport
31	self._vtk_actor2D = vtk.vtkTextActor()
32
33	self.__setupText2D(scene)
34
35	def __setupText2D(self, scene):
36	"""
37	Setup the 2D text.
38
39	@type scene: L{Scene <scene.Scene>} object
40	@param scene: Scene in which objects are to be rendered on
41	"""
42
43	self.__setInput()
44	# Add the 2D text to the appropriate renderer.
45	scene._addActor2D(self.__viewport, self._vtk_actor2D)
46
47	def __setInput(self):
48	"""
49	Set the input for the 2D text.
50	"""
51
52	self._vtk_actor2D.SetInput(self.__text)
53
54	def setFontSize(self, size):
55	"""
56	Set the 2D text size.
57
58	@type size: Number
59	@param size: Size of the 2D text
60	"""
61
62	self._vtk_actor2D.GetTextProperty().SetFontSize(size)
63
64	def setFontToTimes(self):
65	"""
66	Set the 2D text font type to Times New Roman.
67	"""
68
69	self._vtk_actor2D.GetTextProperty().SetFontFamilyToTimes()
70
71	def setFontToArial(self):
72	"""
73	Set the 2D text font type to Arial.
74	"""
75
76	self._vtk_actor2D.GetTextProperty().SetFontFamilyToArial()
77
78	def setFontToCourier(self):
79	"""
80	Set the 2D text front type to Courier.
81	"""
82
83	self._vtk_actor2D.GetTextProperty().SetFontFamilyToCourier()
84
85	def boldOn(self):
86	"""
87	Bold the 2D text.
88	"""
89
90	self._vtk_actor2D.GetTextProperty().BoldOn()
91
92	def shadowOn(self):
93	"""
94	Apply shadow onto the 2D text to ease visibility.
95	"""
96
97	self._vtk_actor2D.GetTextProperty().ShadowOn()
98
99	def setColor(self, color):
100	"""
101	Set the color of the 2D text.
102
103	@type color: L{Color <constant.Color>} constant
104	@param color: 2D text color
105	"""
106
107	self._vtk_actor2D.GetTextProperty().SetColor(color)
108