SoScaleVizART Class Reference
[ScaleViz]
ScaleViz based Automatic Replay Tool
More...
#include <ScaleViz/SoScaleVizART.h>
Static Public Member Functions | |
| static void | setTestName (const SbString &) |
| static SbString | getTestName () |
| static void | setOutputDir (const SbString &) |
| static SbString | getOutputDir () |
| static void | setOverride (bool) |
| static bool | getOverride () |
| static bool | start () |
| static void | stop () |
| static void | saveSnapshotSceneGraph (SoSceneManager *sceneManager) |
| static void | saveSnapshotImage (SoSceneManager *sceneManager) |
| static bool | isRunning () |
Detailed Description
ScaleViz based Automatic Replay Tool
This class allows user to register a ScaleViz ART scenario. A ART scenario is a set of scene commands, enhanced with snapshot capability. Generated ScaleVizART scenario can be replayed using the ART application.
Member Function Documentation
| static SbString SoScaleVizART::getOutputDir | ( | ) | [static] |
Gets the current directory where ART files are generated.
| static bool SoScaleVizART::getOverride | ( | ) | [static] |
Returns TRUE if existing ART file with same name can be overridden.
| static SbString SoScaleVizART::getTestName | ( | ) | [static] |
Gets the current defined base name for generated ART files.
| static bool SoScaleVizART::isRunning | ( | ) | [static] |
Returns TRUE if ART is currently running.
| static void SoScaleVizART::saveSnapshotImage | ( | SoSceneManager * | sceneManager | ) | [static] |
Save a scene rendering snapshot image.
This generates output an PNG image file which filename is on the form [name]_snapshot[N].png Where:
- [name] is the current ART test name
- [N] is an automatic increment generated by ART.
| static void SoScaleVizART::saveSnapshotSceneGraph | ( | SoSceneManager * | sceneManager | ) | [static] |
Save a scene graph snapshot.
This generates an Open Inventor ASCII formatted file which filename is on the form [name]_[N].iv Where:
- [name] is the current ART test name
- [N] is an automatic increment generated by ART.
| static void SoScaleVizART::setOutputDir | ( | const SbString & | ) | [static] |
Sets the directory where to the ART files will be generated.
If defined directory does not exist, it will be created. Must be called before calling start();
| static void SoScaleVizART::setOverride | ( | bool | ) | [static] |
Defines whether existing ART files with same names must be overridden or not.
Default is false: An existing file is not overridden.
| static void SoScaleVizART::setTestName | ( | const SbString & | ) | [static] |
Sets the base name for generated ART files.
Must be called before calling start();
| static bool SoScaleVizART::start | ( | ) | [static] |
Start a ART registering session.
Returns false if a new session failed to launch.
| static void SoScaleVizART::stop | ( | ) | [static] |
Stops the currently running ART session.
The documentation for this class was generated from the following file:
- ScaleViz/SoScaleVizART.h