ScriptRunner.ScriptRunnerBase Class Reference
#include
<class_script_runner_1_1_script_runner_base.h>
Public Member Functions |
|
| __init__ () | |
| getDeviceAverageMemoryUsage () | |
| getDevicePeakMemoryUsage () | |
| getSystemAverageMemoryUsage () | |
| getSystemPeakMemoryUsage () | |
| debugOutput () | |
| setTimerPaused () | |
| setStatus () | |
| getName () | |
| Returns the test suite's name. |
|
| suiteSetUp () | |
| suiteTearDown () | |
| getTempDirectory_ () | |
| Returns a temporary directory for the use of
this test suite; creates it if necessary. |
|
| removeTempDirectory_ () | |
| Deletes the temporary directory used by this
test suite. |
|
| onNodeBoundingBoxValid () | |
| NodeBoundingBoxListener callback set on the
model root. |
|
| sendMessageSync () | |
| Sends the message to the application and
pause execution until wake conditions are passed or a timeout
occurs. |
|
| wakeUp () | |
| Wake up the thread and continue. |
|
| terminate () | |
| Wake up the thread and terminate it.
|
|
| isCancelled () | |
| sendMessage_ () | |
| assert_ () | |
| setQuitOnComplete () | |
| isQuitOnComplete () | |
| setQuietMode () | |
| getScriptName () | |
| name () | |
| setDocument () | |
| getDocument () | |
| document () | |
| getDisplay () | |
| setLocatorsRoot () | |
| getLocatorsRoot () | |
| getNavigator () | |
| getViewPosition () | |
| getViewLookAt () | |
| getViewCOI () | |
| setIsHudVisible () | |
| isHudVisible () | |
| setIsViewCubeVisible () | |
| isViewCubeVisible () | |
| setOverrideAOType () | |
| isOverrideAOType () | |
| status () | |
| statusMessage () | |
| endDispatchMessage () | |
| run () | |
| Run the test that was registered with this
thread. |
|
| setUp () | |
| tearDown () | |
| runMethod () | |
| Run a method of a given name. |
|
| switchToEnvironment_ () | |
| Switches to the environment with the given
id. |
|
| closeScene_ () | |
| Close the current scene. |
|
| assignMaterial_ () | |
| Assigns the library material with the given
name to the nodes with the given ids. |
|
| goToView_ () | |
| This method moves the camera to one of the
View Cube's views. |
|
| setView_ () | |
| Adjusts the view so that the camera is at
the given position, pointed at given look at point. |
|
| fitToView_ () | |
| Fits to view. |
|
| selectAll_ () | |
| selectNone_ () | |
| getSelected_ () | |
| setIdleDraw_ () | |
| duplicateAll_ () | |
| duplicate_ () | |
| Duplicates the nodes corresponding to the
given node ids. |
|
| getAverageFrameRate_ () | |
| Returns the average frame rate over the
desired number of frames. |
|
| groupNodes_ () | |
| Groups the given node ids and returns the
new group node's id or None if the group operation failed. |
|
| loadScene_ () | |
| Loads the scene from file. |
|
| lockLods_ () | |
| createScene_ () | |
| Creates a scene starting in the given
environment, containing the given models. |
|
| importModels_ () | |
| Loads models from the given files. |
|
| prepareModels_ () | |
| Calls the message "MODEL_PREPARE" with the
proper parameters ("modelFilenames",The name of the model files to
be prepared) and "journalFile", The name of the journal file
containing tessellation settings).It will collect the leafNodes
from the prepared models and will be stored in a list. |
|
| ProcessRayTracing_ () | |
| waitForRayTracingDone_ () | |
| Wait for ray tracing process to be done
within maxWaitTime. |
|
Public Attributes |
|
| string | kUserConditionsParameter = "userConditions" |
| string | kUserTimeoutParameter = "userTimeout" |
| string | kInitialEnvironmentId = "PhotoStudio\\PhotoStudio.a3e" |
| myTimeoutNotifier | |
| myDisableTimeoutNotifier | |
| kLoadModelsTime | |
Member Function Documentation
| ScriptRunner.ScriptRunnerBase.__init__ | ( | ) |
Reimplemented in ScriptRunner.ScriptRunner.
| ScriptRunner.ScriptRunnerBase.getDeviceAverageMemoryUsage | ( | ) |
| ScriptRunner.ScriptRunnerBase.getDevicePeakMemoryUsage | ( | ) |
| ScriptRunner.ScriptRunnerBase.getSystemAverageMemoryUsage | ( | ) |
| ScriptRunner.ScriptRunnerBase.getSystemPeakMemoryUsage | ( | ) |
| ScriptRunner.ScriptRunnerBase.debugOutput | ( | ) |
| ScriptRunner.ScriptRunnerBase.setTimerPaused | ( | ) |
| ScriptRunner.ScriptRunnerBase.setStatus | ( | ) |
| ScriptRunner.ScriptRunnerBase.getName | ( | ) |
Returns the test suite's name.
If not overriden in the derived class, returns the name of the class.
| ScriptRunner.ScriptRunnerBase.suiteSetUp | ( | ) |
| ScriptRunner.ScriptRunnerBase.suiteTearDown | ( | ) |
| ScriptRunner.ScriptRunnerBase.getTempDirectory_ | ( | ) |
Returns a temporary directory for the use of this test suite; creates it if necessary.
| ScriptRunner.ScriptRunnerBase.removeTempDirectory_ | ( | ) |
Deletes the temporary directory used by this test suite.
| ScriptRunner.ScriptRunnerBase.onNodeBoundingBoxValid | ( | ) |
NodeBoundingBoxListener callback set on the model root.
When its bounding box becomes valid, send an informational message used as a wait condition by some of the messages in the ResponseMessageRegistry.
| ScriptRunner.ScriptRunnerBase.sendMessageSync | ( | ) |
Sends the message to the application and pause execution until wake conditions are passed or a timeout occurs.
The user may provide kUserTimeoutParameter and kUserConditionsParameter arguments. See the ResponseMessageRegistry's documentation for how to specify these.
| ScriptRunner.ScriptRunnerBase.wakeUp | ( | ) |
Wake up the thread and continue.
| ScriptRunner.ScriptRunnerBase.terminate | ( | ) |
Wake up the thread and terminate it.
| ScriptRunner.ScriptRunnerBase.isCancelled | ( | ) |
| ScriptRunner.ScriptRunnerBase.sendMessage_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.assert_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.setQuitOnComplete | ( | ) |
| ScriptRunner.ScriptRunnerBase.isQuitOnComplete | ( | ) |
| ScriptRunner.ScriptRunnerBase.setQuietMode | ( | ) |
| ScriptRunner.ScriptRunnerBase.getScriptName | ( | ) |
| ScriptRunner.ScriptRunnerBase.name | ( | ) |
| ScriptRunner.ScriptRunnerBase.setDocument | ( | ) |
| ScriptRunner.ScriptRunnerBase.getDocument | ( | ) |
| ScriptRunner.ScriptRunnerBase.document | ( | ) |
| ScriptRunner.ScriptRunnerBase.getDisplay | ( | ) |
| ScriptRunner.ScriptRunnerBase.setLocatorsRoot | ( | ) |
| ScriptRunner.ScriptRunnerBase.getLocatorsRoot | ( | ) |
| ScriptRunner.ScriptRunnerBase.getNavigator | ( | ) |
| ScriptRunner.ScriptRunnerBase.getViewPosition | ( | ) |
| ScriptRunner.ScriptRunnerBase.getViewLookAt | ( | ) |
| ScriptRunner.ScriptRunnerBase.getViewCOI | ( | ) |
| ScriptRunner.ScriptRunnerBase.setIsHudVisible | ( | ) |
| ScriptRunner.ScriptRunnerBase.isHudVisible | ( | ) |
| ScriptRunner.ScriptRunnerBase.setIsViewCubeVisible | ( | ) |
| ScriptRunner.ScriptRunnerBase.isViewCubeVisible | ( | ) |
| ScriptRunner.ScriptRunnerBase.setOverrideAOType | ( | ) |
| ScriptRunner.ScriptRunnerBase.isOverrideAOType | ( | ) |
| ScriptRunner.ScriptRunnerBase.status | ( | ) |
| ScriptRunner.ScriptRunnerBase.statusMessage | ( | ) |
| ScriptRunner.ScriptRunnerBase.endDispatchMessage | ( | ) |
| ScriptRunner.ScriptRunnerBase.run | ( | ) |
Run the test that was registered with this thread.
| ScriptRunner.ScriptRunnerBase.setUp | ( | ) |
| ScriptRunner.ScriptRunnerBase.tearDown | ( | ) |
| ScriptRunner.ScriptRunnerBase.runMethod | ( | ) |
Run a method of a given name.
setUp and tearDown will get called before and after the method is called.
NOTE: If you override this method, the last message that is executed should always be 'SCRIPT_ENDED' to mark the end of the test, unless quitOnComplete is specified, in which case 'SCRIPT_ENDED' should be immediatelly followed by 'QUIT'.
| ScriptRunner.ScriptRunnerBase.switchToEnvironment_ | ( | ) |
Switches to the environment with the given id.
If loadIfNecessary is True (the default), then this also loads the environment if it's not already in the scene.
| ScriptRunner.ScriptRunnerBase.closeScene_ | ( | ) |
Close the current scene.
| ScriptRunner.ScriptRunnerBase.assignMaterial_ | ( | ) |
Assigns the library material with the given name to the nodes with the given ids.
| ScriptRunner.ScriptRunnerBase.goToView_ | ( | ) |
This method moves the camera to one of the View Cube's views.
Valid views are 'Left', 'Right', 'Front', 'Back', 'Bottom', 'Top' as well as the sides and corners of the View Cube
| ScriptRunner.ScriptRunnerBase.setView_ | ( | ) |
Adjusts the view so that the camera is at the given position, pointed at given look at point.
| ScriptRunner.ScriptRunnerBase.fitToView_ | ( | ) |
Fits to view.
| ScriptRunner.ScriptRunnerBase.selectAll_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.selectNone_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.getSelected_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.setIdleDraw_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.duplicateAll_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.duplicate_ | ( | ) |
Duplicates the nodes corresponding to the given node ids.
Returns the ids of duplicates. If deselect is True, then the duplicates are deselected.
| ScriptRunner.ScriptRunnerBase.getAverageFrameRate_ | ( | ) |
Returns the average frame rate over the desired number of frames.
| ScriptRunner.ScriptRunnerBase.groupNodes_ | ( | ) |
Groups the given node ids and returns the new group node's id or None if the group operation failed.
If ascend is True (the default), it will group the highest equivalent node instead (ie. the highest node on the path to the root that has no siblings).
| ScriptRunner.ScriptRunnerBase.loadScene_ | ( | ) |
Loads the scene from file.
If fitToView is True, then the models are automatically centred in the view.
If lockLods is True (the default), then the lods are locked to the lodQuality value (whose default is 100). If it is False, then automatic lod adjustment based on framerate is done.
Reimplemented in ScriptRunner.ScriptRunner.
| ScriptRunner.ScriptRunnerBase.lockLods_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.createScene_ | ( | ) |
Creates a scene starting in the given environment, containing the given models.
Note, no models will be placed on the selection list.
If repositionFloor is True (the default), then the floor is automatically repositioned based on the models.
If fitToView is True (the default), then the models are automatically centred in the view.
If lockLods is True (the default), then the lods are locked to the lodQuality value (whose default is 100). If it is False, then automatic lod adjustment based on framerate is done.
Returns the leaf ids of the models, in the format: ( leafIds1, leafIds2, ..., leafIdsN ) where the n-th entry is a tuple consisting of the leaf ids of the n-th model (in the same order given in the modelFilenames argument).
| ScriptRunner.ScriptRunnerBase.importModels_ | ( | ) |
Loads models from the given files.
Returns the leaf ids of the models, in the format: ( leafIds1, leafIds2, ..., leafIdsN ) where the n-th entry is a tuple consisting of the leaf ids of the n-th model (in the same order given in the modelFilenames argument).
| ScriptRunner.ScriptRunnerBase.prepareModels_ | ( | ) |
Calls the message "MODEL_PREPARE" with the proper parameters ("modelFilenames",The name of the model files to be prepared) and "journalFile", The name of the journal file containing tessellation settings).It will collect the leafNodes from the prepared models and will be stored in a list.
It returns the list in a tuple with the format: ( leafIds1, leafIds2, ..., leafIdsN ) where the n-th entry is a tuple consisting of the leaf ids of the n-th model (in the same order given in the modelFilenames argument).
| ScriptRunner.ScriptRunnerBase.ProcessRayTracing_ | ( | ) |
| ScriptRunner.ScriptRunnerBase.waitForRayTracingDone_ | ( | ) |
Wait for ray tracing process to be done within maxWaitTime.
Ray tracing is considered done when reaching the targetRenderLevel
Member Data Documentation
| string ScriptRunner.ScriptRunnerBase.kUserConditionsParameter = "userConditions" |
| string ScriptRunner.ScriptRunnerBase.kUserTimeoutParameter = "userTimeout" |
| string ScriptRunner.ScriptRunnerBase.kInitialEnvironmentId = "PhotoStudio\\PhotoStudio.a3e" |
Reimplemented in ScriptRunner.ScriptRunner.
