An event_emitter
along with the emitted value.
More...
#include <openvrml/script.h>
Detailed Description
An event_emitter
along with the emitted value.
Constructor & Destructor Documentation
Construct.
- Parameters
-
[in] | type | field value type identifier. |
[in] | node | script_node . |
- Exceptions
-
std::bad_alloc | if memory allocation fails. |
Member Function Documentation
The value that will be sent from the eventOut
.
- Returns
- the value that will be sent from the
eventOut
.
void openvrml::script_node::eventout::value |
( |
const field_value & |
val | ) |
throw ( std::bad_alloc , std::bad_cast ) |
Set the value that will be sent from the eventOut
.
After calling this function, modified will return true
until emit_event
is called.
- Parameters
-
- Exceptions
-
std::bad_alloc | if memory allocation fails. |
std::bad_cast | if val is not the correct type. |
bool openvrml::script_node::eventout::modified |
( |
| ) |
const throw () |
Whether the value has been modified.
- Returns
true
if the value has been changed since emit_event
was last called; false
otherwise.
void openvrml::script_node::eventout::emit_event |
( |
double |
timestamp | ) |
throw ( std::bad_alloc ) |
Cause the contained event_emitter
to emit an event.
Events should be emitted from Script nodes by calling this function instead of passing the event_emitter
directly to node::emit_event
.
- Parameters
-
[in] | timestamp | the current time. |
- Exceptions
-
std::bad_alloc | if memory allocation fails. |