| SoSFTrigger Class |
Field used to trigger engines or connection networks.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.FieldsSoField
OIV.Inventor.FieldsSoSField
OIV.Inventor.FieldsSoSFTrigger
Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoSFTrigger type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoSFTrigger | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| AppendConnection(SoEngineOutput) | Appends this field to the list of connections from another engineOutput. |
| AppendConnection(SoField) | Appends this field to the list of connections from another field. |
| ConnectFrom(SoEngineOutput) | Connects this field from an engine output. |
| ConnectFrom(SoField) | Connects this field to another field. |
| CopyFrom | Copy from another field of same type. |
| Disconnect | Disconnect the field from whatever it was connected to. |
| Disconnect(SoEngineOutput) | Disconnect the field from the requested engineOutput. |
| Disconnect(SoField) | Disconnect the field from the requested field. |
| EnableConnection | Field connections may be enabled and disabled. |
| Equals | (Overrides SoFieldEquals(Object).) |
| Get | Returns the value of the field in the Open Inventor file format, even if the field has its default value. |
| GetConnectedEngine | Returns true if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput. |
| GetConnectedField | Returns true if this field is being written into by another field, and returns the field it is connected to in writingField. |
| GetConnections | Returns a list of the connections to this field. |
| GetContainer | Returns the object that contains this field. |
| GetForwardConnections | Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetNumConnections | Returns the number of connections to this field. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | Forces any connected engines or fields to evaluate themselves. |
| GetValueSize | Gets the size of the value. |
| IsConnected | Returns true if the field is connected to anything. |
| IsConnectedFromEngine | Returns true if the field is connected to an engine's output. |
| IsConnectedFromField | Returns true if the field is connected to another field. |
| IsConnectedFromVRMLInterp | Returns true if the field is connected to a VRML interpOutput. |
| IsConnectionEnabled | Returns false if connections to this field are disabled. |
| IsDefault | Gets the state of default flag of the field. |
| IsIgnored | Gets the ignore flag for this field. |
| Set | Sets the field to the given value, which is an ASCII string in the Open Inventor file format. |
| SetIgnored | Sets the ignore flag for this field. |
| SetValue | Starts the notification process; this is equivalent to calling (). |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Touch | Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth. |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
RemarksThis class can be used to start or to synchronize a network of field connections. It is the "null" field - a field with no values. It is typically used as the "start button" for engines that change over time.
Triggers can be connected from any other type of field, and will notify any engines or nodes they are part of (or any other triggers they are connected to) whenever the value of the field is set (even if it is set to its current value) or the field is ()'ed.
Since they have no value, SoSFTriggers are not written to file. A node or engine containing an OIV.Inventor.Fields.SoSFTrigger field will write only the field's name.
See Also