Changeset 1844

Show
Ignore:
Timestamp:
04/09/03 13:44:32 (15 years ago)
Author:
robert
Message:

Added desciptions to all the demos.

Location:
OpenSceneGraph/trunk/examples
Files:
35 modified

Legend:

Unmodified
Added
Removed
  • OpenSceneGraph/trunk/examples/osganimate/osganimate.cpp

    r1832 r1844  
    194194 
    195195    // set up the usage document, in case we need to print out how to use this program. 
     196    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of osg::AnimationPath and UpdateCallbacks for adding animation to your scenes."); 
    196197    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    197198    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgbillboard/osgbillboard.cpp

    r1832 r1844  
    169169 
    170170    // set up the usage document, in case we need to print out how to use this program. 
     171    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use billboard nodes."); 
    171172    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    172173    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgcallback/osgcallback.cpp

    r1832 r1844  
    133133 
    134134    // set up the usage document, in case we need to print out how to use this program. 
     135    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of the range of different types of callbacks supported in the OpenSceneGraph."); 
    135136    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    136137    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgclip/osgclip.cpp

    r1832 r1844  
    132132 
    133133    // set up the usage document, in case we need to print out how to use this program. 
     134    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use multi-pass and osg::ClipNode to clip parts of the scene away.."); 
    134135    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    135136    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgcluster/osgcluster.cpp

    r1832 r1844  
    100100     
    101101    // set up the usage document, in case we need to print out how to use this program. 
     102    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to approach implementation of clustering. Note, cluster support will soon be encompassed in Producer itself."); 
    102103    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    103104    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgcopy/osgcopy.cpp

    r1832 r1844  
    134134 
    135135    // set up the usage document, in case we need to print out how to use this program. 
     136    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of deep vs shallow vs custom copying of scene graphs."); 
    136137    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    137138    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgcubemap/osgcubemap.cpp

    r1832 r1844  
    7575 
    7676    // set up the usage document, in case we need to print out how to use this program. 
     77    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use texture cube mapping."); 
    7778    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    7879    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osggeodemo/osggeodemo.cpp

    r1834 r1844  
    9090 
    9191    // set up the usage document, in case we need to print out how to use this program. 
     92    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example of how to control animation in Geo files."); 
    9293    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    9394    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osggeometry/osggeometry.cpp

    r1832 r1844  
    647647 
    648648    // set up the usage document, in case we need to print out how to use this program. 
     649    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to create osg::Geometry."); 
    649650    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    650651    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osghangglide/osghangglide.cpp

    r1832 r1844  
    109109 
    110110    // set up the usage document, in case we need to print out how to use this program. 
     111    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to create a scene programatically, in this case a hang gliding flying site."); 
    111112    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    112113    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osghud/osghud.cpp

    r1832 r1844  
    118118     
    119119    // set up the usage document, in case we need to print out how to use this program. 
     120    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to do Head Up Displays."); 
    120121    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] [filename] ..."); 
    121122    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgimpostor/osgimpostor.cpp

    r1832 r1844  
    220220 
    221221    // set up the usage document, in case we need to print out how to use this program. 
     222    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use impostors - hierachical image cache."); 
    222223    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    223224    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgkeyboard/osgkeyboard.cpp

    r1832 r1844  
    382382 
    383383    // set up the usage document, in case we need to print out how to use this program. 
     384    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of handling keyboard events and text."); 
    384385    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    385386    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osglight/osglight.cpp

    r1832 r1844  
    304304 
    305305    // set up the usage document, in case we need to print out how to use this program. 
     306    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of OpenGL vertex lighting."); 
    306307    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    307308    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osglightpoint/osglightpoint.cpp

    r1832 r1844  
    116116 
    117117    // set up the usage document, in case we need to print out how to use this program. 
     118    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use high quality light point, typically used for naviagional lights."); 
    118119    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    119120    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osglogo/osglogo.cpp

    r1832 r1844  
    408408 
    409409    // set up the usage document, in case we need to print out how to use this program. 
     410    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates both text, animation and billboard via custom transform to create the OpenSceneGraph logo.."); 
    410411    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    411412    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgmultitexture/osgmultitexture.cpp

    r1832 r1844  
    2323 
    2424    // set up the usage document, in case we need to print out how to use this program. 
     25    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates a simple use of multi-texturing."); 
    2526    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    2627    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgoccluder/osgoccluder.cpp

    r1839 r1844  
    284284 
    285285    // set up the usage document, in case we need to print out how to use this program. 
     286    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of convex planer occluders."); 
    286287    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    287288    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgparticle/osgparticle.cpp

    r1832 r1844  
    349349     
    350350    // set up the usage document, in case we need to print out how to use this program. 
     351    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of particle systems."); 
    351352    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] image_file_left_eye image_file_right_eye"); 
    352353    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgpbuffer/osgpbuffer.cpp

    r1832 r1844  
    586586     
    587587    // set up the usage document, in case we need to print out how to use this program. 
     588    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use pbuffers and render to texture.."); 
    588589    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    589590    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgprerender/osgprerender.cpp

    r1832 r1844  
    370370 
    371371    // set up the usage document, in case we need to print out how to use this program. 
     372    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates pre rendering of scene to a texture, and then apply this texture to geometry."); 
    372373    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    373374    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgreflect/osgreflect.cpp

    r1832 r1844  
    326326     
    327327    // set up the usage document, in case we need to print out how to use this program. 
     328    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates the use multi-pass rendering, stencil buffer to create a planer reflection effect."); 
    328329    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    329330    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgscribe/osgscribe.cpp

    r1832 r1844  
    2121 
    2222    // set up the usage document, in case we need to print out how to use this program. 
     23    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to use multi-pass and state inheritance to create a scribed rendered effect."); 
    2324    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    2425    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgsequence/osgsequence.cpp

    r1832 r1844  
    9797 
    9898    // set up the usage document, in case we need to print out how to use this program. 
     99    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of osg::Sequence."); 
    99100    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    100101    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgshadowtexture/osgshadowtexture.cpp

    r1832 r1844  
    172172 
    173173    // set up the usage document, in case we need to print out how to use this program. 
     174    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of pre rendering to texture to create a shadow effect.."); 
    174175    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    175176    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgshape/osgshape.cpp

    r1832 r1844  
    8787 
    8888    // set up the usage document, in case we need to print out how to use this program. 
     89    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates the osg::Shape classes."); 
    8990    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    9091    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgstereoimage/osgstereoimage.cpp

    r1832 r1844  
    396396     
    397397    // set up the usage document, in case we need to print out how to use this program. 
     398    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use node masks to create stereo images."); 
    398399    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] image_file_left_eye image_file_right_eye"); 
    399400    arguments.getApplicationUsage()->addCommandLineOption("-d <float>","Time delay in sceonds between the display of successive image pairs when in auto advance mode."); 
  • OpenSceneGraph/trunk/examples/osgteapot/osgteapot.cpp

    r1832 r1844  
    320320 
    321321    // set up the usage document, in case we need to print out how to use this program. 
     322    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates how to encpsulate OpenGL rendering code via sublcassing of osg::Drawable.."); 
    322323    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    323324    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgtext/osgtext.cpp

    r1832 r1844  
    431431     
    432432    // set up the usage document, in case we need to print out how to use this program. 
     433    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of text."); 
    433434    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] [filename] ..."); 
    434435    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgtexture1D/osgtexture1D.cpp

    r1832 r1844  
    145145 
    146146    // set up the usage document, in case we need to print out how to use this program. 
     147    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of 1D textures."); 
    147148    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    148149    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgtexture2D/osgtexture2D.cpp

    r1832 r1844  
    688688 
    689689    // set up the usage document, in case we need to print out how to use this program. 
     690    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of 2D textures."); 
    690691    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    691692    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgtexture3D/osgtexture3D.cpp

    r1832 r1844  
    219219     
    220220    // set up the usage document, in case we need to print out how to use this program. 
     221    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrates use of 3D textures."); 
    221222    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    222223    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgunittests/osgunittests.cpp

    r1815 r1844  
    88 
    99    // set up the usage document, in case we need to print out how to use this program. 
     10    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which runs units tests."); 
    1011    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options]"); 
    1112    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgvertexprogram/osgvertexprogram.cpp

    r1832 r1844  
    346346 
    347347    // set up the usage document, in case we need to print out how to use this program. 
     348    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrate support for ARB_vertex_program."); 
    348349    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    349350    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information"); 
  • OpenSceneGraph/trunk/examples/osgwindows/osgwindows.cpp

    r1837 r1844  
    5454    // set up the usage document, in case we need to print out how to use this program. 
    5555    arguments.getApplicationUsage()->setApplicationName(arguments.getApplicationName()); 
    56     arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the standard OpenSceneGraph example which loads and visualises 3d models."); 
     56    arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the example which demonstrate hows to set up programitically a Producer::CameraConfig and use it to set up multiple window views."); 
    5757    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] filename ..."); 
    5858    arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information");