1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>visu_basic</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="core.html" title="Part I. Core">
<link rel="prev" href="v-sim-visu-commandLine.html" title="visu_commandLine">
<link rel="next" href="v-sim-visu-elements.html" title="visu_elements">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="v-sim-visu-commandLine.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-visu-elements.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-visu-basic.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-visu-basic.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="visu_basic">
<a name="v-sim-visu-basic"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-visu-basic.top_of_page"></a>visu_basic</span></h2>
<p>visu_basic — Main functions of V_Sim (except graphical
ones).</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-visu-basic.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="v-sim-visu-basic.html#VisuBasicCLISet" title="VisuBasicCLISet">VisuBasicCLISet</a>;
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#initVisuBasic" title="initVisuBasic ()">initVisuBasic</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-getLoadCancel" title="visu_basic_getLoadCancel ()">visu_basic_getLoadCancel</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadCancel" title="visu_basic_setLoadCancel ()">visu_basic_setLoadCancel</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> status</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadMessageFunc" title="visu_basic_setLoadMessageFunc ()">visu_basic_setLoadMessageFunc</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadMessage" title="visu_basic_setLoadMessage ()">visu_basic_setLoadMessage</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mess</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-loadData" title="visu_basic_loadData ()">visu_basic_loadData</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code><span class="type">int</span> nSet</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-parseConfigFiles" title="visu_basic_parseConfigFiles ()">visu_basic_parseConfigFiles</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-applyCommandLine" title="visu_basic_applyCommandLine ()">visu_basic_applyCommandLine</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-basic.html#VisuBasicCLISet" title="VisuBasicCLISet"><span class="type">VisuBasicCLISet</span></a> *set</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-showOptionHelp" title="visu_basic_showOptionHelp ()">visu_basic_showOptionHelp</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> force</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-createExtensions" title="visu_basic_createExtensions ()">visu_basic_createExtensions</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-basic.html#VisuBasicCLISet" title="VisuBasicCLISet"><span class="type">VisuBasicCLISet</span></a> *set</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> rebuild</code></em>);
<a class="link" href="v-sim-visu-data.html#VisuData"><span class="returnvalue">VisuData</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-setDataFromCommandLine" title="visu_basic_setDataFromCommandLine ()">visu_basic_setDataFromCommandLine</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-setExtInfos" title="visu_basic_setExtInfos ()">visu_basic_setExtInfos</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-extInfos.html#VisuGlExtInfosDrawMethod" title="enum VisuGlExtInfosDrawMethod"><span class="type">VisuGlExtInfosDrawMethod</span></a> method</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-dataNode.html#VisuDataNode"><span class="type">VisuDataNode</span></a> *data</code></em>);
<span class="returnvalue">int</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-mainExport" title="visu_basic_mainExport ()">visu_basic_mainExport</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="v-sim-toolPhysic.html#ToolUnits" title="enum ToolUnits"><span class="returnvalue">ToolUnits</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-getPreferedUnit" title="visu_basic_getPreferedUnit ()">visu_basic_getPreferedUnit</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-basic.html#visu-basic-setPreferedUnit" title="visu_basic_setPreferedUnit ()">visu_basic_setPreferedUnit</a> (<em class="parameter"><code><a class="link" href="v-sim-toolPhysic.html#ToolUnits" title="enum ToolUnits"><span class="type">ToolUnits</span></a> unit</code></em>);
#define <a class="link" href="v-sim-visu-basic.html#VISU-VERSION:CAPS" title="VISU_VERSION">VISU_VERSION</a>
#define <a class="link" href="v-sim-visu-basic.html#VISU-WEB-SITE:CAPS" title="VISU_WEB_SITE">VISU_WEB_SITE</a>
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-setExePath" title="visu_basic_setExePath ()">visu_basic_setExePath</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *exePath</code></em>);
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-DATA-DIR:CAPS" title="V_SIM_DATA_DIR">V_SIM_DATA_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-LEGAL-DIR:CAPS" title="V_SIM_LEGAL_DIR">V_SIM_LEGAL_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-PIXMAPS-DIR:CAPS" title="V_SIM_PIXMAPS_DIR">V_SIM_PIXMAPS_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-ICONS-DIR:CAPS" title="V_SIM_ICONS_DIR">V_SIM_ICONS_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-LOCAL-CONF-DIR:CAPS" title="V_SIM_LOCAL_CONF_DIR">V_SIM_LOCAL_CONF_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-OLD-LOCAL-CONF-DIR:CAPS" title="V_SIM_OLD_LOCAL_CONF_DIR">V_SIM_OLD_LOCAL_CONF_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-PLUGINS-DIR:CAPS" title="V_SIM_PLUGINS_DIR">V_SIM_PLUGINS_DIR</a>
#define <a class="link" href="v-sim-visu-basic.html#V-SIM-LOCALE-DIR:CAPS" title="V_SIM_LOCALE_DIR">V_SIM_LOCALE_DIR</a>
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getDataDir" title="visu_basic_getDataDir ()">visu_basic_getDataDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getLegalDir" title="visu_basic_getLegalDir ()">visu_basic_getLegalDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getPixmapsDir" title="visu_basic_getPixmapsDir ()">visu_basic_getPixmapsDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getIconsDir" title="visu_basic_getIconsDir ()">visu_basic_getIconsDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getLocalDir" title="visu_basic_getLocalDir ()">visu_basic_getLocalDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getOldLocalDir" title="visu_basic_getOldLocalDir ()">visu_basic_getOldLocalDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getPluginsDir" title="visu_basic_getPluginsDir ()">visu_basic_getPluginsDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getLocaleDir" title="visu_basic_getLocaleDir ()">visu_basic_getLocaleDir</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a>* <a class="link" href="v-sim-visu-basic.html#visu-basic-getMainContext" title="visu_basic_getMainContext ()">visu_basic_getMainContext</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-basic.html#visu-basic-freeAll" title="visu_basic_freeAll ()">visu_basic_freeAll</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-visu-basic.description"></a><h2>Description</h2>
<p>
</p>
<p>There are here the main functions of V_Sim (except for
graphical methods) such as open file.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-visu-basic.details"></a><h2>Details</h2>
<div class="refsect2" title="VisuBasicCLISet">
<a name="VisuBasicCLISet"></a><h3>VisuBasicCLISet</h3>
<pre class="programlisting">typedef struct {
gchar *colorFile;
Plane **planesList;
Surfaces **surfsList;
GList *fieldsList;
Shade *shade;
gint *mapPlaneId;
ToolMatrixScalingFlag logScale;
guint nIsolines;
float* isoLinesColor;
gchar *bgImage;
} VisuBasicCLISet;
</pre>
<p>
Internal object to store values read from command line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="VisuBasicCLISet.colorFile"></a>colorFile</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> **<em class="structfield"><code><a name="VisuBasicCLISet.planesList"></a>planesList</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="v-sim-surfaces.html#Surfaces" title="Surfaces"><span class="type">Surfaces</span></a> **<em class="structfield"><code><a name="VisuBasicCLISet.surfsList"></a>surfsList</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="VisuBasicCLISet.fieldsList"></a>fieldsList</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="v-sim-toolShade.html#Shade" title="Shade"><span class="type">Shade</span></a> *<em class="structfield"><code><a name="VisuBasicCLISet.shade"></a>shade</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *<em class="structfield"><code><a name="VisuBasicCLISet.mapPlaneId"></a>mapPlaneId</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="v-sim-toolMatrix.html#ToolMatrixScalingFlag" title="enum ToolMatrixScalingFlag"><span class="type">ToolMatrixScalingFlag</span></a> <em class="structfield"><code><a name="VisuBasicCLISet.logScale"></a>logScale</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="VisuBasicCLISet.nIsolines"></a>nIsolines</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">float</span> *<em class="structfield"><code><a name="VisuBasicCLISet.isoLinesColor"></a>isoLinesColor</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="VisuBasicCLISet.bgImage"></a>bgImage</code></em>;</span></p></td>
<td>TODO
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="initVisuBasic ()">
<a name="initVisuBasic"></a><h3>initVisuBasic ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> initVisuBasic (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
A call to this method is done at startup after having probe the locale of the file
system and having initialized the rendering window. It makes the following actions :
create the visu object to store the signals, initialize the module part (parameters,
and resources), initialize the dump part, the OpenGL part and its extensions, the
storage of elements and the 'colorize with data' part.
</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getLoadCancel ()">
<a name="visu-basic-getLoadCancel"></a><h3>visu_basic_getLoadCancel ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_basic_getLoadCancel (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
V_Sim implements cancelation load process by setting a flag that can
be check by running routine. Use this method to check the flag
value (not thread safe). See <a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadCancel" title="visu_basic_setLoadCancel ()"><code class="function">visu_basic_setLoadCancel()</code></a> to set the
cancelation flag.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the cancelation status.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_setLoadCancel ()">
<a name="visu-basic-setLoadCancel"></a><h3>visu_basic_setLoadCancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_setLoadCancel (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> status</code></em>);</pre>
<p>
V_Sim implements cancelation load process by setting a flag that can
be check by running routine. Use this method to set the flag
value (not thread safe). See <a class="link" href="v-sim-visu-basic.html#visu-basic-getLoadCancel" title="visu_basic_getLoadCancel ()"><code class="function">visu_basic_getLoadCancel()</code></a> to check the
cancelation flag.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_setLoadMessageFunc ()">
<a name="visu-basic-setLoadMessageFunc"></a><h3>visu_basic_setLoadMessageFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_setLoadMessageFunc (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GFunc"><span class="type">GFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
When a load process is running, on can defined a message function
that may be called to output message to the user using
<a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadMessage" title="visu_basic_setLoadMessage ()"><code class="function">visu_basic_setLoadMessage()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td> a function to print a message.. scope call</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_setLoadMessage ()">
<a name="visu-basic-setLoadMessage"></a><h3>visu_basic_setLoadMessage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_setLoadMessage (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mess</code></em>);</pre>
<p>
If a message function on load action has been set by
<a class="link" href="v-sim-visu-basic.html#visu-basic-setLoadMessageFunc" title="visu_basic_setLoadMessageFunc ()"><code class="function">visu_basic_setLoadMessageFunc()</code></a>, then the given <em class="parameter"><code>mess</code></em> is given as
argument to this function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mess</code></em> :</span></p></td>
<td>a string.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_loadData ()">
<a name="visu-basic-loadData"></a><h3>visu_basic_loadData ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_basic_loadData (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-toolFileFormat.html#ToolFileFormat" title="ToolFileFormat"><span class="type">ToolFileFormat</span></a> *format</code></em>,
<em class="parameter"><code><span class="type">int</span> nSet</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This calls the load method of the current rendering
method. Some informations may be store in <em class="parameter"><code>error->message</code></em> if the returned
value is FALSE.
The file(s) which is(are) opened is(are) stored in the
<a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a>. The <em class="parameter"><code>nSet</code></em> argument is used to load a specific set of
nodes if the input format supports it. If <em class="parameter"><code>nSet</code></em> is 0, then the
default set of nodes is loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> a pointer on a format (can be NULL if format is to be
guessed) ;. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nSet</code></em> :</span></p></td>
<td>an integer ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer to store a possible error, location must be initialized to (GError*)0.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everithing is OK, if FALSE, the <em class="parameter"><code>error</code></em> is set and should be freed
with <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free"><code class="function">g_error_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_parseConfigFiles ()">
<a name="visu-basic-parseConfigFiles"></a><h3>visu_basic_parseConfigFiles ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_parseConfigFiles (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Parse the parameter and the resource file. Used once at startup.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="type">GString</span></a> if some error occured.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_applyCommandLine ()">
<a name="visu-basic-applyCommandLine"></a><h3>visu_basic_applyCommandLine ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_basic_applyCommandLine (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-basic.html#VisuBasicCLISet" title="VisuBasicCLISet"><span class="type">VisuBasicCLISet</span></a> *set</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Call all the get methods on the command line options to tune the
given <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object to apply the options on ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td>a table of options ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a location for error report.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if complete without error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_showOptionHelp ()">
<a name="visu-basic-showOptionHelp"></a><h3>visu_basic_showOptionHelp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_basic_showOptionHelp (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> force</code></em>);</pre>
<p>
Display a small help for some options. The output is different from
the -h command line options, here some details about running time
options is displayed like the available file format for
exportation... If <em class="parameter"><code>force</code></em> is TRUE, all possible values are output,
otherwise only those relevant to the user provided command line
options.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>force</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if something is displayed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_createExtensions ()">
<a name="visu-basic-createExtensions"></a><h3>visu_basic_createExtensions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_createExtensions (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-basic.html#VisuBasicCLISet" title="VisuBasicCLISet"><span class="type">VisuBasicCLISet</span></a> *set</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> rebuild</code></em>);</pre>
<p>
Create all extensions (planes, surfaces...) for the given data. Use
static values read from <a class="link" href="v-sim-visu-basic.html#visu-basic-applyCommandLine" title="visu_basic_applyCommandLine ()"><code class="function">visu_basic_applyCommandLine()</code></a>. This method
is mainly used when V_Sim run without the command panel.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td>a table of options ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rebuild</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_setDataFromCommandLine ()">
<a name="visu-basic-setDataFromCommandLine"></a><h3>visu_basic_setDataFromCommandLine ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-data.html#VisuData"><span class="returnvalue">VisuData</span></a>* visu_basic_setDataFromCommandLine (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Read the command line option and set the filenames for a new
<a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a>. The object is not loaded (files are not parsed), just prepared.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> if required.. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. </td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_setExtInfos ()">
<a name="visu-basic-setExtInfos"></a><h3>visu_basic_setExtInfos ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_setExtInfos (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-extInfos.html#VisuGlExtInfosDrawMethod" title="enum VisuGlExtInfosDrawMethod"><span class="type">VisuGlExtInfosDrawMethod</span></a> method</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-dataNode.html#VisuDataNode"><span class="type">VisuDataNode</span></a> *data</code></em>);</pre>
<p>
Create and draw possible information on nodes. This method
is mainly used when V_Sim run without the command panel.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>where to draw information ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>a possible list of selected nodes, or NULL ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>the information to draw.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_mainExport ()">
<a name="visu-basic-mainExport"></a><h3>visu_basic_mainExport ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> visu_basic_mainExport (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This method is called when V_Sim is in export mode from the command line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 0 if everything is normal, 1 if an error occured.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_basic_getPreferedUnit ()">
<a name="visu-basic-getPreferedUnit"></a><h3>visu_basic_getPreferedUnit ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolPhysic.html#ToolUnits" title="enum ToolUnits"><span class="returnvalue">ToolUnits</span></a> visu_basic_getPreferedUnit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
By setting the prefered unit, when a file is load, V_Sim tries to
render it in this prefered unit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the prefered unit set by the user (default is
<a class="link" href="v-sim-toolPhysic.html#unit-undefined"><span class="type">unit_undefined</span></a>).
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_setPreferedUnit ()">
<a name="visu-basic-setPreferedUnit"></a><h3>visu_basic_setPreferedUnit ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_basic_setPreferedUnit (<em class="parameter"><code><a class="link" href="v-sim-toolPhysic.html#ToolUnits" title="enum ToolUnits"><span class="type">ToolUnits</span></a> unit</code></em>);</pre>
<p>
By setting the prefered unit, when a file is load, V_Sim tries to
render it in this prefered unit.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>unit</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-toolPhysic.html#ToolUnits" title="enum ToolUnits"><span class="type">ToolUnits</span></a> value.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the prefered unit is actually changed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="VISU_VERSION">
<a name="VISU-VERSION:CAPS"></a><h3>VISU_VERSION</h3>
<pre class="programlisting">#define VISU_VERSION VERSION
</pre>
<p>
The value of current compiled version.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_WEB_SITE">
<a name="VISU-WEB-SITE:CAPS"></a><h3>VISU_WEB_SITE</h3>
<pre class="programlisting">#define VISU_WEB_SITE "http://inac.cea.fr/L_Sim/V_Sim"
</pre>
<p>
URL where to find info on V_Sim.
</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_setExePath ()">
<a name="visu-basic-setExePath"></a><h3>visu_basic_setExePath ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_setExePath (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *exePath</code></em>);</pre>
<p>
This method is used to tell V_Sim where V_Sim is running (usually
reading from argv[0]. This makes it possible to relocate everything
on the fly. <em class="parameter"><code>exePath</code></em> is copied.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>exePath</code></em> :</span></p></td>
<td>a path where the V_Sim executable is running in.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_DATA_DIR">
<a name="V-SIM-DATA-DIR:CAPS"></a><h3>V_SIM_DATA_DIR</h3>
<pre class="programlisting">#define V_SIM_DATA_DIR visu_basic_getDataDir()
</pre>
<p>
The directory where data files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_LEGAL_DIR">
<a name="V-SIM-LEGAL-DIR:CAPS"></a><h3>V_SIM_LEGAL_DIR</h3>
<pre class="programlisting">#define V_SIM_LEGAL_DIR visu_basic_getLegalDir()
</pre>
<p>
The directory where copyright and author files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_PIXMAPS_DIR">
<a name="V-SIM-PIXMAPS-DIR:CAPS"></a><h3>V_SIM_PIXMAPS_DIR</h3>
<pre class="programlisting">#define V_SIM_PIXMAPS_DIR visu_basic_getPixmapsDir()
</pre>
<p>
The directory where pixmap files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_ICONS_DIR">
<a name="V-SIM-ICONS-DIR:CAPS"></a><h3>V_SIM_ICONS_DIR</h3>
<pre class="programlisting">#define V_SIM_ICONS_DIR visu_basic_getIconsDir()
</pre>
<p>
The directory where icon files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_LOCAL_CONF_DIR">
<a name="V-SIM-LOCAL-CONF-DIR:CAPS"></a><h3>V_SIM_LOCAL_CONF_DIR</h3>
<pre class="programlisting">#define V_SIM_LOCAL_CONF_DIR visu_basic_getLocalDir()
</pre>
<p>
The directory where user configuration files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_OLD_LOCAL_CONF_DIR">
<a name="V-SIM-OLD-LOCAL-CONF-DIR:CAPS"></a><h3>V_SIM_OLD_LOCAL_CONF_DIR</h3>
<pre class="programlisting">#define V_SIM_OLD_LOCAL_CONF_DIR visu_basic_getOldLocalDir()
</pre>
<p>
Old value of <a class="link" href="v-sim-visu-basic.html#V-SIM-LOCAL-CONF-DIR:CAPS" title="V_SIM_LOCAL_CONF_DIR"><span class="type">V_SIM_LOCAL_CONF_DIR</span></a>.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_PLUGINS_DIR">
<a name="V-SIM-PLUGINS-DIR:CAPS"></a><h3>V_SIM_PLUGINS_DIR</h3>
<pre class="programlisting">#define V_SIM_PLUGINS_DIR visu_basic_getPluginsDir()
</pre>
<p>
The directory where plugin files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="V_SIM_LOCALE_DIR">
<a name="V-SIM-LOCALE-DIR:CAPS"></a><h3>V_SIM_LOCALE_DIR</h3>
<pre class="programlisting">#define V_SIM_LOCALE_DIR visu_basic_getLocaleDir()
</pre>
<p>
The directory where locale files are stored.
</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getDataDir ()">
<a name="visu-basic-getDataDir"></a><h3>visu_basic_getDataDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getDataDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its data files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getLegalDir ()">
<a name="visu-basic-getLegalDir"></a><h3>visu_basic_getLegalDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getLegalDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its legal files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getPixmapsDir ()">
<a name="visu-basic-getPixmapsDir"></a><h3>visu_basic_getPixmapsDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getPixmapsDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its pixmap files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getIconsDir ()">
<a name="visu-basic-getIconsDir"></a><h3>visu_basic_getIconsDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getIconsDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its icon files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getLocalDir ()">
<a name="visu-basic-getLocalDir"></a><h3>visu_basic_getLocalDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getLocalDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its user configuration files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getOldLocalDir ()">
<a name="visu-basic-getOldLocalDir"></a><h3>visu_basic_getOldLocalDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getOldLocalDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its user configuration
files (old location).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getPluginsDir ()">
<a name="visu-basic-getPluginsDir"></a><h3>visu_basic_getPluginsDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getPluginsDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its plug-in files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getLocaleDir ()">
<a name="visu-basic-getLocaleDir"></a><h3>visu_basic_getLocaleDir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_basic_getLocaleDir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Get the static string where V_Sim looks for its localisation files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_getMainContext ()">
<a name="visu-basic-getMainContext"></a><h3>visu_basic_getMainContext ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="returnvalue">GMainContext</span></a>* visu_basic_getMainContext (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Even without GUI, V_Sim requires to run a main loop. This method is
to get the main loop.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the main loop, as defined in GLib.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_basic_freeAll ()">
<a name="visu-basic-freeAll"></a><h3>visu_basic_freeAll ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_basic_freeAll (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This routine is called by V_Sim when quiting and it frees the memory
used by visu_basic.
</p>
<p class="since">Since 3.5</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|