.TH "SoIdleSensor" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoIdleSensor \- The \fBSoIdleSensor\fP class is a sensor which will trigger as soon as the application is idle\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/sensors/SoIdleSensor\&.h>\fP
.PP
Inherits \fBSoDelayQueueSensor\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoIdleSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoIdleSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoIdleSensor\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "\fBSoDelayQueueSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoDelayQueueSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoDelayQueueSensor\fP (void)"
.br
.ti -1c
.RI "void \fBsetPriority\fP (uint32_t pri)"
.br
.ti -1c
.RI "uint32_t \fBgetPriority\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBschedule\fP (void)"
.br
.ti -1c
.RI "virtual void \fBunschedule\fP (void)"
.br
.ti -1c
.RI "virtual SbBool \fBisScheduled\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBtrigger\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "\fBSoSensor\fP (void)"
.br
.ti -1c
.RI "\fBSoSensor\fP (SoSensorCB *\fBfunc\fP, void *data)"
.br
.ti -1c
.RI "virtual \fB~SoSensor\fP (void)"
.br
.ti -1c
.RI "void \fBsetFunction\fP (SoSensorCB *callbackfunction)"
.br
.ti -1c
.RI "SoSensorCBPtr \fBgetFunction\fP (void) const"
.br
.ti -1c
.RI "void \fBsetData\fP (void *callbackdata)"
.br
.ti -1c
.RI "void * \fBgetData\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNextInQueue\fP (\fBSoSensor\fP *next)"
.br
.ti -1c
.RI "\fBSoSensor\fP * \fBgetNextInQueue\fP (void) const"
.br
.in -1c
.SS "Additional Inherited Members"


Static Public Member Functions inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetDefaultPriority\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Protected Attributes inherited from \fBSoDelayQueueSensor\fP
.in +1c
.ti -1c
.RI "SbBool \fBscheduled\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoSensor\fP
.in +1c
.ti -1c
.RI "SoSensorCB * \fBfunc\fP"
.br
.ti -1c
.RI "void * \fBfuncData\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoIdleSensor\fP class is a sensor which will trigger as soon as the application is idle\&. 

An \fBSoIdleSensor\fP differs from an \fBSoOneShotSensor\fP in that it will not trigger if the delay queue processing is occurring due to the delay queue timeout, but \fIonly\fP when the application is idle\&.

.PP
\fBSee also\fP
.RS 4
\fBSoDB::setDelaySensorTimeout()\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoIdleSensor::SoIdleSensor (void )"
Default constructor\&. 
.SS "SoIdleSensor::SoIdleSensor (SoSensorCB * func, void * data)"
Constructor taking as parameters the sensor callback function and the userdata which will be passed to the callback\&.

.PP
\fBSee also\fP
.RS 4
\fBsetFunction()\fP, \fBsetData()\fP 
.RE
.PP

.SS "SoIdleSensor::~SoIdleSensor (void )\fR [virtual]\fP"
Destructor\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.