TimeSensor
Overview
TimeSensor continuously generates events as time passes. Typical use: ROUTE thisTimeSensorDEF.fraction_changed TO someInterpolatorDEF.set_fraction. Interchange profile
The TimeSensor node belongs to the Time component and requires at least support level 1, its default container field is children. It is available since VRML 2.0 and from X3D version 3.0 or higher.
Hierarchy
1
2
3
4
+ X3DNode
+ X3DChildNode
+ X3DTimeDependentNode
+ TimeSensor (X3DSensorNode)*
* Derived from multiple interfaces.
Fields
| Type | Access Type | Name | Default Value |
|---|---|---|---|
| SFNode | [in, out] | metadata | NULL |
| SFString | [in, out] | description | ”” |
| SFBool | [in, out] | enabled | TRUE |
| SFTime | [in, out] | cycleInterval | 1 |
| SFBool | [in, out] | loop | FALSE |
| SFTime | [in, out] | startTime | 0 |
| SFTime | [in, out] | resumeTime | 0 |
| SFTime | [in, out] | pauseTime | 0 |
| SFTime | [in, out] | stopTime | 0 |
| SFBool | [out] | isPaused | |
| SFBool | [out] | isActive | |
| SFTime | [out] | cycleTime | |
| SFTime | [out] | elapsedTime | |
| SFFloat | [out] | fraction_changed | |
| SFTime | [out] | time |
SFNode [in, out] metadata NULL [X3DMetadataObject]
Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
Hint
SFString [in, out] description “”
Author-provided prose that describes intended purpose of this node.
Hint
- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for “ quotation-mark character).
SFBool [in, out] enabled TRUE
Enables/disables node operation.
SFTime [in, out] cycleInterval 1 (0,∞)
cycleInterval is loop duration in seconds. Interchange profile
Hints
- TimeSensor may be ignored if cycleInterval < 0.01 second.
- cycleInterval is a nonnegative SFTime duration interval, not an absolute clock time.
Warning
- An active TimeSensor node ignores set_cycleInterval and set_startTime events.
SFBool [in, out] loop FALSE
Repeat indefinitely when loop=true, repeat only once when loop=false.
SFTime [in, out] startTime 0 (-∞,∞)
When time now >= startTime, isActive becomes true and TimeSensor becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint
- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
SFTime [in, out] resumeTime 0 (-∞,∞)
When resumeTime becomes <= time now, isPaused becomes false and TimeSensor becomes inactive. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint
- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
Warning
- Not supported in VRML97.
SFTime [in, out] pauseTime 0 (-∞,∞)
When time now >= pauseTime, isPaused becomes true and TimeSensor becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint
- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
Warning
- Not supported in VRML97.
SFTime [in, out] stopTime 0 (-∞,∞)
When stopTime becomes <= time now, isActive becomes false and TimeSensor becomes inactive. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
Hint
- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
Warnings
- An active TimeSensor node ignores set_cycleInterval and set_startTime events.
- An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
SFBool [out] isPaused
isPaused true/false events are sent when TimeSensor is paused/resumed.
Warnings
- Not supported in VRML97.
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFBool [out] isActive
isActive true/false events are sent when TimeSensor starts/stops running.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFTime [out] cycleTime
cycleTime sends a time outputOnly at startTime, and also at the beginning of each new cycle (useful for synchronization with other time-based objects).
Hints
- The first cycleTime event for a TimeSensor node can be used as an alarm (single pulse at a specified time).
- cycleTime is a nonnegative SFTime duration interval, not an absolute clock time.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFTime [out] elapsedTime
Current elapsed time since TimeSensor activated/running, cumulative in seconds, and not counting any paused time.
Hint
- elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
Warnings
- Not supported in VRML97.
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFFloat [out] fraction_changed
fraction_changed continuously sends value in range [0,1] showing time progress in the current cycle.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
SFTime [out] time
Time continuously sends the absolute time (value 0.0 matches 1 January 1970) in seconds for a given simulation tick.
Warning
- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
Advice
Hints
- TimeSensor may be ignored if cycleInterval < 0.01 second.
- Event timing details are explained in X3D Specification 4.4.8.3 Execution model
- X3D Architecture 8 Time component
- Example scenes and authoring assets
Example
