TimeSensor node

TimeSensor {
    SFTime  startTime 0
    SFTime  stopTime 0
    SFBool  loop FALSE
    SFTime  cycleInterval 1
    SFFloat fraction_changed 0
    SFBool  isActive FALSE
    SFTime  cycleTime 0
}

Generates periodic values. Basis of most animations. Should work exactly as defined in VRML.

SFTime startTime 0 :
Time to start the timer (in second since application start).

SFTime stopTime 0 :
Time to stop the timer, ignored if set below startTime. Timer can be restarted at any time by setting startTime and stopTime at the same values (in second since application start).

SFBool loop FALSE :
If loop is TRUE, it will restart timer when it

SFTime cycleInterval 1 :
Duration of the timer (in second).

SFFloat fraction_changed 0 :
This field will generate linear values from 0 to 1.

SFBool isActive FALSE :
Set to TRUE when timer is active (startTime != 0 and startTime < stopTime), else FALSE (except when loop is activated).

SFTime cycleTime 0 :
Called when timer is stopped or on each end of loop (every cycleInterval interval in second).

Example display a progress bar and close the widget after 5 seconds.

Group {
    children [
        # Time sensor (timer cycle : 5 seconds)
        DEF TIMER_HIDE TimeSensor { cycleInterval 5 }

        # Script
        DEF SCRIPT Script {
            # Event to move progress bar
            eventIn SFFloat moveProgressBar
            # Event to close widget when at the end of time
            eventIn SFTime close

            field SFNode TIMER_HIDE USE TIMER_HIDE
            url "
            // Widget initialization
            function initialize (now) {
              // Initialize widget
              Browser.sendMessage ('Board', 'INIT', 'My Widget', '', 'Quit');
              // Display popup
              Browser.sendMessage ('Board', 'POPUP', 'Progress popup', 'Progression', '', '');
              // Launch timer
              // - Define start time
              TIMER_HIDE.startTime = now;
            }

            //Close widget function
            function close() {
              //Close popup
              Browser.sendMessage ('Board', 'POPUP_AUTO_HIDE');
              //Close widget
              Browser.sendMessage ('Board', 'RESET');
            }

            //Move progress bar function
            function moveProgressBar() {
              //Move progress bar
              //Convert timer progression value (between 0 and 1) to progress bar value (between 0 and 100)
              var pos = (moveProgressBar * 100);
              Browser.sendMessage ('Board', 'PROGRESS', pos);
            }
            "
        }

        # Link SensorTime and Javascript functions
        # - fraction_changed return SFFloat value between 0 and 1
        ROUTE TIMER_HIDE.fraction_changed to SCRIPT.moveProgressBar
        # - cycleTime event is launch at the end of cycle
        ROUTE TIMER_HIDE.cycleTime TO SCRIPT.close
    ]
}