GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOIDLESENSOR (3)

NAME

SoIdleSensor — sensor for one-time only callbacks when the application is idle

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoSensor > SoDelayQueueSensor > SoIdleSensor

SYNOPSIS

#include <Inventor/sensors/SoIdleSensor.h>

Methods from class SoIdleSensor:

       
                    
                     SoIdleSensor()    
   
                    
                     SoIdleSensor(SoSensorCB *func, void *data)    
   
                    
                     ~SoIdleSensor()

Methods from class SoDelayQueueSensor:

    void    
                    
void                 setPriority(uint32_t pri)    
uint32_t    
                    
uint32_t             getPriority()    
static uint32_t    
                    
static uint32_t      getDefaultPriority()    
virtual void    
                    
virtual void         schedule()    
virtual void    
                    
virtual void         unschedule()    
virtual SbBool    
                    
virtual SbBool       isScheduled()

Methods from class SoSensor:

    void    
                    
void                 setFunction(SoSensorCB *callbackFunction)    
SoSensorCB *    
                    
SoSensorCB *         getFunction() const    
void    
                    
void                 setData(void *callbackData)    
void *    
                    
void *               getData() const

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 SoDB::setDelaySensorTimeout().), 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.

METHODS

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

       
                    
                     ~SoIdleSensor()
Destroys the sensor, freeing up any memory associated with it after unscheduling it.

SEE ALSO

SoOneShotSensor, SoDelayQueueSensor

Search for    or go to Top of page |  Section 3 |  Main Index


SOIDLESENSOR(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.