SoOnOff(3IV)NAMESoOnOff (SoOnOff) - engine that functions as an on/off switch
INHERITS FROM
SoBase > SoFieldContainer > SoEngine > SoOnOffSYNOPSIS
#include <Inventor_c/engines/SoOnOff.h>
Inputs from class SoOnOff:
SoSFTrigger on
SoSFTrigger off
SoSFTrigger toggle
Outputs from class SoOnOff:
(SoSFBool) isOn
(SoSFBool) isOff
Functions from class SoOnOff:
SoOnOff * SoOnOffCreate()
Functions from class SoEngine:
SoType SoOnOffGetTypeId()
int SoOnOffGetOuts(const SoOnOff *this,
SoEngineOutputList *list)
SoEngineOutput * SoOnOffGetOut(const SoOnOff *this, const char
*outputName)
SbBool SoOnOffGetOutName(const SoOnOff *this, const
SoEngineOutput *output, SbName *outputName)
SoEngine * SoOnOffCopy(const SoOnOff *this)
SoEngine * SoOnOffGetByName(const char *name)
int SoOnOffGetByNameList(const char *name, SoEngineList
*list)
Functions from class SoFieldContainer:
SoType SoOnOffGetClassTypeId()
void SoOnOffSetToDflts(SoOnOff *this)
SbBool SoOnOffHasDfltVals(const SoOnOff *this)
SbBool SoOnOffFldsAreEq(const SoOnOff *this, const
SoFieldContainer *fc)
void SoOnOffCopyFieldVals(SoOnOff *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
SbBool SoOnOffSet(SoOnOff *this, const char
*fieldDataString)
void SoOnOffGet(SoOnOff *this, SbString *fieldDataString)
Page 1SoOnOff(3IV)
int SoOnOffGetFields(const SoOnOff *this, SoFieldList
*resultList)
SoField * SoOnOffGetField(const SoOnOff *this, const char
*fieldName)
SbBool SoOnOffGetFieldName(const SoOnOff *this, const
SoField *field, SbName *fieldName)
SbBool SoOnOffIsNotifyEnabled(const SoOnOff *this)
SbBool SoOnOffEnableNotify(SoOnOff *this, SbBool flag)
Functions from class SoBase:
void SoOnOffRef(SoOnOff *this)
void SoOnOffUnref(const SoOnOff *this)
void SoOnOffUnrefNoDelete(const SoOnOff *this)
void SoOnOffTouch(SoOnOff *this)
SbBool SoOnOffIsOfType(const SoOnOff *this, SoType type)
void SoOnOffSetName(SoOnOff *this, const char *name)
SbName SoOnOffGetName(const SoOnOff *this)
DESCRIPTION
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
INPUTS
SoSFTrigger on
Turn the isOn switch on.
SoSFTrigger off
Turn the isOn switch off.
SoSFTrigger toggle
Toggle the switch value.
OUTPUTS
(SoSFBool) isOn
Switch value.
(SoSFBool) isOff
The inverse of isOn.
FUNCTIONSSoOnOff * SoOnOffCreate()
Constructor.
Page 2SoOnOff(3IV)FILE FORMAT/DEFAULTS
OnOff {
on
off
toggle
}
SEE ALSO
SoEngineOutput
Page 3