SoOneShot Class Reference

Timer that runs for a pre-set amount of time. More...

#include <Inventor/engines/SoOneShot.h>

Inheritance diagram for SoOneShot:

Public Types
enum	Flags {   RETRIGGERABLE = (1<<0) ,   HOLD_FINAL = (1<<1) }
	Flags. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoOneShot ()
	Constructor.
Public Member Functions inherited from SoEngine
virtual int	getOutputs (SoEngineOutputList &list) const
	Returns a list of outputs in this engine.
SoEngineOutput *	getOutput (const SbName &outputName) const
	Returns a reference to the engine output with the given name.
SbBool	getOutputName (const SoEngineOutput *output, SbName &outputName) const
	Returns (in outputName) the name of the engine output (output).
SoEngine *	copy () const
	Creates and returns an exact copy of the engine.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoEngine
static SoType	getClassTypeId ()
	Returns the type identifier for the SoEngine class.
static SoEngine *	getByName (const SbName &name)
	Looks up engine(s) by name.
static int	getByName (const SbName &name, SoEngineList &list)
	Looks up engine(s) by name.
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFTime	duration
	Duration of the active cycle.
SoSFTrigger	trigger
	Start the cycle.
SoSFBitMask	flags
	Control flags.
SoSFBool	disable
	If TRUE, the timer is disabled.
SoSFTime	timeIn
	Running time.
SoEngineOutput	timeOut
	( SoSFTime ) Elapsed time from the start.
SoEngineOutput	isActive
	( SoSFBool ) Is TRUE during the active cycle.
SoEngineOutput	ramp
	( SoSFFloat ) Ramps linearly from 0.0 to 1.0.

Detailed Description

Timer that runs for a pre-set amount of time.

This engine is a timer that runs for a pre-set amount of time and then stops. By default, the timeIn input is connected to the realTime global field. It can, however, by connected to any other time source.

The timer is started when the trigger input is touched. It then runs for the specified duration, and updates the timeOut output with the time that has elapsed. During that time, the ramp output is also updated. The ramp output starts at 0.0 at the beginning of the cycle, and linearly increases until it reaches 1.0 at the end of the cycle.

You can disable the timer by setting the disable input to TRUE. The output value remains 0.0 while the timer is disabled. If the timer is disabled in the middle of a cycle the output values will be set to 0.0.

The flags input contains control flags. Using the flags you can set the timer to be retriggerable in the middle of a cycle, and set the output values to stay high after the cycle has been completed. By default, these flags are not set.

FILE FORMAT/DEFAULT

OneShot {

duration	1
trigger
flags	()
disable	FALSE
timeIn	<current time>

}

SEE ALSO

SoElapsedTime, SoEngineOutput

Definition at line 101 of file SoOneShot.h.

Member Enumeration Documentation

Flags

enum SoOneShot::Flags

Flags.

Enumerator
RETRIGGERABLE	Can start over during the cycle.
HOLD_FINAL	Output values stay high after cycle.

Definition at line 108 of file SoOneShot.h.

Constructor & Destructor Documentation

SoOneShot()

SoOneShot::SoOneShot

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoOneShot::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoOneShot::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Member Data Documentation

disable

SoSFBool SoOneShot::disable

If TRUE, the timer is disabled.

Definition at line 131 of file SoOneShot.h.

duration

SoSFTime SoOneShot::duration

Duration of the active cycle.

Definition at line 118 of file SoOneShot.h.

flags

SoSFBitMask SoOneShot::flags

Control flags.

Definition at line 127 of file SoOneShot.h.

isActive

SoEngineOutput SoOneShot::isActive

( SoSFBool ) Is TRUE during the active cycle.

Definition at line 144 of file SoOneShot.h.

ramp

SoEngineOutput SoOneShot::ramp

( SoSFFloat ) Ramps linearly from 0.0 to 1.0.

Definition at line 148 of file SoOneShot.h.

timeIn

SoSFTime SoOneShot::timeIn

Running time.

Definition at line 135 of file SoOneShot.h.

timeOut

SoEngineOutput SoOneShot::timeOut

( SoSFTime ) Elapsed time from the start.

Definition at line 140 of file SoOneShot.h.

trigger

SoSFTrigger SoOneShot::trigger

Start the cycle.

The trigger will be ignored if it is touched in the middle of a cycle and the RETRIGGERABLE flag is not set.

Definition at line 123 of file SoOneShot.h.

---

The documentation for this class was generated from the following file:

• Inventor/engines/SoOneShot.h