Salome HOME
82733ff05bb69a8dbccf381241b10f7565f2b8fc
[modules/paravis.git] / test / VisuPrs / Util / paravistest.py
1 # Copyright (C) 2010-2013  CEA/DEN, EDF R&D
2 #
3 # This library is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU Lesser General Public
5 # License as published by the Free Software Foundation; either
6 # version 2.1 of the License.
7 #
8 # This library is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 # Lesser General Public License for more details.
12 #
13 # You should have received a copy of the GNU Lesser General Public
14 # License along with this library; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 #
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 #
19
20 """
21 This module provides auxiliary classes, functions and variables for testing.
22 """
23
24 #from __future__ import print_function
25
26 from math import fabs
27 import os
28 from datetime import date
29
30 import salome
31
32 # Auxiliary variables
33
34 # Data directory
35 samples_dir = os.getenv("DATA_DIR")
36 datadir = None
37 tablesdir = None
38 if samples_dir is not None:
39     samples_dir = os.path.normpath(samples_dir)
40     datadir = samples_dir + "/MedFiles/"
41     tablesdir = samples_dir + "/Tables/"
42
43 # Graphica files extension
44 pictureext = os.getenv("PIC_EXT")
45 if pictureext == None:
46     pictureext = "png"
47
48
49 # Auxiliary classes
50 class RepresentationType:
51     """
52     Types of representation.
53     """
54     OUTLINE = 0
55     POINTS = 1
56     WIREFRAME = 2
57     SURFACE = 3
58     SURFACEEDGES = 4
59     VOLUME = 5
60     POINTSPRITE = 6
61
62     _type2name = {OUTLINE: 'Outline',
63                   POINTS: 'Points',
64                   WIREFRAME: 'Wireframe',
65                   SURFACE: 'Surface',
66                   SURFACEEDGES: 'Surface With Edges',
67                   VOLUME: 'Volume',
68                   POINTSPRITE: 'Point Sprite'}
69
70     @classmethod
71     def get_name(cls, type):
72         """Return paraview representation type by the primitive type."""
73         return cls._type2name[type]
74
75
76 class SalomeSession(object):
77     def __init__(self):
78         import runSalome
79         import sys
80         #sys.argv += ["--killall"]
81         #sys.argv += ["--portkill=" + port]
82         sys.argv += ["--show-desktop=1"]
83         sys.argv += ["--splash=0"]
84         sys.argv += ["--modules=MED,PARAVIS"]
85         sys.argv += ["--standalone=study"]
86         sys.argv += ["--embedded=SalomeAppEngine,cppContainer,registry,moduleCatalog"]
87         clt, d = runSalome.main()
88         port = d['port']
89         self.port = port
90         return
91
92     #VTN: workaround for crash on CentOS.6.3.64
93     #def __del__(self):
94         #os.system('killSalomeWithPort.py {0}'.format(self.port))
95         #os.system('killSalomeWithPort.py ' + self.port)
96         #import killSalomeWithPort
97         #killSalomeWithPort.killMyPort(self.port)
98         #return
99     pass
100
101
102 # Auxiliary functions
103 def test_values(value, et_value, check_error=0):
104     """Test values."""
105     error = 0
106     length = len(value)
107     et_length = len(et_value)
108     if (length != et_length):
109         err_msg = "ERROR!!! There is different number of created " + str(length) + " and etalon " + str(et_length) + " values!!!"
110         print err_msg
111         error = error + 1
112     else:
113         for i in range(et_length):
114             if abs(et_value[i]) > 1:
115                 max_val = abs(0.001 * et_value[i])
116                 if abs(et_value[i] - value[i]) > max_val:
117                     err_msg = "ERROR!!! Got value " + str(value[i]) + " is not equal to etalon value " + str(ret_value[i]) + "!!!"
118                     print err_msg
119                     error = error + 1
120             else:
121                 max_val = 0.001
122                 if abs(et_value[i] - value[i]) > max_val:
123                     err_msg = "ERROR!!! Got value " + value[i] + " is not equal to etalon value " + et_value[i] + "!!!"
124                     error = error + 1
125     if check_error and error > 0:
126         err_msg = ("There is(are) some error(s) was(were) found... "
127                    "For more info see ERRORs above...")
128         raise RuntimeError(err_msg)
129     return error
130
131
132 def get_picture_dir(pic_dir, subdir):
133     res_dir = pic_dir
134     if not res_dir:
135         res_dir = "/tmp/pic"
136
137     # Add current date and subdirectory for the case to the directory path
138     cur_date = date.today().strftime("%d%m%Y")
139     res_dir += "/test_" + cur_date + "/" + subdir
140     # Create the directory if doesn't exist
141     res_dir = os.path.normpath(res_dir)
142     if not os.path.exists(res_dir):
143         os.makedirs(res_dir)
144     else:
145         # Clean the directory
146         for root, dirs, files in os.walk(res_dir):
147             for f in files:
148                 os.remove(os.path.join(root, f))
149
150     return res_dir
151
152
153 def call_and_check(prs, property_name, value, do_raise=1, compare_toler=-1.0):
154     """Utility function for 3D viewer test for common check of different
155     types of presentation parameters set"""
156     try:
157         prs.SetPropertyWithName(property_name, value)
158     except ValueError:
159         error_string = (str(value) + "value of " + property_name + " is not available for this type of presentations")
160     else:
161         error_string = None
162     is_good = (error_string is None)
163     if not is_good:
164         if do_raise:
165             raise RuntimeError(error_string)
166         else:
167             print error_string
168     else:
169         # compare just set value and the one got from presentation
170         really_set_value = prs.GetPropertyValue(property_name)
171         is_equal = 1
172         if compare_toler > 0:
173             is_equal = (fabs(really_set_value - value) < compare_toler)
174         else:
175             is_equal = (really_set_value == value)
176         if not is_equal:
177             msg = str(really_set_value) + " has been set instead"
178             if do_raise:
179                 raise RuntimeError(msg)
180             else:
181                 print msg
182                 is_good = False
183
184     return is_good
185
186
187 def setShaded(view, shading):
188     """Utility function to set shaded mode in view"""
189     if shading == 0:
190         view.LightDiffuseColor = [1, 1, 1]
191     if shading == 1:
192         view.LightDiffuseColor = [0, 0, 0]
193
194
195 # Run Salome
196 salome_session = SalomeSession()
197 salome.salome_init()