| SoPathSensor Class |
Sensor class that can be attached to Open Inventor paths.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.SensorsSoSensor
OIV.Inventor.SensorsSoDelayQueueSensor
OIV.Inventor.SensorsSoDataSensor
OIV.Inventor.SensorsSoPathSensor
Namespace: OIV.Inventor.Sensors
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
SyntaxThe SoPathSensor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoPathSensor | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| Attach | Makes this sensor detect changes to the given path. |
| Detach | Unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph. |
| Equals | (Inherited from Object.) |
| GetAttachedPath | Returns the path that this sensor is sensing, or NULL if it is not attached to any path. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetPriority | Gets the priority of the sensor. |
| GetTriggerChild | If this is a priority 0 data sensor, and a change to a group node's children caused this sensor to be triggered (getTriggerType returns GROUP_ADD_CHILD, GROUP_INSERT_CHILD, or GROUP_REPLACE_CHILD), returns the node that was added to the group, and NULL in all other cases. |
| GetTriggerChildIndex | If this is a priority 0 data sensor, and a change to a group node's children caused this sensor to be triggered (getTriggerType returns GROUP_ADD_CHILD, GROUP_INSERT_CHILD, or GROUP_REPLACE_CHILD), returns the index of the node that was added or removed, and -1 in all other cases. |
| GetTriggerFastEditInfo | Returns true if the triggered changes come from a field or node that was below a Separator with a fastEditPolicy field with a value different than OFF. |
| GetTriggerFastEditInfoFlag | Queries the flag that indicates whether the trigger path fastEdit info (see isTriggerBelowFastEdit()) is available to delegates. |
| GetTriggerField | If this is a priority 0 data sensor, returns the field that was modified that caused this sensor to trigger. |
| GetTriggerMFieldNumValues | If this is a priority 0 data sensor, and a change in the data values of a multiple field (e.g., SoMFVec3f) caused this sensor to be triggered, returns the size of the range of the potentially changed values. |
| GetTriggerMFieldStartIndex | If this is a priority 0 data sensor, and a change in the data values of a multiple field (e.g., SoMFVec3f) caused this sensor to be triggered, returns the first index of the range of the potentially changed values. |
| GetTriggerNode | If this is a priority 0 data sensor, returns the node that was modified that caused this sensor to trigger. |
| GetTriggerPath | If this is a priority 0 data sensor, returns a path to the node that caused this sensor to trigger. |
| GetTriggerPathFlag | Queries the flag that indicates whether the trigger path (see getTriggerPath()) is available to delegates. |
| GetTriggerType | If this is a priority 0 data sensor, returns the type of change that occurred. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsIdleOnly | (Inherited from SoDelayQueueSensor.) |
| IsScheduled | Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered. |
| Schedule | (Inherited from SoSensor.) |
| SetDeleteCB(SoSensorSensorCB) | Obsolete.
Use DeleteCallback property instead.
Sets a callback that will be called when the object the sensor is sensing is disposed.
(Inherited from SoDataSensor.) |
| SetDeleteCB(SoSensorSensorUserDataCB, Object) | Obsolete.
Use DeleteCallback property instead.
(Inherited from SoDataSensor.) |
| SetPriority | Sets the priority of the sensor. |
| SetSensorCB(SoSensorSensorCB) | Obsolete.
Use Action property instead
Sets the delegate that is invoked when the sensor is triggered.
The function must take two arguments - user-supplied data (of type object)
and a reference to the sensor that is triggering the function (of type SoSensor).
(Inherited from SoSensor.) |
| SetSensorCB(SoSensorSensorUserDataCB, Object) | Obsolete.
Use Action property instead
(Inherited from SoSensor.) |
| SetTriggerFastEditInfoFlag | Sets the flag that indicates whether the trigger path fastEdit info (see isTriggerBelowFastEdit()) is available to delegatemethods. |
| SetTriggerPathFlag | Sets the flag that indicates whether the trigger path (see getTriggerPath()) is available to delegatemethods. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unschedule | (Inherited from SoSensor.) |
Properties| Name | Description | |
|---|---|---|
 | Action | (Inherited from SoSensor.) |
| DeleteCallback | Sets a callback that will be called when the object the sensor is sensing is deleted. |
RemarksPath sensors detect changes to paths, calling a delegatefunction 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.
See SoDataSensor for general information and code example.
See Also