Click or drag to resize
SoMFEnumEnumType Class

Multiple-value field containing any number of enumerated type values.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.FieldsSoField
      OIV.Inventor.FieldsSoMField
        OIV.Inventor.FieldsSoMFEnumEnumType
          OIV.Inventor.FieldsSoMFBitMaskEnumType

Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
Syntax
public class SoMFEnum<EnumType> : SoMField
where EnumType : Enum

Type Parameters

EnumType

The SoMFEnumEnumType type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAppendConnection(SoEngineOutput)

Appends this field to the list of connections from another engineOutput.

(Inherited from SoField.)
Public methodAppendConnection(SoField)

Appends this field to the list of connections from another field.

(Inherited from SoField.)
Public methodConnectFrom(SoEngineOutput)

Connects this field from an engine output.

(Inherited from SoField.)
Public methodConnectFrom(SoField)

Connects this field to another field.

(Inherited from SoField.)
Public methodCopyFrom

Copy from another field of same type.

Public methodDeleteValues(Int32)
Calls DeleteValues(start, -1).
(Inherited from SoMField.)
Public methodDeleteValues(Int32, Int32)

Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).

(Inherited from SoMField.)
Public methodDisableDeleteValues

Temporary disable value deleting.

Public methodDisconnect

Disconnect the field from whatever it was connected to.

(Inherited from SoField.)
Public methodDisconnect(SoEngineOutput)

Disconnect the field from the requested engineOutput.

(Inherited from SoField.)
Public methodDisconnect(SoField)

Disconnect the field from the requested field.

(Inherited from SoField.)
Public methodEnableConnection

Field connections may be enabled and disabled.

(Inherited from SoField.)
Public methodEquals
Public methodFind(Int32)
Calls Find(targetValue, false).
Public methodFind(Int32, Boolean)

Finds the given targetValue in the array and returns the index of that value.

Public methodFinishEditing

Indicates that batch edits have finished.

Public methodGet

Returns the value of the field in the Open Inventor file format, even if the field has its default value.

(Inherited from SoField.)
Public methodGet1

This is equivalent to the OIV.Inventor.Fields.SoField.Get(System.String@) method of OIV.Inventor.Fields.SoField, but operates on only one value.

(Inherited from SoMField.)
Public methodGetConnectedEngine

Returns true if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.

(Inherited from SoField.)
Public methodGetConnectedField

Returns true if this field is being written into by another field, and returns the field it is connected to in writingField.

(Inherited from SoField.)
Public methodGetConnections

Returns a list of the connections to this field.

(Inherited from SoField.)
Public methodGetContainer

Returns the object that contains this field.

(Inherited from SoField.)
Public methodGetEnums Obsolete.
Returns an array of values contained by field
Public methodGetForwardConnections

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.

(Inherited from SoField.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLongValueSize Obsolete.

Get size of the value.

Public methodGetNum Obsolete.

Returns the number of values currently in the field.

(Inherited from SoMField.)
Public methodGetNumConnections

Returns the number of connections to this field.

(Inherited from SoField.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValues

Returns a pointer into the array of values in the field, starting at index start.

Public methodGetValueSize

Get size of the value.

Public methodInsertSpace

Inserts space for num values at index start .

(Inherited from SoMField.)
Public methodIsConnected

Returns true if the field is connected to anything.

(Inherited from SoField.)
Public methodIsConnectedFromEngine

Returns true if the field is connected to an engine's output.

(Inherited from SoField.)
Public methodIsConnectedFromField

Returns true if the field is connected to another field.

(Inherited from SoField.)
Public methodIsConnectedFromVRMLInterp

Returns true if the field is connected to a VRML interpOutput.

(Inherited from SoField.)
Public methodIsConnectionEnabled

Returns false if connections to this field are disabled.

(Inherited from SoField.)
Public methodIsDefault

Gets the state of default flag of the field.

(Inherited from SoField.)
Public methodIsIgnored

Gets the ignore flag for this field.

(Inherited from SoField.)
Public methodSet

Sets the field to the given value, which is an ASCII string in the Open Inventor file format.

(Inherited from SoField.)
Public methodSet1

This is equivalent to the OIV.Inventor.Fields.SoField.Set(System.String) method of OIV.Inventor.Fields.SoField, but operates on only one value.

(Inherited from SoMField.)
Public methodSet1Value(Int32, Int32) Obsolete.

Sets the index'th value in the array to newValue.

Public methodSet1Value(Int32, String)

Sets the index 'th value to be the integer corresponding to the mnemonic name in the given string.

Public methodSetIgnored

Sets the ignore flag for this field.

(Inherited from SoField.)
Public methodSetNum Obsolete.

Forces this field to have exactly num values, inserting or deleting values as necessary.

(Inherited from SoMField.)
Public methodSetValue(Int32) Obsolete.

Sets the first value in the array to newValue, and deletes.

Public methodSetValue(String)

Sets this field to contain one and only one value, which is the mnemonic name as a string.

Public methodSetValue(EnumType)

Sets the first value in the array to newValue, and deletes.

Public methodSetValues

Sets num values starting at index start to the values.

Public methodSetValuesBuffer

Sets the field to contain the num values stored in userData array.

Public methodStartEditing

Returns a pointer to the internally maintained array that can be modified.

Public methodToString
Converts this SoMFField structure to a human readable string.
(Inherited from SoMField.)
Public methodTouch

Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.

(Inherited from SoField.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Public operatorStatic memberInequality
Top
Properties
  NameDescription
Public propertyCount

Returns the number of values currently in the field.

(Inherited from SoMField.)
Public propertyEnums
Gets a collection containing the enum's value in the SoSFEnum < EnumType >.
Public propertyIsUserDefinedBuffer (Inherited from SoMField.)
Public propertyItem Obsolete.
Public propertyValue
Value indexer.
Top
Remarks

A multiple-value field that contains any number of enumerated type values, stored as ints. Nodes that use this field class define mnemonic names for values. 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.

SoMFEnums are written to file as a set of mnemonic enumerated type names. These names differ among uses of this field in various node classes. See the reference pages for specific nodes for the names.

When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

See Also