The SoOneShot class is a timer that runs for a configurable time and then stops. More...

#include <Inventor/engines/SoOneShot.h>

Inheritance diagram for SoOneShot:

Public Types
enum	Flags { RETRIGGERABLE =1 , HOLD_FINAL =2 }

Public Member Functions
	SoOneShot (void)

virtual const SoFieldData *	getFieldData (void) const

virtual const SoEngineOutputData *	getOutputData (void) const

virtual SoType	getTypeId (void) const

Public Member Functions inherited from SoEngine
SoEngine *	copy (void) const

virtual SoFieldContainer *	copyThroughConnection (void) const

void	evaluateWrapper (void)

SoEngineOutput *	getOutput (const SbName &outputname) const

SbBool	getOutputName (const SoEngineOutput *output, SbName &outputname) const

virtual int	getOutputs (SoEngineOutputList &l) const

SbBool	isNotifying (void) const

virtual void	notify (SoNotList *nl)

SbBool	shouldCopy (void) const

Public Member Functions inherited from SoFieldContainer
virtual void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)

virtual void	copyContents (const SoFieldContainer *from, SbBool copyconnections)

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	enableNotify (const SbBool flag)

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	get (SbString &fielddata)

void	get (SbString &fielddata, SoOutput *out)

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

virtual SoField *	getField (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

virtual int	getFields (SoFieldList &l) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

SbBool	getIsBuiltIn (void) const

void *	getUserData (void) const

SbBool	hasDefaultValues (void) const

SbBool	isNotifyEnabled (void) const

SbBool	set (const char *const fielddata)

SbBool	set (const char fielddata, SoInput input)

void	setToDefaults (void)

void	setUserData (void *userdata) const

virtual SbBool	validateNewFieldValue (SoField field, void newval)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type.

void	ref (void) const

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

virtual void	startNotify (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static void *	createInstance (void)

static SoType	getClassTypeId (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Static Public Member Functions inherited from SoEngine
static SoEngine *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoEngineList &el)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initClasses (void)

Static Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static void	cleanupClass (void)

static void	copyDone (void)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initCopyDict (void)

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static void	decrementCurrentWriteCounter (void)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

static void	removeName (SoBase const base, const char const name)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Public Attributes
SoSFBool	disable

SoSFTime	duration

SoSFBitMask	flags

SoEngineOutput	isActive

SoEngineOutput	ramp

SoSFTime	timeIn

SoEngineOutput	timeOut

SoSFTrigger	trigger

Protected Member Functions
virtual	~SoOneShot (void)

Protected Member Functions inherited from SoEngine
	SoEngine (void)

virtual	~SoEngine (void)

virtual SbBool	readInstance (SoInput *in, unsigned short flags)

void	writeOutputTypes (SoOutput *out)

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual SoNotRec	createNotRec (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Static Protected Member Functions
static const SoFieldData **	getInputDataPtr (void)

static const SoEngineOutputData **	getOutputDataPtr (void)

Static Protected Member Functions inherited from SoEngine
static const SoFieldData **	getInputDataPtr (void)

static const SoEngineOutputData **	getOutputDataPtr (void)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Additional Inherited Members
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Detailed Description

The SoOneShot class is a timer that runs for a configurable time and then stops.

Member Enumeration Documentation

◆ Flags

enum SoOneShot::Flags

There are two flags available: RETRIGGERABLE will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run (otherwise the trigger is ignored during runs).

HOLD_FINAL will make the engine outputs keep their values after a run, instead of resetting them.

Constructor & Destructor Documentation

◆ SoOneShot()

SoOneShot::SoOneShot ( void )

Default constructor.

◆ ~SoOneShot()

SoOneShot::~SoOneShot ( void )

protectedvirtual

Destructor is protected to avoid explicit destruction.

Member Function Documentation

◆ createInstance()

void * SoOneShot::createInstance ( void )

static

Creates a new instance of the class type corresponding to the SoType object.

◆ getClassTypeId()

SoType SoOneShot::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoOneShot::getFieldData ( void ) const

virtual

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoFieldContainer.

◆ getInputDataPtr()

const SoFieldData ** SoOneShot::getInputDataPtr ( void )

staticprotected

Returns the SoFieldData class which holds information about inputs in this engine.

◆ getOutputData()

const SoEngineOutputData * SoOneShot::getOutputData ( void ) const

virtual

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Implements SoEngine.

◆ getOutputDataPtr()

const SoEngineOutputData ** SoOneShot::getOutputDataPtr ( void )

staticprotected

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

◆ getTypeId()

SoType SoOneShot::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

Member Data Documentation

◆ disable

SoSFBool SoOneShot::disable

Set to TRUE to disable the engine completely.

◆ duration

SoSFTime SoOneShot::duration

The time the engine should run for when it is triggered. Defaults to 1 second.

◆ flags

SoSFBitMask SoOneShot::flags

Control flags. See SoOneShot::Flags.

◆ isActive

SoEngineOutput SoOneShot::isActive

(SoSFBool) TRUE while the engine is running, FALSE otherwise.

◆ ramp

SoEngineOutput SoOneShot::ramp

(SoSFFloat) Will run from 0 to 1 during the active period.

◆ timeIn

SoSFTime SoOneShot::timeIn

Input time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source.

◆ timeOut

SoEngineOutput SoOneShot::timeOut

(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.

◆ trigger

SoSFTrigger SoOneShot::trigger

A pulse on this input field starts the engine.

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

SoOneShot.h
SoOneShot.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ SoOneShot()

◆ ~SoOneShot()

Member Function Documentation

◆ createInstance()

◆ getClassTypeId()

◆ getFieldData()

◆ getInputDataPtr()

◆ getOutputData()

◆ getOutputDataPtr()

◆ getTypeId()

Member Data Documentation

◆ disable

◆ duration

◆ flags

◆ isActive

◆ ramp

◆ timeIn

◆ timeOut

◆ trigger