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

							     SoIdleSensor(3IV)

NAME
     SoIdleSensor (SoIdleSens) - sensor for one-time only callbacks when the
     application is idle

INHERITS FROM
     SoSensor > SoDelayQueueSensor > SoIdleSensor

SYNOPSIS
     #include <Inventor_c/sensors/SoIdleSensor.h>

     typedef SoIdleSensor  SoIdleSens

	  Functions from class SoIdleSensor:

     SoIdleSensor *	 SoIdleSensCreate()
     SoIdleSensor *	 SoIdleSensCreateCB(SoSensorCB *func, void *data)
     void		 SoIdleSensDelete(SoIdleSens *this)

	  Functions from class SoDelayQueueSensor:

     void		 SoIdleSensSetPri(SoIdleSens *this, uint32_t pri)
     uint32_t		 SoIdleSensGetPri(SoIdleSens *this)
     uint32_t		 SoIdleSensGetDefaultPriority()
     void		 SoIdleSensSched(SoIdleSens *this)
     void		 SoIdleSensUnsched(SoIdleSens *this)
     SbBool		 SoIdleSensIsSched(SoIdleSens *this)

	  Functions from class SoSensor:

     void		 SoIdleSensSetFunc(SoIdleSens *this, SoSensorCB
			      *callbackFunction)
     SoSensorCB *	 SoIdleSensGetFunc(const SoIdleSens *this)
     void		 SoIdleSensSetData(SoIdleSens *this, void
			      *callbackData)
     void *		 SoIdleSensGetData(const SoIdleSens *this)

DESCRIPTION
     An idle sensor is almost exactly like an SoOneShotSensor, except that it
     is only triggered when there are no timer queue sensors waiting to be
     triggered and there are no events waiting to be processed; that is, idle
     sensors will not be triggered if the delay queue is processed because the
     delay queue timeout expires. If the delay queue timeout is disabled (see
     SoDBSetDelaySensorTimeout().), idle and one-shot sensors are exactly the
     same.

     Note that idle sensors do not reschedule themselves. Inventor 1 idle
     sensors were always scheduled; call schedule() in the callback function
     to duplicate that behavior.

     See the SoOneShotSensor manual page for more information.

Page 1

SoIdleSensor(3IV)

FUNCTIONS
     SoIdleSensor *	 SoIdleSensCreate()
     SoIdleSensor *	 SoIdleSensCreateCB(SoSensorCB *func, void *data)
	  Creation methods. The second method takes the callback function and
	  data to be called when the sensor is triggered.

     void		 SoIdleSensDelete(SoIdleSens *this)
	  Destroys the sensor, freeing up any memory associated with it after
	  unscheduling it.

SEE ALSO
     SoOneShotSensor, SoDelayQueueSensor

Page 2

Vote for polarhome