osmwp.github.com/development_node_TimeSensor.html at master · osmwp/osmwp.github.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<title>Mobile Widgets</title>
	<link rel="stylesheet" href="style/style.css" />
	<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon" />
	<script type="text/javascript" src="js/StructureElts.js"></script>
	<script type="text/javascript" src="js/Structure.js"></script>
	<script type="text/javascript" src="js/DocElements.js"></script>
</head>

<body>

<script type="text/javascript">
<!--
idCurrentPage = "development_node_TimeSensor";
beginPage();
//-->
</script>


<h1 class="title">TimeSensor node</h1>

<script type="text/javascript">
<!--
addIndex();
//-->
</script>


<script type="text/javascript">addTitle("Interface", 1);</script>

<textarea wrap="off" readonly="readonly" rows="10" cols="80">
TimeSensor {
    SFTime  startTime 0
    SFTime  stopTime 0
    SFBool  loop FALSE
    SFTime  cycleInterval 1
    SFFloat fraction_changed 0
    SFBool  isActive FALSE
    SFTime  cycleTime 0
}
</textarea>
<br/>

<script type="text/javascript">addTitle("Description", 1);</script>

<p>
Generates periodic values. Basis of most animations. Should work exactly as
defined in VRML.
</p>
<br/>

<script type="text/javascript">addTitle("Fields", 1);</script>

<p>
<b>SFTime  startTime 0</b> :<br/>
Time to start the timer (in second since application start).
</p>
<p>
<b>SFTime  stopTime 0</b> :<br/>
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).
</p>
<p>
<b>SFBool  loop FALSE</b> :<br/>
If loop is <b>TRUE</b>, it will restart timer when it
</p>
<p>
<b>SFTime  cycleInterval 1</b> :<br/>
Duration of the timer (in second).
</p>
<p>
<b>SFFloat fraction_changed 0</b> :<br/>
This field will generate linear values from 0 to 1.
</p>
<p>
<b>SFBool  isActive FALSE</b> :<br/>
Set to TRUE when timer is active (<b>startTime != 0</b> and <b>startTime &lt; stopTime</b>),
else FALSE (except when <b>loop</b> is activated).
</p>
<p>
<b>SFTime  cycleTime 0</b> :<br/>
Called when timer is stopped or on each end of loop (every cycleInterval
interval in second).
</p>
<br/>

<script type="text/javascript">addTitle("Example", 1);</script>
<p>
Example display a progress bar and close the widget after 5 seconds.<br/>
</p>
<textarea wrap="off" readonly="readonly" rows="15" cols="80">
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
    ]
}
</textarea>
<br/>


<script type="text/javascript">
<!--
	addBackPageNavigator('widgets_development_nodes_ref', '');
//-->
</script>


<script type="text/javascript">
<!--
endPage();
//-->
</script>

</body>

</html>