| SoSFBitMaskEnumType Class |
Single-value field containing a set of bit flags.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.FieldsSoField
OIV.Inventor.FieldsSoSField
OIV.Inventor.FieldsSoSFEnumEnumType
OIV.Inventor.FieldsSoSFBitMaskEnumType
Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxType Parameters
- EnumType
The SoSFBitMaskEnumType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoSFBitMaskEnumType(SoFieldContainer, String, SoFieldFieldTypes) | Obsolete. Default constructor. |
| SoSFBitMaskEnumType(SoFieldContainer, String, SoFieldFieldTypes, Type) | Obsolete. Default constructor. |
| SoSFBitMaskEnumType(SoFieldContainer, String, SoFieldFieldTypes, EnumType) | 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(SoSFBitMaskEnumType) | Copy from another field of same type. |
| CopyFrom(SoSFEnumEnumType) | 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 | (Inherited from SoSFEnumEnumType.) |
| 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.) |
| GetLongValueSize | Obsolete. Get size of the value. |
| GetNumConnections | Returns the number of connections to this field. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | Obsolete. Returns this field's value. |
| GetValueSize | Get 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(Int32) | Obsolete. Sets this field to newValue. |
| SetValue(String) | Sets this field to contain the given mnemonic name, passed in as a name or string. |
| 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. |
Properties| Name | Description | |
|---|---|---|
 | Value |
Current value.
(Inherited from SoSFEnumEnumType.) |
RemarksA single-value field that contains a mask of bit flags, stored as an integer. Nodes that use this field class define mnemonic names for the bit flags. These names should be used when setting or testing the values of the field, even though the values are treated as integers in the methods.
The bit-wise "&" and "|" operators should be used when testing and setting flags in a mask. For example, to turn on the sides of a 3D text node and turn off the back you would write:
text3.parts = text3.parts.getValue() | SoText3.SIDES; text3.parts = text3.parts.getValue() & ~SoText3BACK;
SoSFBitMasks are written to file as one or more mnemonic enumerated type names, in this format:( flag1 | flag2 | ... )
If only one flag is used in a mask, the parentheses are optional. These names differ among uses of this field in various node or engine classes. See their reference pages for the names.The field values may also be represented as integers, but this is not guaranteed to be portable.
See Also