SoMField Class

SoMField Class

Base class for all multiple-valued fields.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.FieldsSoField
      OIV.Inventor.FieldsSoMField
        More...

Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoMField : SoField

Public Class SoMField
	Inherits SoField

public ref class SoMField : public SoField

type SoMField =  
    class
        inherit SoField
    end

The SoMField type exposes the following members.

Methods

	Name	Description
	AppendConnection(SoEngineOutput)	Appends this field to the list of connections from another engineOutput. (Inherited from SoField.)
	AppendConnection(SoField)	Appends this field to the list of connections from another field. (Inherited from SoField.)
	ConnectFrom(SoEngineOutput)	Connects this field from an engine output. (Inherited from SoField.)
	ConnectFrom(SoField)	Connects this field to another field. (Inherited from SoField.)
	DeleteValues(Int32)	Calls DeleteValues(start, -1).
	DeleteValues(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).
	Disconnect	Disconnect the field from whatever it was connected to. (Inherited from SoField.)
	Disconnect(SoEngineOutput)	Disconnect the field from the requested engineOutput. (Inherited from SoField.)
	Disconnect(SoField)	Disconnect the field from the requested field. (Inherited from SoField.)
	EnableConnection	Field connections may be enabled and disabled. (Inherited from SoField.)
	Equals	(Inherited from SoField.)
	Get	Returns the value of the field in the Open Inventor file format, even if the field has its default value. (Inherited from SoField.)
	Get1	This is equivalent to the OIV.Inventor.Fields.SoField.Get(System.String@) method of OIV.Inventor.Fields.SoField, but operates on only one 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. (Inherited from SoField.)
	GetConnectedField	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.)
	GetConnections	Returns a list of the connections to this field. (Inherited from SoField.)
	GetContainer	Returns the object that contains this field. (Inherited from SoField.)
	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. (Inherited from SoField.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetNum	Obsolete. Returns the number of values currently in the field.
	GetNumConnections	Returns the number of connections to this field. (Inherited from SoField.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueSize	Gets the size of the value. (Inherited from SoField.)
	InsertSpace	Inserts space for num values at index start .
	IsConnected	Returns true if the field is connected to anything. (Inherited from SoField.)
	IsConnectedFromEngine	Returns true if the field is connected to an engine's output. (Inherited from SoField.)
	IsConnectedFromField	Returns true if the field is connected to another field. (Inherited from SoField.)
	IsConnectedFromVRMLInterp	Returns true if the field is connected to a VRML interpOutput. (Inherited from SoField.)
	IsConnectionEnabled	Returns false if connections to this field are disabled. (Inherited from SoField.)
	IsDefault	Gets the state of default flag of the field. (Inherited from SoField.)
	IsIgnored	Gets the ignore flag for this field. (Inherited from SoField.)
	Set	Sets the field to the given value, which is an ASCII string in the Open Inventor file format. (Inherited from SoField.)
	Set1	This is equivalent to the OIV.Inventor.Fields.SoField.Set(System.String) method of OIV.Inventor.Fields.SoField, but operates on only one value.
	SetIgnored	Sets the ignore flag for this field. (Inherited from SoField.)
	SetNum	Obsolete. Forces this field to have exactly num values, inserting or deleting values as necessary.
	ToString	Converts this SoMFField structure to a human readable string. (Overrides ObjectToString.)
	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. (Inherited from SoField.)

Top

Properties

	Name	Description
	Count	Returns the number of values currently in the field.
	IsUserDefinedBuffer

Top

Remarks

Each class derived from OIV.Inventor.Fields.SoMField begins with an SoMF prefix and contains a dynamic array of values of a particular type. Each has a setValues() method that is passed an array of values of the correct type; these values are copied into the array in the field, making extra room in the array if necessary. The start parameter to this method indicates the starting array index to copy into.

The getValues() method for a multiple-value field returns a read-only array of values in the field. In addition, the indexer operator [i] is implemented and allows setting/getting the i 'th value in the array.

Methods are provided for getting the number of values in the field, inserting space for new values in the middle, and deleting values.

There are other methods that allow you to set only one value of several in the field and to set the field to contain one and only one value.

Two other methods can be used to make several changes to a multiple-value field without the overhead of copying values into and out of the fields. The startEditing() method returns the internal array of values in the field. It can be used to change (but not add or remove) any values in the array. The finishEditing() method indicates that the editing is done and notifies any sensors or engines that may be connected to the field.

SoMFields are written to file as a series of values separated by commas, all enclosed in square brackets. If the field has no values (() returns zero), then only the square brackets ("[ ]") are written. The last value may optionally be followed by a comma. Each field subtype defines how the values are written; for example, a field whose values are integers might be written as:

   [ 1, 2, 3, 4 ]

or:

   [ 1, 2, 3, 4, ]

Reference

OIV.Inventor.Fields Namespace

OIV.Inventor.Nodes.SoNode

OIV.Inventor.Engines.SoEngine

Inheritance Hierarchy