SoCounter Class Reference

Triggered integer counter. More...

#include <Inventor/engines/SoCounter.h>

Inheritance diagram for SoCounter:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoCounter ()
	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
SoSFShort	min
	Minimum value for the counter.
SoSFShort	max
	Maximum value for the counter.
SoSFShort	step
	Counter step value.
SoSFTrigger	trigger
	Go to the next step.
SoSFShort	reset
	At the next trigger, reset the counter to the specified value.
SoEngineOutput	output
	( SoSFShort ) Counts min-to-max in step increments.
SoEngineOutput	syncOut
	( SoSFTrigger ) Triggers at cycle start.

Detailed Description

Triggered integer counter.

This engine is a counter that outputs numbers, starting at a minimum value, increasing by a step value, and ending with a number that does not exceed the maximum value. It outputs the next number whenever the trigger input is touched. When the maximum number is reached, it starts counting from the beginning again.

At any time the counter can be reset to a specific value by setting the reset input field to that value. The next time the counter is triggered it will start counting from there. Note that the counter will always output numbers based on the min, max and step values, and setting the reset value does not affect those input fields. If the reset value is not a legal counter value, the counter will still behave as though it is.

• If reset is greater than max, the counter is set to max.
• If reset is less than min, the counter is set to min.
• If reset is between steps, the counter is set to the lower step value.

Each time a counting cycle is started, the syncOut output is triggered. This output can be used to synchronize some other event with the counting cycle.

FILE FORMAT/DEFAULT

Counter {

min	0
max	1
step	1
trigger
reset	0

}

SEE ALSO

SoTimeCounter, SoEngineOutput

Definition at line 103 of file SoCounter.h.

Constructor & Destructor Documentation

SoCounter()

SoCounter::SoCounter

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoCounter::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoCounter::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Member Data Documentation

max

SoSFShort SoCounter::max

Maximum value for the counter.

Definition at line 115 of file SoCounter.h.

min

SoSFShort SoCounter::min

Minimum value for the counter.

Definition at line 111 of file SoCounter.h.

output

SoEngineOutput SoCounter::output

( SoSFShort ) Counts min-to-max in step increments.

Definition at line 132 of file SoCounter.h.

reset

SoSFShort SoCounter::reset

At the next trigger, reset the counter to the specified value.

Definition at line 127 of file SoCounter.h.

step

SoSFShort SoCounter::step

Counter step value.

Definition at line 119 of file SoCounter.h.

syncOut

SoEngineOutput SoCounter::syncOut

( SoSFTrigger ) Triggers at cycle start.

Definition at line 136 of file SoCounter.h.

trigger

SoSFTrigger SoCounter::trigger

Go to the next step.

Definition at line 123 of file SoCounter.h.

---

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

• Inventor/engines/SoCounter.h