SoOnOff Class Reference

Engine that functions as an on/off switch. More...

#include <Inventor/engines/SoOnOff.h>

Inheritance diagram for SoOnOff:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoOnOff ()
	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
SoSFTrigger	on
	Turn the isOn switch on.
SoSFTrigger	off
	Turn the isOn switch off.
SoSFTrigger	toggle
	Toggle the switch value.
SoEngineOutput	isOn
	( SoSFBool ) Switch value.
SoEngineOutput	isOff
	( SoSFBool ) The inverse of isOn.

Detailed Description

Engine that functions as an on/off switch.

This engine has three triggers as input and two Boolean values as output. The isOn output is a switch that can be turned on or off by triggering the corresponding input. You can toggle the value by triggering the toggle input. By default isOn is FALSE. The isOff output value is the inverse of isOn

FILE FORMAT/DEFAULT

OnOff {

on
off
toggle

}

SEE ALSO

SoEngineOutput

Definition at line 82 of file SoOnOff.h.

Constructor & Destructor Documentation

SoOnOff()

SoOnOff::SoOnOff

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoOnOff::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoOnOff::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

Member Data Documentation

isOff

SoEngineOutput SoOnOff::isOff

( SoSFBool ) The inverse of isOn.

Definition at line 108 of file SoOnOff.h.

isOn

SoEngineOutput SoOnOff::isOn

( SoSFBool ) Switch value.

Definition at line 104 of file SoOnOff.h.

off

SoSFTrigger SoOnOff::off

Turn the isOn switch off.

Definition at line 95 of file SoOnOff.h.

on

SoSFTrigger SoOnOff::on

Turn the isOn switch on.

Definition at line 91 of file SoOnOff.h.

toggle

SoSFTrigger SoOnOff::toggle

Toggle the switch value.

Definition at line 99 of file SoOnOff.h.

---

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

• Inventor/engines/SoOnOff.h