| SoOnOff Class |
Engine that functions as an on/off switch.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.Inventor.EnginesSoOnOff
Namespace: OIV.Inventor.Engines
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoOnOff type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | Copy | Creates and returns an exact copy of the engine. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetName | Returns the name of an instance. |
| GetOutput | Returns a reference to the engine output with the given name. |
| GetOutputName | Returns (in outputName) the name of the engine output (output). |
| GetOutputs | Returns a list of outputs in this engine. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
Properties| Name | Description | |
|---|---|---|
 | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| isOff | ( OIV.Inventor.Fields.SoSFBool ) The inverse of isOn. |
| isOn | ( OIV.Inventor.Fields.SoSFBool ) Switch value. |
| off | Turn the isOn switch off. |
| on | Turn the isOn switch on. |
| toggle | Toggle the switch value. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis engine has three triggers as input and two Boolean values as output. The OIV.Inventor.Engines.SoOnOff.isOn output is a switch that can be turned OIV.Inventor.Engines.SoOnOff.on or OIV.Inventor.Engines.SoOnOff.off by triggering the corresponding input. You can toggle the value by triggering the OIV.Inventor.Engines.SoOnOff.toggle input. By default OIV.Inventor.Engines.SoOnOff.isOn is false. The OIV.Inventor.Engines.SoOnOff.isOff output value is the inverse of OIV.Inventor.Engines.SoOnOff.isOn
FILE FORMAT/DEFAULT
OnOff {
| on | |
| off | |
| toggle |
See Also