| 1 | ################################################################################################### |
| 2 | |
| 3 | ################################## << [IvIsee] UserGuide >> ####################################### |
| 4 | |
| 5 | ################################################################################################### |
| 6 | |
| 7 | |
| 8 | |
| 9 | |
| 10 | |
| 11 | [IvIsee] : A 3D-Model viewr, supports 8 kinds model format , and presents 7 kinds stereo display. |
| 12 | |
| 13 | |
| 14 | |
| 15 | |
| 16 | |
| 17 | Bug Report : [lsi@nchc.gov.tw] |
| 18 | |
| 19 | |
| 20 | |
| 21 | |
| 22 | |
| 23 | *************************************************************************************************** |
| 24 | |
| 25 | |
| 26 | |
| 27 | =================================================================================================== |
| 28 | |
| 29 | <1>. Istallation Notes |
| 30 | |
| 31 | =================================================================================================== |
| 32 | |
| 33 | Only for Binary Files : |
| 34 | |
| 35 | |
| 36 | |
| 37 | |
| 38 | |
| 39 | (1) Unzip "IvIsee2.0.RC_1.zip" into your home directory |
| 40 | |
| 41 | |
| 42 | |
| 43 | |
| 44 | |
| 45 | (2) If you are using "Linux" ==> Copy the "IvIsee/Binary/Linux" directory to your home directory , command following |
| 46 | |
| 47 | |
| 48 | |
| 49 | cp -R ./IvIsee/Binary/Linux ~/IvIsee |
| 50 | |
| 51 | |
| 52 | |
| 53 | |
| 54 | |
| 55 | (3) If you are using "Windows" ==> Copy the "IvIsee\Binary\Win32" entire directory to "C:\" or anywhere you preferred , command following |
| 56 | |
| 57 | |
| 58 | |
| 59 | xcopy .\IvIsee\Binary\Win32 C:\IvIsee\ /s |
| 60 | |
| 61 | |
| 62 | |
| 63 | |
| 64 | |
| 65 | (4) Verify all files in "~/IvIsee" for "Linux" or "C:\IvIsee\" in "Windows" |
| 66 | |
| 67 | |
| 68 | |
| 69 | |
| 70 | |
| 71 | PS : Make sure "CONFIG" directory should be under "IvIsee" directory or your "HOME Directory" , like this |
| 72 | |
| 73 | |
| 74 | |
| 75 | ./IvIsee |
| 76 | |
| 77 | ./IvIsee/CONFIG |
| 78 | |
| 79 | |
| 80 | |
| 81 | *************************************************************************************************** |
| 82 | |
| 83 | |
| 84 | |
| 85 | |
| 86 | |
| 87 | |
| 88 | |
| 89 | |
| 90 | |
| 91 | *************************************************************************************************** |
| 92 | |
| 93 | |
| 94 | |
| 95 | =================================================================================================== |
| 96 | |
| 97 | <2>. Setup Notes |
| 98 | |
| 99 | =================================================================================================== |
| 100 | |
| 101 | Set "IvIsee_DIR" into the environment variable according your istallation path in Step <1> : |
| 102 | |
| 103 | |
| 104 | |
| 105 | |
| 106 | |
| 107 | (1) If you are using "Linux" (with sh or bash) ==> Append following lines into your "~/.profile" |
| 108 | |
| 109 | |
| 110 | |
| 111 | # ================================================================================================= |
| 112 | |
| 113 | # IvIsee Setting # |
| 114 | |
| 115 | export IvIsee_DIR="${HOME}/IvIsee" |
| 116 | |
| 117 | |
| 118 | |
| 119 | if [ -z "$LD_LIBRARY_PATH" ] ; then |
| 120 | |
| 121 | export LD_LIBRARY_PATH="${IvIsee_DIR}/LD_LIBRARY" |
| 122 | |
| 123 | else |
| 124 | |
| 125 | export LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:${IvIsee_DIR}/LD_LIBRARY" |
| 126 | |
| 127 | fi |
| 128 | |
| 129 | |
| 130 | |
| 131 | if [ -z "$PATH" ] ; then |
| 132 | |
| 133 | export PATH="${IvIsee_DIR}" |
| 134 | |
| 135 | else |
| 136 | |
| 137 | export PATH="${PATH}:${IvIsee_DIR}" |
| 138 | |
| 139 | fi |
| 140 | |
| 141 | # ================================================================================================= |
| 142 | |
| 143 | |
| 144 | |
| 145 | And then re-source the "~/.profile" file or logout and then re-login again to effect all setting |
| 146 | |
| 147 | |
| 148 | |
| 149 | |
| 150 | |
| 151 | (2) If you are using "Linux" (with csh or tcsh) ==> Append following lines into your "~/.cshrc" |
| 152 | |
| 153 | |
| 154 | |
| 155 | # ================================================================================================= |
| 156 | |
| 157 | # IvIsee Setting # |
| 158 | |
| 159 | setenv IvIsee_DIR "${HOME}/IvIsee" |
| 160 | |
| 161 | |
| 162 | |
| 163 | if (! $?LD_LIBRARY_PATH) then |
| 164 | |
| 165 | setenv LD_LIBRARY_PATH "${IvIsee_DIR}/LD_LIBRARY" |
| 166 | |
| 167 | else |
| 168 | |
| 169 | setenv LD_LIBRARY_PATH "${LD_LIBRARY_PATH}:${IvIsee_DIR}/LD_LIBRARY" |
| 170 | |
| 171 | endif |
| 172 | |
| 173 | |
| 174 | |
| 175 | if (! $?PATH) then |
| 176 | |
| 177 | setenv PATH "${IvIsee_DIR}" |
| 178 | |
| 179 | else |
| 180 | |
| 181 | setenv PATH "${PATH}:${IvIsee_DIR}" |
| 182 | |
| 183 | endif |
| 184 | |
| 185 | # ================================================================================================= |
| 186 | |
| 187 | |
| 188 | |
| 189 | And then re-source the "~/.cshrc" file or logout and then re-login again to effect all setting |
| 190 | |
| 191 | |
| 192 | |
| 193 | |
| 194 | |
| 195 | (3) If you are using "Windows" ==> Append following lines into your "C:\AUTOEXEC.BAT" |
| 196 | |
| 197 | |
| 198 | |
| 199 | # ================================================================================================= |
| 200 | |
| 201 | set IvIsee_DIR=C:\IvIsee |
| 202 | |
| 203 | set PATH=%PATH%;%IvIsee_DIR% |
| 204 | |
| 205 | # ================================================================================================= |
| 206 | |
| 207 | |
| 208 | |
| 209 | And then reboot your machine to effect all setting |
| 210 | |
| 211 | |
| 212 | |
| 213 | |
| 214 | |
| 215 | PS: If you are using "Window2000/XP" , you can also register your "IvIsee_DIR" and "PATH" variables in [Control Panel] -> [System] -> [Advanced] -> [Environment Variables] -> [System Variables] |
| 216 | |
| 217 | |
| 218 | |
| 219 | # ================================================================================================= |
| 220 | |
| 221 | IvIsee_DIR ==> C:\IvIsee |
| 222 | |
| 223 | PATH ==> %PATH%;%IvIsee_DIR% |
| 224 | |
| 225 | # ================================================================================================= |
| 226 | |
| 227 | |
| 228 | |
| 229 | And then the setting will be effect immediately |
| 230 | |
| 231 | |
| 232 | |
| 233 | *************************************************************************************************** |
| 234 | |
| 235 | |
| 236 | |
| 237 | |
| 238 | |
| 239 | |
| 240 | |
| 241 | |
| 242 | |
| 243 | *************************************************************************************************** |
| 244 | |
| 245 | |
| 246 | |
| 247 | =================================================================================================== |
| 248 | |
| 249 | <3>. Usage Notes |
| 250 | |
| 251 | =================================================================================================== |
| 252 | |
| 253 | How to Use IvIsee : |
| 254 | |
| 255 | |
| 256 | |
| 257 | |
| 258 | |
| 259 | (1) "Command-Line Mode" |
| 260 | |
| 261 | |
| 262 | |
| 263 | << [IvIsee 3.0.RC_1] -- Developed by "Kevin, NCHC, Taiwan" >> |
| 264 | |
| 265 | |
| 266 | |
| 267 | Usage : ivisee <DataFile> [StereoType(0-6)] [{RenderWindowWidth} {RenderWindowHeight}] [FullScreenMode(true|false)] [HideCursorMode(true|false)] |
| 268 | |
| 269 | |
| 270 | |
| 271 | [DataFile] : |
| 272 | |
| 273 | <2D Image> |
| 274 | |
| 275 | a => .bmp |
| 276 | |
| 277 | b => .jpg |
| 278 | |
| 279 | c => .pbm |
| 280 | |
| 281 | d => .pgm |
| 282 | |
| 283 | e => .ppm |
| 284 | |
| 285 | f => .tif |
| 286 | |
| 287 | g => .dcm |
| 288 | |
| 289 | |
| 290 | |
| 291 | <3D Model> |
| 292 | |
| 293 | a => .3ds |
| 294 | |
| 295 | b => .g |
| 296 | |
| 297 | c => .cdi |
| 298 | |
| 299 | d => .cyb |
| 300 | |
| 301 | e => .dem |
| 302 | |
| 303 | f => .obj |
| 304 | |
| 305 | g => .stl |
| 306 | |
| 307 | h => .tri |
| 308 | |
| 309 | i => .vtk (default) |
| 310 | |
| 311 | j => .wrl |
| 312 | |
| 313 | |
| 314 | |
| 315 | [StereoType] : |
| 316 | |
| 317 | 0 => Mono (default) |
| 318 | |
| 319 | 1 => CrystalEyes |
| 320 | |
| 321 | 2 => RedBlue |
| 322 | |
| 323 | 3 => Interlaced |
| 324 | |
| 325 | 4 => Dresden |
| 326 | |
| 327 | 5 => LeftEye |
| 328 | |
| 329 | 6 => RightEye |
| 330 | |
| 331 | |
| 332 | |
| 333 | |
| 334 | |
| 335 | Example_1 : ./IvIsee skin.vtk |
| 336 | |
| 337 | Example_2 : ./IvIsee skin.vtk 1 |
| 338 | |
| 339 | Example_3 : ./IvIsee skin.vtk 0 800 600 |
| 340 | |
| 341 | Example_3 : ./IvIsee skin.vtk 0 1024 768 true true |
| 342 | |
| 343 | |
| 344 | |
| 345 | |
| 346 | |
| 347 | (2) "GUI & File-Association MODE" |
| 348 | |
| 349 | |
| 350 | |
| 351 | A. Makesure you are in an windows desktop environment now (such as MS-Windows , KDE , Gnome ...etc) |
| 352 | |
| 353 | B. Move your mouse to focus on a 3D models which any kind of IvIsee supported |
| 354 | |
| 355 | C. Press mouse right button , then find and choose "IvIsee" to open it (rember to enable the "Always Use This Program to Open..." checkbox) |
| 356 | |
| 357 | |
| 358 | |
| 359 | *************************************************************************************************** |
| 360 | |
| 361 | |
| 362 | |
| 363 | |
| 364 | |
| 365 | |
| 366 | |
| 367 | |
| 368 | |
| 369 | *************************************************************************************************** |
| 370 | |
| 371 | |
| 372 | |
| 373 | =================================================================================================== |
| 374 | |
| 375 | <4>. Configuration Notes |
| 376 | |
| 377 | =================================================================================================== |
| 378 | |
| 379 | You can change all IvIsee initial statements via tune the parameters in "CONFIG/IvIsee.attr" manually : |
| 380 | |
| 381 | |
| 382 | |
| 383 | |
| 384 | |
| 385 | # [ IvI -- Attribute Define File ] |
| 386 | |
| 387 | # |
| 388 | |
| 389 | # << Hints & Notes >> |
| 390 | |
| 391 | # |
| 392 | |
| 393 | # 1. The "DataType" of every filed could be referenced in "[ IvI -- Attribute Config File ]" |
| 394 | |
| 395 | # |
| 396 | |
| 397 | # 2. "_" means "NULL" , also equals to "Empty Value" |
| 398 | |
| 399 | # |
| 400 | |
| 401 | # 3. "(Read Only)" means "I suggest you don't modify it anymore" |
| 402 | |
| 403 | # |
| 404 | |
| 405 | # 4. Bugs Report : "lsi@mail.nchc.gov.tw" |
| 406 | |
| 407 | |
| 408 | |
| 409 | |
| 410 | |
| 411 | # AttribConfFile : (Read Only) [ IvI -- Attribute Config File ] |
| 412 | |
| 413 | AttribConfFile CONFIG/attrib.conf |
| 414 | |
| 415 | |
| 416 | |
| 417 | # ACLConfFile : (Read Only) |
| 418 | |
| 419 | ACLConfFile _ |
| 420 | |
| 421 | |
| 422 | |
| 423 | # CMSConfFile : (Read Only) |
| 424 | |
| 425 | CMSConfFile _ |
| 426 | |
| 427 | |
| 428 | |
| 429 | # ModelFile : (Read Only) |
| 430 | |
| 431 | ModelFile _ |
| 432 | |
| 433 | |
| 434 | |
| 435 | # ImageFile : (Read Only) |
| 436 | |
| 437 | ImageFile _ |
| 438 | |
| 439 | |
| 440 | |
| 441 | # ViewPage : (Read Only) |
| 442 | |
| 443 | ViewPage _ |
| 444 | |
| 445 | |
| 446 | |
| 447 | # Operation : [_] , [New] , [Upload] , [Rendering] , |
| 448 | |
| 449 | # [Zoom] , [Rotate] , [Pan] , [Reset] , |
| 450 | |
| 451 | # [Wireframe] , [Surface] , [Hidden] , [NPR] (Now [NPR] not supported yet !!) , |
| 452 | |
| 453 | # [Non-Manifold] , [Feature] , [Boundary] , |
| 454 | |
| 455 | # [Mono] , [CrystalEyes] , [RedBlue] , [Interlaced] , [Dresden] , [LeftEye] , [RightEye] , |
| 456 | |
| 457 | # [Front] , [Back] , [Left] , [Right] , [Top] , [Bottom] , [Isometric] , |
| 458 | |
| 459 | # [Clean] , [Connectivity] , [Decimate] , [Normals] , [Smooth] , [Triangulate] |
| 460 | |
| 461 | #Operation New |
| 462 | |
| 463 | Operation New Zoom +20 |
| 464 | |
| 465 | |
| 466 | |
| 467 | # ModelName : (Read Only) |
| 468 | |
| 469 | ModelName _ |
| 470 | |
| 471 | |
| 472 | |
| 473 | # ModelType : [.g] , [.cgm] , [.iv] , [.obj] , [.rib] , [.stl] , [.tri] , [.vtk] , [.wrl] |
| 474 | |
| 475 | ModelType .vtk |
| 476 | |
| 477 | |
| 478 | |
| 479 | # ImageType : [.bmp] , [.tif] , [.tiff] , [.jpg] , [.jpe] , [.jpeg] |
| 480 | |
| 481 | ImageType .jpg |
| 482 | |
| 483 | |
| 484 | |
| 485 | # JPEGQuality : [0] ~ [100] |
| 486 | |
| 487 | JPEGQuality 100 |
| 488 | |
| 489 | |
| 490 | |
| 491 | # ImageInformation : (Read Only) |
| 492 | |
| 493 | ImageInformation _ |
| 494 | |
| 495 | |
| 496 | |
| 497 | # InterlacedReverse : [true] | [false] |
| 498 | |
| 499 | InterlacedReverse true |
| 500 | |
| 501 | |
| 502 | |
| 503 | # AcceptModelScalar : [true] | [false] |
| 504 | |
| 505 | AcceptModelScalar true |
| 506 | |
| 507 | |
| 508 | |
| 509 | # ======================================= VTK Attributes ======================================= # |
| 510 | |
| 511 | Mapper_ScalarRange 0 1 |
| 512 | |
| 513 | RenderWindow_Size 900 650 |
| 514 | |
| 515 | RenderWindow_Position 0 0 |
| 516 | |
| 517 | Property_BackGround _ _ _ |
| 518 | |
| 519 | Property_ForeGround _ _ _ |
| 520 | |
| 521 | Property_Ambient 0.400000 |
| 522 | |
| 523 | Property_Diffuse 0.800000 |
| 524 | |
| 525 | Property_Specular 0.500000 |
| 526 | |
| 527 | Property_SpecularPower 50.000000 |
| 528 | |
| 529 | Camera_Position 0 0 1 |
| 530 | |
| 531 | Camera_FocalPoint 0 0 0 |
| 532 | |
| 533 | Camera_ViewUp _ _ _ |
| 534 | |
| 535 | Camera_ClippingRange _ _ |
| 536 | |
| 537 | Camera_ViewAngle _ |
| 538 | |
| 539 | Camera_EyeAngle _ |
| 540 | |
| 541 | Camera_WindowCenter _ _ |
| 542 | |
| 543 | Camera_ParallelScale _ |
| 544 | |
| 545 | Camera_FocalDisk _ |
| 546 | |
| 547 | Camera_Thickness _ |
| 548 | |
| 549 | Camera_Distance _ |
| 550 | |
| 551 | Camera_ParallelProjection _ |
| 552 | |
| 553 | Camera_ViewPlaneNormal _ _ _ |
| 554 | |
| 555 | Camera_Roll _ |
| 556 | |
| 557 | # ======================================= VTK Attributes ======================================= # |
| 558 | |
| 559 | |
| 560 | |
| 561 | # Define_SmoothIteration : [N] >= [1] |
| 562 | |
| 563 | Define_SmoothIteration 50 |
| 564 | |
| 565 | |
| 566 | |
| 567 | # Define_Representation : [Wireframe] , [Surface] , [Hidden] , [NPR] (Now [NPR] not supported yet !!) |
| 568 | |
| 569 | Define_Representation Surface |
| 570 | |
| 571 | |
| 572 | |
| 573 | # Define_EdgesType : [Object] , [Non-Manifold] , [Feature] , [Boundary] |
| 574 | |
| 575 | Define_EdgesType Object |
| 576 | |
| 577 | |
| 578 | |
| 579 | # Define_StereoType : [Mono] , [CrystalEyes] , [RedBlue] , [Interlaced] , [Dresden] , [LeftEye] , [RightEye] |
| 580 | |
| 581 | Define_StereoType CrystalEyes |
| 582 | |
| 583 | |
| 584 | |
| 585 | # Define_MotionType : [Zoom] , [Rotate] , [Pan] |
| 586 | |
| 587 | Define_MotionType Zoom |
| 588 | |
| 589 | |
| 590 | |
| 591 | # Define_View Left : [Front] , [Back] , [Left] , [Right] , [Top] , [Bottom] , [Isometric] |
| 592 | |
| 593 | Define_View Left |
| 594 | |
| 595 | |
| 596 | |
| 597 | # Define_AdvanceProcess : [None] , [Clean] , [Connectivity] , [Decimate] , [Normals] , [Smooth] , [Triangulate] |
| 598 | |
| 599 | Define_AdvanceProcess None |
| 600 | |
| 601 | |
| 602 | |
| 603 | # Define_GraphicEngine : (Read Only) |
| 604 | |
| 605 | Define_GraphicEngine {vtk version 3.2.0} |
| 606 | |
| 607 | |
| 608 | |
| 609 | # Define_Information : (Read Only) |
| 610 | |
| 611 | Define_Information _ |
| 612 | |
| 613 | |
| 614 | |
| 615 | # Define_RenderingHost : (Read Only) |
| 616 | |
| 617 | Define_RenderingHost localhost |
| 618 | |
| 619 | |
| 620 | |
| 621 | # Define_RenderingPort : (Read Only) |
| 622 | |
| 623 | Define_RenderingPort 60000 |
| 624 | |
| 625 | |
| 626 | |
| 627 | # Define_SessionTimeOut : (Read Only) |
| 628 | |
| 629 | Define_SessionTimeOut 1440 |
| 630 | |
| 631 | |
| 632 | |
| 633 | *************************************************************************************************** |
| 634 | |
| 635 | |
| 636 | |
| 637 | |
| 638 | |
| 639 | |
| 640 | |
| 641 | |
| 642 | |
| 643 | *************************************************************************************************** |
| 644 | |
| 645 | |
| 646 | |
| 647 | =================================================================================================== |
| 648 | |
| 649 | <5>. Operation Notes |
| 650 | |
| 651 | =================================================================================================== |
| 652 | |
| 653 | Mouse and Keyboard Operation Scheme : |
| 654 | |
| 655 | |
| 656 | |
| 657 | (1) Mouse Operation : |
| 658 | |
| 659 | |
| 660 | |
| 661 | [Left-Button] => Rotate |
| 662 | |
| 663 | [Right-Button] => Zoom |
| 664 | |
| 665 | [Left-Button] + [Right-Button] => Pan |
| 666 | |
| 667 | [Shift] + [Left-Button] => Pan |
| 668 | |
| 669 | |
| 670 | |
| 671 | |
| 672 | |
| 673 | (2) Keyboard Operation : |
| 674 | |
| 675 | |
| 676 | |
| 677 | <Basic Functions> |
| 678 | |
| 679 | [0] => Stereo Off (Mono) |
| 680 | |
| 681 | [1] => Stereo On with "Crystal Eyes" |
| 682 | |
| 683 | [2] => Stereo On with "Red Blue" |
| 684 | |
| 685 | [3] => Stereo On with "Interlaced" |
| 686 | |
| 687 | [4] => Stereo On with "Dresden" |
| 688 | |
| 689 | [5] => Stereo On with "Left Eye" |
| 690 | |
| 691 | [6] => Stereo On with "Right Eye" |
| 692 | |
| 693 | [s] => Surface |
| 694 | |
| 695 | [w] => Wireframe |
| 696 | |
| 697 | [r] => Reset Camera |
| 698 | |
| 699 | [p] => Boundary Box |
| 700 | |
| 701 | [t] => Texture Mapping |
| 702 | |
| 703 | [u] => Snapshot Current Rendering Window into 2D Image (Support Deffierent Format) |
| 704 | |
| 705 | [c] => Dump Current Rendering Model into 3D Geometry Dataset (Support Deffierent Format) |
| 706 | |
| 707 | [q] => Quit |
| 708 | |
| 709 | [e] => Exit |
| 710 | |
| 711 | [ESC] => Reset All Attribute |
| 712 | |
| 713 | [TAB] => Switch the Camera View |
| 714 | |
| 715 | |
| 716 | |
| 717 | <Advanced Functions> |
| 718 | |
| 719 | [BackSpace] => Smooth |
| 720 | |
| 721 | [7] => Turn On/Off for "Boundary Edge" |
| 722 | |
| 723 | [8] => Turn On/Off for "Feature Edge" |
| 724 | |
| 725 | [9] => Turn On/Off for "Hidden Geometry" |
| 726 | |
| 727 | [F1] => Background Down |
| 728 | |
| 729 | [F2] => Background Up |
| 730 | |
| 731 | [F3] => Foreground Down |
| 732 | |
| 733 | [F4] => Foreground Up |
| 734 | |
| 735 | [F5] => Ambient Down |
| 736 | |
| 737 | [F6] => Ambient Up |
| 738 | |
| 739 | [F7] => Diffuse Down |
| 740 | |
| 741 | [F8] => Diffuse Up |
| 742 | |
| 743 | [F9] => Specular Down |
| 744 | |
| 745 | [F10] => Specular Up |
| 746 | |
| 747 | [F11] => SpecularPower Down |
| 748 | |
| 749 | [F12] => SpecularPower Up |
| 750 | |
| 751 | [+] => Constrast Up |
| 752 | |
| 753 | [-] => Constrast Down |
| 754 | |
| 755 | [PgUp] => Brightness Up |
| 756 | |
| 757 | [PgDn] => Brightness Down |
| 758 | |
| 759 | [Home] => Reset Image Color |
| 760 | |
| 761 | [End] => Reverse Image Color |
| 762 | |
| 763 | [Up] => Move Camera to Up |
| 764 | |
| 765 | [Down] => Move Camera to Down |
| 766 | |
| 767 | [Left] => Move Camera to Left |
| 768 | |
| 769 | [Right] => Move Camera to Right |
| 770 | |
| 771 | [Insert] => Start the "Timeout Callback" function manully |
| 772 | |
| 773 | [Delete] => Stop the "Timeout Callback" function manully |
| 774 | |
| 775 | |
| 776 | |
| 777 | *************************************************************************************************** |
| 778 | |
| 779 | |
| 780 | |
| 781 | |
| 782 | |
| 783 | |