Appendix 1: Sequence and Figure Related Vuforia Studio Events

Event Name

(evt.name)

Description

Arguments and Usage Notes

Example

newStep

Triggered by going to a new step in an animation sequence.

arg1 (text) of the following form:

(<step#>/<total steps>) <step name>

For example: (4/8) Step 4 -remove case

$scope.$on('newStep', function(evt, arg) { $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name + " arg: " + arg ;});

playstarted

Triggered by play or play all of an animation sequence.

No arguments returned

$scope.$on('playstarted', function(evt, arg) { $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name;});

stepstarted

Similar to playstarted but with more flexible argument data returned.

arg1 is model name (e.g. "model-1")

arg2 is the type of object (twx-dt-model)

arg3 is a JSON object containing: stepName, duration (in ms), acknowledge (boolean), totalSteps (integer), nextStep (integer).

In the Preview in Vuforia Studio 8.3.2, stepDescription (the notes from the step in Creo Illustrate) and acknowledgeMessage now appear. However these two fields are not yet exposed for use in Vuforia View.

$scope.$on('stepstarted', function(evt, arg, arg2, arg3) { var parsedArg3 = JSON.parse(arg3); $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name + " arg: " + arg + " arg2: " + arg2 + " arg3 fields: " + parsedArg3.stepName + " " + parsedArg3.duration + " " + parsedArg3.totalSteps ;});

playstopped

Triggered by stop of an animation sequence.

arg1 (object) contains: stepName, duration (in ms), acknowledge (boolean), acknowledgeMessage, totalSteps (int), nextStep (int)

$scope.$on('playstopped', function(evt, arg) { $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name + " arg: " + arg.stepName ;});

stepcompleted

Similar to playstarted but with more flexible argument data returned.

See stepstarted

Same as stepstarted except with event name of stepcompleted.

sequenceloaded

Triggered by sequence loading (when a model with a sequence is loaded, or the sequence property is updated for a model).

arg1 "model-1"

arg2 is the type of object (twx-dt-model)

arg3 is the model's current 'sequence' property (for example, app/resources/Uploaded/mypvzfile/mysequence-name.pvi)

$scope.$on('sequenceloaded', function(evt, arg, arg2, arg3) { $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name + " arg: " + arg + " arg2: " + arg2 + " arg3: " + arg3 ;});

sequenceacknowledge

Triggered by a figure/sequence that was defined in Creo Illustrate as having an acknowledgement.

See playstopped

Same as playstopped except with event name of sequenceacknowledge.

sequencereset

Triggered by the model ‘reset’ (of the sequence/figure) event.

arg1 is model name (for example, “model-1”)

arg2 is the type of object (twx-dt-model)

$scope.$on('sequencereset', function(evt, arg, arg2) { $scope.view.wdg['label-1']['text'] = $scope.view.wdg['label-1']['text'] + " evt: " + evt.name + " arg1: " + arg + " arg2: " + arg2;});