SoSensor - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 3.1.3
Note : Coin

NAMESoSensor − The SoSensor class is the abstract base class for all sensors​.

SYNOPSIS
#include <Inventor/sensors/SoSensor​.h> Inherited by SoDelayQueueSensor, and SoTimerQueueSensor​.

Public Member FunctionsSoSensor (void)
SoSensor (SoSensorCB *func, void *data)
virtual ~SoSensor (void)
void setFunction (SoSensorCB *callbackfunction)
SoSensorCBPtr getFunction (void) const
void setData (void *callbackdata)
void * getData (void) const
virtual void schedule (void)=0
virtual void unschedule (void)=0
virtual SbBool isScheduled (void) const =0
virtual void trigger (void)
virtual SbBool isBefore (const SoSensor *s) const =0
void setNextInQueue (SoSensor *next)
SoSensor * getNextInQueue (void) const

Static Public Member Functionsstatic void initClass (void)

Protected AttributesSoSensorCB * func
void * funcData

Detailed DescriptionThe SoSensor class is the abstract base class for all sensors​. Sensors is a mechanism in Coin for scheduling jobs to be run upon specific events​. The events in question could be particular points in time, or changes to entities in the scene graph​. See documentation of subclasses for insight into exactly for what types of events we can trigger sensor callbacks​. For most tasks where application programmers can use sensors, it is also possible to achieve the same results by using engines​. There are a few important differences between sensors and engines, though: Engines are considered part of the scene graph, and is written to file upon SoWriteAction export operations​. Sensors, on the other hand, are not included in export operations​. Engines basically connects fields (and comes with a lot of builtin functionality for combining and converting inputs and outputs), you just decide which engine you want, connect inputs and output and forgets about it​. Sensors are a lot more flexible in what you can do when they trigger, as control is transfered internally from Coin to your registered callback functions​. See also SoSensorManager, SoEngine

Constructor & Destructor Documentation

SoSensor::SoSensor (void)Constructor​.

SoSensor::SoSensor (SoSensorCB * funcptr, void * data)Constructor taking as parameters the sensor callback function func and the user data pointer which will be passed the callback​. See also setFunction(), setData()

SoSensor::~SoSensor (void) [virtual]Destructor​.

Member Function Documentation

void SoSensor::setFunction (SoSensorCB * callbackfunction)Set the callback function pointer which will be used when the sensor is triggered​. See also getFunction(), setData()

SoSensorCB * SoSensor::getFunction (void) constReturns the callback function pointer​. See also setFunction()

void SoSensor::setData (void * callbackdata)Set the user-supplied data pointer which will be used as the first argument to the sensor callback function​. See also getData(), setFunction()

void * SoSensor::getData (void) constReturns the user-supplied callback function data pointer​. See also setData()

void SoSensor::schedule (void) [pure virtual]Put the sensor in a queue to be triggered at a later time​. See also unschedule(), isScheduled() Implemented in SoTimerSensor, SoTimerQueueSensor, SoDelayQueueSensor, and SoAlarmSensor​.

void SoSensor::unschedule (void) [pure virtual]Remove sensor from queue​. The sensor will not be triggered unless it is later rescheduled​. See also schedule(), isScheduled() Implemented in SoTimerSensor, SoTimerQueueSensor, and SoDelayQueueSensor​.

SbBool SoSensor::isScheduled (void) const [pure virtual]Check if this sensor is scheduled for triggering​. See also schedule(), unschedule() Implemented in SoTimerQueueSensor, and SoDelayQueueSensor​.

void SoSensor::trigger (void) [virtual]Trigger the sensor's callback function​. Reimplemented in SoTimerQueueSensor, SoFieldSensor, SoDelayQueueSensor, and SoDataSensor​.

SbBool SoSensor::isBefore (const SoSensor * s) const [pure virtual]Returns TRUE if this sensor should precede sensor s in its sensor queue​.

void SoSensor::setNextInQueue (SoSensor * next)This API member is considered internal to the library, as it is not likely to be of interest to the application programmer​.

Open Inventor function not implemented in Coin​.

SoSensor * SoSensor::getNextInQueue (void) constThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer​.

Open Inventor function not implemented in Coin​.

void SoSensor::initClass (void) [static]Sets up initialization for static data for the sensors​. Called by SoDB::init()​.

Member Data Documentation

SoSensorCB * SoSensor::func [protected]Function to be called when a sensor triggers​.

void * SoSensor::funcData [protected]Data passed to the callback function​.

AuthorGenerated automatically by Doxygen for Coin from the source code​.
0
Johanes Gumabo
Data Size   :   29,420 byte
man-SoSensor.3coin3Build   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   3 / 199,945
Visitor ID   :     :  
Visitor IP   :   3.133.126.241   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.