Logo ROOT  
Reference Guide
REveGeomViewer.cxx
Go to the documentation of this file.
1// @(#)root/eve7:$Id$
2// Author: Sergey Linev, 13.12.2018
3
4/*************************************************************************
5 * Copyright (C) 1995-2019, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
13
14#include <ROOT/REveUtil.hxx> // REveLog()
15#include <ROOT/RLogger.hxx>
16#include <ROOT/RWebWindow.hxx>
17
18#include "TSystem.h"
19#include "TBase64.h"
20#include "TROOT.h"
21#include "TEnv.h"
22#include "THttpServer.h"
23#include "TBufferJSON.h"
24#include "TGeoManager.h"
25
26#include <fstream>
27
28using namespace std::string_literals;
29
30//////////////////////////////////////////////////////////////////////////////////////////////
31/// constructor
32
34{
36 fWebWindow->SetDefaultPage("file:rootui5sys/eve7/geom.html");
37
38 // this is call-back, invoked when message received via websocket
39 fWebWindow->SetDataCallBack([this](unsigned connid, const std::string &arg) { WebWindowCallback(connid, arg); });
40 fWebWindow->SetGeometry(900, 700); // configure predefined window geometry
41 fWebWindow->SetConnLimit(0); // allow any connections numbers at the same time
42 fWebWindow->SetMaxQueueLength(30); // number of allowed entries in the window queue
43
44 fDesc.SetPreferredOffline(gEnv->GetValue("WebGui.PreferredOffline",0) != 0);
46 fDesc.SetBuildShapes(gEnv->GetValue("WebGui.GeomBuildShapes", 1));
47
48 if (mgr) SetGeometry(mgr, volname);
49}
50
51//////////////////////////////////////////////////////////////////////////////////////////////
52/// destructor
53
55{
56
57}
58
59//////////////////////////////////////////////////////////////////////////////////////////////
60/// assign new geometry to the viewer
61
63{
64 fGeoManager = mgr;
65 fSelectedVolume = volname;
66
67 fDesc.Build(mgr, volname);
68
69 Update();
70}
71
72
73/////////////////////////////////////////////////////////////////////////////////
74/// Select visible top volume, all other volumes will be disabled
75
77{
78 if (volname != fSelectedVolume)
79 SetGeometry(fGeoManager, volname);
80}
81
82/////////////////////////////////////////////////////////////////////////////////
83/// Show or update geometry in web window
84/// If web browser already started - just refresh drawing like "reload" button does
85/// If no web window exists or \param always_start_new_browser configured, starts new window
86
87void ROOT::Experimental::REveGeomViewer::Show(const RWebDisplayArgs &args, bool always_start_new_browser)
88{
89 std::string user_args = "";
90 if (!GetShowHierarchy()) user_args = "{ nobrowser: true }";
91 fWebWindow->SetUserArgs(user_args);
92
93 if (args.GetWidgetKind().empty())
94 const_cast<RWebDisplayArgs *>(&args)->SetWidgetKind("REveGeomViewer");
95
96 if ((fWebWindow->NumConnections(true) == 0) || always_start_new_browser)
97 fWebWindow->Show(args);
98 else
99 Update();
100}
101
102//////////////////////////////////////////////////////////////////////////////////////////////
103/// Return URL address of web window used for geometry viewer
104
106{
107 if (!fWebWindow) return "";
108 return fWebWindow->GetAddr();
109}
110
111//////////////////////////////////////////////////////////////////////////////////////////////
112/// Update geometry drawings in all web displays
113
115{
116 fWebWindow->Send(0, "RELOAD");
117}
118
119//////////////////////////////////////////////////////////////////////////////////////////////
120/// convert JSON into stack array
121
122std::vector<int> ROOT::Experimental::REveGeomViewer::GetStackFromJson(const std::string &json, bool node_ids)
123{
124 std::vector<int> *stack{nullptr}, res;
125
126 if (TBufferJSON::FromJSON(stack, json.c_str())) {
127 if (node_ids) res = fDesc.MakeStackByIds(*stack);
128 else res = *stack;
129 delete stack;
130 } else {
131 R__LOG_ERROR(REveLog()) << "Fail convert " << json << " into vector<int>";
132 }
133
134 return res;
135}
136
137//////////////////////////////////////////////////////////////////////////////////////////////
138/// Send data for principal geometry draw
139
141{
142 if (!fDesc.HasDrawData())
143 fDesc.CollectVisibles();
144
145 auto &json = fDesc.GetDrawJson();
146
147 R__LOG_DEBUG(0, REveLog()) << "Produce geometry JSON len: " << json.length();
148
149 fWebWindow->Send(connid, json);
150}
151
152//////////////////////////////////////////////////////////////////////////////////////////////
153/// Configures draw option for geometry
154/// Normally has effect before first drawing of the geometry
155/// When geometry displayed, only "axis" and "rotate" options are updated
156
158{
159 fDesc.SetDrawOptions(opt);
160 unsigned connid = fWebWindow->GetConnectionId();
161 if (connid)
162 fWebWindow->Send(connid, "DROPT:"s + opt);
163}
164
165//////////////////////////////////////////////////////////////////////////////////////////////
166/// Produce PNG image of drawn geometry
167/// Drawing should be completed at the moment
168/// Executed asynchronous - method returns immediately, image stored when received from the client
169
171{
172 unsigned connid = fWebWindow->GetConnectionId();
173 if (connid)
174 fWebWindow->Send(connid, "IMAGE:"s + fname);
175}
176
177//////////////////////////////////////////////////////////////////////////////////////////////
178/// receive data from client
179
180void ROOT::Experimental::REveGeomViewer::WebWindowCallback(unsigned connid, const std::string &arg)
181{
182 printf("Recv %s\n", arg.substr(0,100).c_str());
183
184 if (arg == "GETDRAW") {
185
186 SendGeometry(connid);
187
188 } else if (arg == "QUIT_ROOT") {
189
190 fWebWindow->TerminateROOT();
191
192 } else if (arg.compare(0, 7, "SEARCH:") == 0) {
193
194 std::string query = arg.substr(7);
195
196 std::string hjson, json;
197
198 auto nmatches = fDesc.SearchVisibles(query, hjson, json);
199
200 printf("Searches %s found %d hjson %d json %d\n", query.c_str(), nmatches, (int) hjson.length(), (int) json.length());
201
202 // send reply with appropriate header - NOFOUND, FOUND0:, FOUND1:
203 fWebWindow->Send(connid, hjson);
204
205 if (!json.empty())
206 fWebWindow->Send(connid, json);
207
208 } else if (arg.compare(0,4,"GET:") == 0) {
209 // provide exact shape
210
211 auto stack = GetStackFromJson(arg.substr(4));
212
213 auto nodeid = fDesc.FindNodeId(stack);
214
215 std::string json{"SHAPE:"};
216
217 fDesc.ProduceDrawingFor(nodeid, json);
218
219 printf("Produce shape for stack json %d\n", (int) json.length());
220
221 fWebWindow->Send(connid, json);
222
223 } else if (arg.compare(0, 6, "GVREQ:") == 0) {
224
225 auto req = TBufferJSON::FromJSON<REveGeomRequest>(arg.substr(6));
226
227 if (req && (req->oper == "HOVER")) {
228 if ((req->path.size() > 0 ) && (req->path[0] != "OFF"))
229 req->stack = fDesc.MakeStackByPath(req->path);
230 req->path.clear();
231 } else if (req && (req->oper == "HIGHL")) {
232 if (req->stack.size() > 0)
233 req->path = fDesc.MakePathByStack(req->stack);
234 req->stack.clear();
235 } else if (req && (req->oper == "INFO")) {
236
237 auto info = fDesc.MakeNodeInfo(req->path);
238 if (info)
239 fWebWindow->Send(connid, "NINFO:"s + TBufferJSON::ToJSON(info.get(), (fDesc.GetJsonComp() % 5) + TBufferJSON::kSameSuppression).Data());
240
241 // not request but different object type is send
242 req.reset(nullptr);
243
244 } else {
245 req.reset(nullptr);
246 }
247
248 if (req)
249 fWebWindow->Send(connid, "GVRPL:"s + TBufferJSON::ToJSON(req.get(), TBufferJSON::kSkipTypeInfo + TBufferJSON::kNoSpaces).Data());
250
251 } else if ((arg.compare(0, 7, "SETVI0:") == 0) || (arg.compare(0, 7, "SETVI1:") == 0)) {
252 // change visibility for specified nodeid
253
254 auto nodeid = std::stoi(arg.substr(7));
255
256 bool selected = (arg[5] == '1');
257
258 if (fDesc.ChangeNodeVisibility(nodeid, selected)) {
259
260 // send only modified entries, includes all nodes with same volume
261 std::string json0 = fDesc.ProduceModifyReply(nodeid);
262
263 // when visibility disabled, client will automatically remove node from drawing
264 fWebWindow->Send(connid, json0);
265
266 if (selected && fDesc.IsPrincipalEndNode(nodeid)) {
267 // we need to send changes in drawing elements
268 // there can be many elements, which reference same volume
269
270 std::string json{"APPND:"};
271
272 if (fDesc.ProduceDrawingFor(nodeid, json, true)) {
273
274 printf("Send appending JSON %d\n", (int) json.length());
275
276 fWebWindow->Send(connid, json);
277 }
278 } else if (selected) {
279
280 // just resend full geometry
281 // TODO: one can improve here and send only nodes which are not exists on client
282 // TODO: for that one should remember all information send to client
283
284 auto json = fDesc.ProcessBrowserRequest();
285 if (json.length() > 0) fWebWindow->Send(connid, json);
286
287 SendGeometry(connid);
288 }
289 }
290 } else if (arg.compare(0,6, "BRREQ:") == 0) {
291
292 // central place for processing browser requests
293
294 if (!fDesc.IsBuild()) fDesc.Build(fGeoManager);
295
296 auto json = fDesc.ProcessBrowserRequest(arg.substr(6));
297 if (json.length() > 0) fWebWindow->Send(connid, json);
298 } else if (arg.compare(0,6, "IMAGE:") == 0) {
299 auto separ = arg.find("::",6);
300 if (separ == std::string::npos) return;
301
302 std::string fname = arg.substr(6, separ-6);
303 if (fname.empty()) {
304 int cnt = 0;
305 do {
306 fname = "geometry"s;
307 if (cnt++>0) fname += std::to_string(cnt);
308 fname += ".png"s;
309 } while (!gSystem->AccessPathName(fname.c_str()));
310 }
311
312 TString binary = TBase64::Decode(arg.c_str() + separ + 2);
313
314 std::ofstream ofs(fname);
315 ofs.write(binary.Data(), binary.Length());
316 ofs.close();
317
318 printf("Image file %s size %d has been created\n", fname.c_str(), (int) binary.Length());
319
320 } else if (arg.compare(0,4, "CFG:") == 0) {
321
322 if (fDesc.ChangeConfiguration(arg.substr(4)))
323 SendGeometry(connid);
324
325 } else if (arg == "RELOAD") {
326
327 SendGeometry(connid);
328 }
329}
#define R__LOG_ERROR(...)
Definition: RLogger.hxx:362
#define R__LOG_DEBUG(DEBUGLEVEL,...)
Definition: RLogger.hxx:365
R__EXTERN TEnv * gEnv
Definition: TEnv.h:170
R__EXTERN TSystem * gSystem
Definition: TSystem.h:559
void SetJsonComp(int comp=0)
Set JSON compression level for data transfer.
void SetBuildShapes(int lvl=1)
Instruct to build binary 3D model already on the server (true) or send TGeoShape as is to client,...
void SetPreferredOffline(bool on)
Set preference of offline operations.
void SaveImage(const std::string &fname="geometry.png")
Produce PNG image of drawn geometry Drawing should be completed at the moment Executed asynchronous -...
void SelectVolume(const std::string &volname)
Select visible top volume, all other volumes will be disabled.
void Update()
Update geometry drawings in all web displays.
void SendGeometry(unsigned connid)
Send data for principal geometry draw.
std::string GetWindowAddr() const
Return URL address of web window used for geometry viewer.
std::shared_ptr< RWebWindow > fWebWindow
! web window to show geometry
REveGeomDescription fDesc
! geometry description, send to the client as first message
REveGeomViewer(TGeoManager *mgr=nullptr, const std::string &volname="")
constructor
void WebWindowCallback(unsigned connid, const std::string &arg)
receive data from client
std::vector< int > GetStackFromJson(const std::string &json, bool node_ids=false)
convert JSON into stack array
void SetDrawOptions(const std::string &opt)
Configures draw option for geometry Normally has effect before first drawing of the geometry When geo...
void SetGeometry(TGeoManager *mgr, const std::string &volname="")
assign new geometry to the viewer
void Show(const RWebDisplayArgs &args="", bool always_start_new_browser=false)
Show or update geometry in web window If web browser already started - just refresh drawing like "rel...
Holds different arguments for starting browser with RWebDisplayHandle::Display() method.
const std::string & GetWidgetKind() const
returns widget kind
static std::shared_ptr< RWebWindow > Create()
Create new RWebWindow Using default RWebWindowsManager.
static TString Decode(const char *data)
Decode a base64 string date into a generic TString.
Definition: TBase64.cxx:131
static TString ToJSON(const T *obj, Int_t compact=0, const char *member_name=nullptr)
Definition: TBufferJSON.h:75
@ kSkipTypeInfo
do not store typenames in JSON
Definition: TBufferJSON.h:48
@ kNoSpaces
no new lines plus remove all spaces around "," and ":" symbols
Definition: TBufferJSON.h:39
@ kSameSuppression
zero suppression plus compress many similar values together
Definition: TBufferJSON.h:45
static Bool_t FromJSON(T *&obj, const char *json)
Definition: TBufferJSON.h:81
virtual Int_t GetValue(const char *name, Int_t dflt) const
Returns the integer value for a resource.
Definition: TEnv.cxx:491
The manager class for any TGeo geometry.
Definition: TGeoManager.h:45
Basic string class.
Definition: TString.h:136
Ssiz_t Length() const
Definition: TString.h:410
const char * Data() const
Definition: TString.h:369
virtual Bool_t AccessPathName(const char *path, EAccessMode mode=kFileExists)
Returns FALSE if one can access a file using the specified access mode.
Definition: TSystem.cxx:1296
RLogChannel & REveLog()
Log channel for Eve diagnostics.
Definition: REveTypes.cxx:47
static constexpr double s
const char * cnt
Definition: TXMLSetup.cxx:75