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  -  SOPATHSENSOR (3)

NAME

SoPathSensor — sensor class that can be attached to Inventor paths

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoSensor > SoDelayQueueSensor > SoDataSensor > SoPathSensor

SYNOPSIS

#include <Inventor/sensors/SoPathSensor.h>

Methods from class SoPathSensor:

       
                    
                     SoPathSensor()    
   
                    
                     SoPathSensor(SoSensorCB *func, void *data)    
   
                    
                     ~SoPathSensor()    
void    
                    
void                 attach(SoPath *path)    
void    
                    
void                 detach()    
SoPath *    
                    
SoPath *             getAttachedPath() const

Methods from class SoDataSensor:

    void    
                    
void                 setDeleteCallback(SoSensorCB *function, void *data)    
SoNode *    
                    
SoNode *             getTriggerNode() const    
SoField *    
                    
SoField *            getTriggerField() const    
SoPath *    
                    
SoPath *             getTriggerPath() const    
void    
                    
void                 setTriggerPathFlag(SbBool flag)    
SbBool    
                    
SbBool               getTriggerPathFlag() const

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

Path sensors detect changes to paths, calling a callback function whenever the path or any node in the path changes. The definition of "in the path" is the same as the definition used when applying an action to the path — any node that can possibly affect the node at the end of the path chain is considered in the path. See the SoPath manual page for more information on paths.

METHODS

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

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

    void    
                    
void                 attach(SoPath *path)    
void    
                    
void                 detach()    
SoPath *    
                    
SoPath *             getAttachedPath() const
The attach() method makes this sensor detect changes to the given path. The detach() method unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph. The getAttachedPath() method returns the path that this sensor is sensing, or NULL if it is not attached to any path.

SEE ALSO

SoNodeSensor, SoPathSensor, SoDataSensor

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


SOPATHSENSOR(3IV) (-->)

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