Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31559 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

								  SoOnOff(3IV)

NAME
     SoOnOff (SoOnOff) - engine that functions as an on/off switch

INHERITS FROM
     SoBase > SoFieldContainer > SoEngine > SoOnOff

SYNOPSIS
     #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 1

SoOnOff(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.

FUNCTIONS
     SoOnOff *		 SoOnOffCreate()
	  Constructor.

Page 2

								  SoOnOff(3IV)

FILE FORMAT/DEFAULTS
     OnOff {
	  on
	  off
	  toggle
     }

SEE ALSO
     SoEngineOutput

Page 3

Vote for polarhome