Rechercher une page de manuel
SoElapsedTime.3coin2
Langue: en
Version: 383984 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Constructor & Destructor Documentation
- Member Function Documentation
- void SoElapsedTime::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
- void SoElapsedTime::writeInstance (SoOutput * out) [protected, virtual]Writes all the fields contained in this instance to the output stream within out.
- Member Data Documentation
- SoSFTime SoElapsedTime::timeInInput time value. Default connected to the global realTime field.
- SoSFFloat SoElapsedTime::speedDecides how fast the timer should run, measured versus 'real time' from the timeIn field. Default value is 1.0.
- SoSFBool SoElapsedTime::onShuts timer on and off. Will restart at the same position.
- SoSFBool SoElapsedTime::pauseShuts timer on and off. Will restart at the position it would have been if not paused (i.e. doesn't 'lose time').
- SoSFTrigger SoElapsedTime::resetRestart timer at 0.
- SoEngineOutput SoElapsedTime::timeOut(SoSFTime) Output time value. Starts at 0.
- Author
NAME
SoElapsedTime -The SoElapsedTime class is a controllable time source engine.
The additional functionality provided by this engine versus just connecting to the realTime global field is the ability to control the speed of the time source plus logic to reset, stop and restart it.
SYNOPSIS
#include <Inventor/engines/SoElapsedTime.h>
Inherits SoEngine.
Public Member Functions
SoElapsedTime (void)
Static Public Member Functions
static void initClass (void)
Public Attributes
SoSFTime timeIn
SoSFFloat speed
SoSFBool on
SoSFBool pause
SoSFTrigger reset
SoEngineOutput timeOut
Protected Member Functions
~SoElapsedTime ()
virtual void writeInstance (SoOutput *out)
Detailed Description
The SoElapsedTime class is a controllable time source engine.
The additional functionality provided by this engine versus just connecting to the realTime global field is the ability to control the speed of the time source plus logic to reset, stop and restart it.
Simple usage example, combined with SoComposeRotation:
#Inventor V2.1 ascii Separator { Transform { rotation = ComposeRotation { axis 0 1 0 angle = ElapsedTime { }.timeOut }.rotation } Cube { } }
See also:
- SoTimeCounter
Constructor & Destructor Documentation
SoElapsedTime::SoElapsedTime (void)Default constructor.
References SoField::connectFrom(), SoDB::getGlobalField(), SbTime::getValue(), on, pause, reset, speed, timeIn, timeOut, and SbTime::zero().
SoElapsedTime::~SoElapsedTime () [protected]Destructor.
Member Function Documentation
void SoElapsedTime::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
Reimplemented from SoEngine.
void SoElapsedTime::writeInstance (SoOutput * out) [protected, virtual]Writes all the fields contained in this instance to the output stream within out.
This method is solely called from the write methods of fields.
Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.
This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.
Reimplemented from SoEngine.
References SoField::connectFrom(), SoField::disconnect(), SoField::getConnectedField(), SoDB::getGlobalField(), SoField::isDefault(), SoField::setDefault(), timeIn, and SoEngine::writeInstance().
Member Data Documentation
SoSFTime SoElapsedTime::timeInInput time value. Default connected to the global realTime field.
Referenced by SoElapsedTime(), and writeInstance().
SoSFFloat SoElapsedTime::speedDecides how fast the timer should run, measured versus 'real time' from the timeIn field. Default value is 1.0.
A negative value makes the time go backward.
Referenced by SoElapsedTime().
SoSFBool SoElapsedTime::onShuts timer on and off. Will restart at the same position.
Referenced by SoElapsedTime(), SoPendulum::SoPendulum(), and SoShuttle::SoShuttle().
SoSFBool SoElapsedTime::pauseShuts timer on and off. Will restart at the position it would have been if not paused (i.e. doesn't 'lose time').
Referenced by SoElapsedTime().
SoSFTrigger SoElapsedTime::resetRestart timer at 0.
Referenced by SoElapsedTime().
SoEngineOutput SoElapsedTime::timeOut(SoSFTime) Output time value. Starts at 0.
Referenced by SoElapsedTime(), SoPendulum::SoPendulum(), and SoShuttle::SoShuttle().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre