#include <X3DTimeDependentNode.h>
Inheritance diagram for H3D::X3DTimeDependentNode:
Public Member Functions | |
| X3DTimeDependentNode (Inst< SFNode > _metadata=0, Inst< SFBool > _loop=0, Inst< SFTime > _pauseTime=0, Inst< SFTime > _resumeTime=0, Inst< StartTime > _startTime=0, Inst< StopTime > _stopTime=0, Inst< SFTime > _elapsedTime=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isPaused=0, Inst< TimeHandler > _timeHandler=0) | |
| Constructor. | |
| virtual void | initialize () |
| Activates the node if the conditions for a time node to be active from the start are met. | |
| virtual void | onPause () |
| This function will be called when the node is paused. | |
| virtual void | onResume () |
| This function will be called when the node is resumed after it has been in paused state. | |
| virtual void | onStart () |
| This function will be called when the time node is started. | |
| virtual void | onStop () |
| This function will be called when the time node is stopped. | |
Public Attributes | |
| auto_ptr< SFBool > | loop |
| If loop is TRUE at the end of a cycle, execution continues into the next cycle, otherwise it stops. | |
| auto_ptr< SFTime > | pauseTime |
| A time at which to pause and stop generating events. | |
| auto_ptr< SFTime > | resumeTime |
| A time at which to start generating events again after being paused. | |
| auto_ptr< StartTime > | startTime |
| A time-dependent node is inactive until its startTime is reached. | |
| auto_ptr< StopTime > | stopTime |
| An active time-dependent node will become inactive when stopTime is reached if stopTime > startTime. | |
| auto_ptr< SFTime > | elapsedTime |
| The elapsedTime outputOnly field delivers the current elapsed time since the X3DTimeDependentNode was activated and running, cumulative in seconds and not counting any time while in a paused state. | |
| auto_ptr< SFBool > | isActive |
| An isActive TRUE event is generated when the node becomes active and an isActive FALSE event is generated when it becomes inactive. | |
| auto_ptr< SFBool > | isPaused |
| An isPaused TRUE event is generated when the node becomes paused and an isPaused FALSE event is generated when it is resumed. | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Protected Attributes | |
| auto_ptr< TimeHandler > | timeHandler |
Classes | |
| class | StartTime |
| The StartTime field is a specialization of the SFTime field so that the value cannot be changed when the isActive field of the X3DTimeDependentNode it resides in is true. More... | |
| class | StopTime |
| The StopTime field is a specialization of the SFTime field so that the value is ignored if the X3DTimeDependentNode is active and stopTime <= startTime as according to the X3D spec. More... | |
| class | TimeHandler |
| The TimeHandler field updates once per scene-graph loop to monitor the current time and updates the fields in the owner X3DTimeDependentNode if any state changes has to be made. More... | |
|
|
The elapsedTime outputOnly field delivers the current elapsed time since the X3DTimeDependentNode was activated and running, cumulative in seconds and not counting any time while in a paused state.
Access type: outputOnly |
|
|
An isActive TRUE event is generated when the node becomes active and an isActive FALSE event is generated when it becomes inactive. These are the only times at which an isActive event is generated. In particular, isActive events are not sent at each tick of a simulation.
Access type: outputOnly |
|
|
An isPaused TRUE event is generated when the node becomes paused and an isPaused FALSE event is generated when it is resumed.
Access type: outputOnly |
|
|
If loop is TRUE at the end of a cycle, execution continues into the next cycle, otherwise it stops.
Access type: inputOutput |
|
|
A time at which to pause and stop generating events. While an active time-dependent node is paused, it generates a TRUE isPaused event and ceases to generate all other output events, while maintaining (or "freezing") its state (holding the last output values and the clock's internal time when the pausing conditions are met).
Access type: inputOutput |
|
|
A time at which to start generating events again after being paused.
Access type: inputOutput |
|
|
A time-dependent node is inactive until its startTime is reached. When current time becomes greater than or equal to startTime, an isActive TRUE event is generated and the time-dependent node becomes active.
Access type: inputOutput |
|
|
An active time-dependent node will become inactive when stopTime is reached if stopTime > startTime. The value of stopTime is ignored if stopTime = startTime.
Access type: inputOutput |
1.4.5