TimeSensor nodes generate events as time passes. More...
#include <H3D/TimeSensor.h>
Classes | |
| class | TimeHandler |
| The TimeHandler field is specialized to include the handling of the TimeSensor specific fields. More... | |
Public Types | |
| typedef StartTime | CycleInterval |
| The CycleInterval has the same conditions for update as the StartTime so use that field class definition. | |
 Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
Public Member Functions | |
| TimeSensor (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, Inst< CycleInterval > _cycleInterval=0, Inst< SFTime > _cycleTime=0, Inst< SFBool > _enabled=0, Inst< SFFloat > _fraction_changed=0, Inst< SFTime > _time=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DTimeDependentNode | |
| 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. More... | |
| 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 Member Functions inherited from H3D::X3DChildNode | |
| X3DChildNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DNode | |
| X3DNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| X3DMetadataObject * | getMetadataByName (const string &_name) |
| Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More... | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual void | render () |
| the render() function is used for the depth-first rendering traversal of the scene-graph. More... | |
| virtual void | traverseSG (TraverseInfo &ti) |
| traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More... | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and the Node. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on Node to p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the Node. More... | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
Public Attributes | |
| H3DUniquePtr< CycleInterval > | cycleInterval |
| The cycleInterval field defines how long a cycle lasts in seconds. More... | |
| H3DUniquePtr< SFTime > | cycleTime |
| The cycleTime field sends a time event at startTime and at the beginning of each new cycle with the current time. More... | |
| H3DUniquePtr< SFBool > | enabled |
| If the enabled field is TRUE, the TimeSensor node is enabled and may be running, otherwise no field updates are made. More... | |
| H3DUniquePtr< SFFloat > | fraction_changed |
| The fraction_changed field is the completed fraction of the current cycle, i.e. More... | |
| H3DUniquePtr< SFTime > | time |
| The time field sends the absolute time for a given simulation tick( i.e. More... | |
| Public Attributes inherited from H3D::X3DTimeDependentNode | |
| H3DUniquePtr< SFBool > | loop |
| If loop is TRUE at the end of a cycle, execution continues into the next cycle, otherwise it stops. More... | |
| H3DUniquePtr< SFTime > | pauseTime |
| A time at which to pause and stop generating events. More... | |
| H3DUniquePtr< SFTime > | resumeTime |
| A time at which to start generating events again after being paused. More... | |
| H3DUniquePtr< StartTime > | startTime |
| A time-dependent node is inactive until its startTime is reached. More... | |
| H3DUniquePtr< StopTime > | stopTime |
| An active time-dependent node will become inactive when stopTime is reached if stopTime > startTime. More... | |
| H3DUniquePtr< 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. More... | |
| H3DUniquePtr< SFBool > | isActive |
| An isActive TRUE event is generated when the node becomes active and an isActive FALSE event is generated when it becomes inactive. More... | |
| H3DUniquePtr< SFBool > | isPaused |
| An isPaused TRUE event is generated when the node becomes paused and an isPaused FALSE event is generated when it is resumed. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DTimeDependentNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
TimeSensor nodes generate events as time passes.
TimeSensor nodes can be used for many purposes including:
- driving continuous simulations and animations;
- controlling periodic activities (e.g., one per minute);
- initiating single occurrence events such as an alarm clock.
The TimeSensor node contains two discrete outputOnly fields: isActive and cycleTime. The isActive outputOnly field sends TRUE when the TimeSensor node begins running, and FALSE when it stops running. The cycleTime outputOnly field sends a time event at startTime and at the beginning of each new cycle (useful for synchronization with other time-based objects). The remaining outputOnly fields generate continuous events. The fraction_changed outputOnly field, an SFFloat in the closed interval [0,1], sends the completed fraction of the current cycle. The time outputOnly field sends the absolute time for a given simulation tick.
If the enabled field is TRUE, the TimeSensor node is enabled and may be running. If a set_enabled FALSE event is received while the TimeSensor node is running, the sensor performs the following actions:
- evaluates and sends all relevant outputs;
- sends a FALSE value for isActive;
- disables itself.
Input events on the fields of the TimeSensor node (e.g., set_startTime) are processed and their corresponding outputOnly fields (e.g., startTime_changed) are sent regardless of the state of the enabled field. The remaining discussion assumes enabled is TRUE.
The "cycle" of a TimeSensor node lasts for cycleInterval seconds. The value of cycleInterval shall be greater than zero.
A cycleTime outputOnly field can be used for synchronization purposes such as sound with animation. The value of a cycleTime event will be equal to the time at the beginning of the current cycle. A cycleTime event is generated at the beginning of every cycle, including the cycle starting at startTime. The first cycleTime event for a TimeSensor node can be used as an alarm (single pulse at a specified time).
When a TimeSensor node becomes active, it generates an isActive = TRUE event and begins generating time, fraction_changed, and cycleTime events which may be routed to other nodes to drive animation or simulated behaviours. The behaviour at read time is described below. The time event sends the absolute time for a given tick of the TimeSensor node (SFTime/MFTime fields and events represent the number of seconds since midnight GMT January 1, 1970).
fraction_changed events output a floating point value in the closed interval [0, 1]. At startTime the value of fraction_changed is 0. After startTime, the value of fraction_changed in any cycle will progress through the range (0.0, 1.0]. At startTime + N x cycleInterval, for N = 1, 2, ..., (i.e., at the end of every cycle), the value of fraction_changed is 1.
A TimeSensor node can be set up to be active at read time by specifying loop TRUE (not the default) and stopTime less than or equal to startTime (satisfied by the default values). The time events output absolute times for each tick of the TimeSensor node simulation. The time events shall start at the first simulation tick greater than or equal to startTime. time events end at stopTime, or at startTime + N x cycleInterval for some positive integer value of N, or loop forever depending on the values of the other fields. An active TimeSensor node shall stop at the first simulation tick when now = stopTime > startTime.
No guarantees are made with respect to how often a TimeSensor node generates time events, but a TimeSensor node shall generate events at least at every simulation tick. TimeSensor nodes are guaranteed to generate final time and fraction_changed events. If loop is FALSE at the end of the Nth cycleInterval and was TRUE at startTime + M cycleInterval for all 0 < M < N, the final time event will be generated with a value of (startTime + N x cycleInterval) or stopTime (if stopTime > startTime), whichever value is less. If loop is TRUE at the completion of every cycle, the final event is generated as evaluated at stopTime (if stopTime > startTime) or never.
An active TimeSensor node ignores set_cycleInterval and set_startTime events. An active TimeSensor node also ignores set_stopTime events for set_stopTime less than or equal to startTime. For example, if a set_startTime event is received while a TimeSensor node is active, that set_startTime event is ignored (the startTime field is not changed, and a startTime_changed event is not generated). If an active TimeSensor node receives a set_stopTime event that is less than the current time, and greater than startTime, it behaves as if the stopTime requested is the current time and sends the final events based on the current time (note that stopTime is set as specified in the field).
A TimeSensor read from a X3D file shall generate isActive TRUE, time and fraction_changed events if the sensor is enabled and all conditions for a TimeSensor to be active are met. Examples:
- Switch.x3d ( Source )
Member Data Documentation
◆ cycleInterval
| H3DUniquePtr< CycleInterval > H3D::TimeSensor::cycleInterval |
The cycleInterval field defines how long a cycle lasts in seconds.
Access type: inputOutput
Default value: 1
Referenced by H3D::TimeSensor::TimeHandler::activate(), TimeSensor(), and H3D::TimeSensor::TimeHandler::update().
◆ cycleTime
| H3DUniquePtr< SFTime > H3D::TimeSensor::cycleTime |
The cycleTime field sends a time event at startTime and at the beginning of each new cycle with the current time.
Access type: outputOnly
Referenced by H3D::TimeSensor::TimeHandler::activate(), TimeSensor(), and H3D::TimeSensor::TimeHandler::update().
◆ enabled
| H3DUniquePtr< SFBool > H3D::TimeSensor::enabled |
If the enabled field is TRUE, the TimeSensor node is enabled and may be running, otherwise no field updates are made.
Access type: inputOutput
Default value: TRUE
Referenced by TimeSensor(), and H3D::TimeSensor::TimeHandler::update().
◆ fraction_changed
| H3DUniquePtr< SFFloat > H3D::TimeSensor::fraction_changed |
The fraction_changed field is the completed fraction of the current cycle, i.e.
a value in the interval [0-1].
Access type: outputOnly
Referenced by H3D::TimeSensor::TimeHandler::activate(), TimeSensor(), and H3D::TimeSensor::TimeHandler::update().
◆ time
| H3DUniquePtr< SFTime > H3D::TimeSensor::time |
The time field sends the absolute time for a given simulation tick( i.e.
for this scene-graph loop).
Access type: outputOnly
Referenced by H3D::TimeSensor::TimeHandler::activate(), TimeSensor(), and H3D::TimeSensor::TimeHandler::update().
The documentation for this class was generated from the following files:
