Click or drag to resize
SoFieldSensor Class

Sensor class that can be attached to Open Inventor fields.

Inheritance Hierarchy

Namespace: OIV.Inventor.Sensors
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoFieldSensor : SoDataSensor

The SoFieldSensor type exposes the following members.

Constructors
  NameDescription
Public methodSoFieldSensor

Constructor.

Top
Methods
  NameDescription
Public methodAttach

The OIV.Inventor.Sensors.SoFieldSensor.Attach(OIV.Inventor.Fields.SoField) method makes this sensor detect changes to the given field.

Public methodDetach

The OIV.Inventor.Sensors.SoFieldSensor.Detach() method unschedules this sensor (if it is scheduled) and makes it ignore changes to the scene graph.

Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAttachedField

The OIV.Inventor.Sensors.SoFieldSensor.GetAttachedField() method returns the field that this sensor is sensing, or NULL if it is not attached to any field.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetPriority

Gets the priority of the sensor.

(Inherited from SoDelayQueueSensor.)
Public methodGetTriggerChild

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.

(Inherited from SoDataSensor.)
Public methodGetTriggerChildIndex

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.

(Inherited from SoDataSensor.)
Public methodGetTriggerFastEditInfo

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.

(Inherited from SoDataSensor.)
Public methodGetTriggerFastEditInfoFlag

Queries the flag that indicates whether the trigger path fastEdit info (see OIV.Inventor.Sensors.SoDataSensor.GetTriggerFastEditInfo()) is available to delegates.

(Inherited from SoDataSensor.)
Public methodGetTriggerField

If this is a priority 0 data sensor, returns the field that was modified that caused this sensor to trigger.

(Inherited from SoDataSensor.)
Public methodGetTriggerMFieldNumValues

If this is a priority 0 data sensor, and a change in the data values of a multiple field (e.g., OIV.Inventor.Fields.SoMFVec3f) caused this sensor to be triggered, returns the size of the range of the potentially changed values.

(Inherited from SoDataSensor.)
Public methodGetTriggerMFieldStartIndex

If this is a priority 0 data sensor, and a change in the data values of a multiple field (e.g., OIV.Inventor.Fields.SoMFVec3f) caused this sensor to be triggered, returns the first index of the range of the potentially changed values.

(Inherited from SoDataSensor.)
Public methodGetTriggerNode

If this is a priority 0 data sensor, returns the node that was modified that caused this sensor to trigger.

(Inherited from SoDataSensor.)
Public methodGetTriggerPath

If this is a priority 0 data sensor, returns a path to the node that caused this sensor to trigger.

(Inherited from SoDataSensor.)
Public methodGetTriggerPathFlag

Queries the flag that indicates whether the trigger path (see OIV.Inventor.Sensors.SoDataSensor.GetTriggerPath()) is available to delegates.

(Inherited from SoDataSensor.)
Public methodGetTriggerType

If this is a priority 0 data sensor, returns the type of change that occurred.

(Inherited from SoDataSensor.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsIdleOnly
(Inherited from SoDelayQueueSensor.)
Public methodIsScheduled

Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered.

(Inherited from SoSensor.)
Public methodSchedule
(Inherited from SoSensor.)
Public methodSetPriority

Sets the priority of the sensor.

(Inherited from SoDelayQueueSensor.)
Public methodSetTriggerFastEditInfoFlag

Sets the flag that indicates whether the trigger path fastEdit info (see OIV.Inventor.Sensors.SoDataSensor.GetTriggerFastEditInfo()) is available to delegatemethods.

(Inherited from SoDataSensor.)
Public methodSetTriggerPathFlag

Sets the flag that indicates whether the trigger path (see OIV.Inventor.Sensors.SoDataSensor.GetTriggerPath()) is available to delegatemethods.

(Inherited from SoDataSensor.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnschedule
(Inherited from SoSensor.)
Top
Properties
  NameDescription
Public propertyAction

(Inherited from SoSensor.)
Public propertyDeleteCallback

Sets a callback that will be called when the object the sensor is sensing is deleted.

(Inherited from SoDataSensor.)
Top
Remarks

Field sensors detect changes to fields, calling a delegatefunction whenever the field changes. The field may be part of a node, an input of an engine, or a global field.

See OIV.Inventor.Sensors.SoDataSensor for general information and code example.

See Also