SoMFInstanceParameter Class |
Multiple-value field containing any number of OIV.Inventor.Nodes.SoInstanceParameter nodes.
Namespace: OIV.Inventor.Fields
The SoMFInstanceParameter type exposes the following members.
Name | Description | |
---|---|---|
SoMFInstanceParameter | Default constructor. |
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. | |
DeleteValues(Int32) | Calls DeleteValues(start, -1). (Inherited from SoMField.) | |
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). | |
DisableDeleteValues | Temporary disable value deleting. | |
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).) | |
Find(SoInstanceParameter) | Calls Find(targetValue, false). | |
Find(SoInstanceParameter, Boolean) | Finds the given targetValue in the array and returns the index of that value. | |
FindParameterByName | Returns the first parameter with the specified name. | |
FinishEditing | Indicates that batch edits have finished. | |
Get | Returns the value of the field in the Open Inventor file format, even if the field has its default value. | |
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. | |
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.) | |
GetNum | Obsolete. Returns the number of values currently in the field. | |
GetNumConnections | Returns the number of connections to this field. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValues | Returns a pointer into the array of values in the field, starting at index start. | |
GetValueSize | Gets the size of the value. | |
InsertSpace | Inserts space for num values at index start . | |
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. | |
RemoveParameterByName | Remove the instance parameter with the specified name. | |
Set | Sets the field to the given value, which is an ASCII string in the Open Inventor file format. | |
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. | |
Set1Value | Obsolete. Sets the index'th value in the array to newValue. | |
SetIgnored | Sets the ignore flag for this field. | |
SetNum | Obsolete. Forces this field to have exactly num values, inserting or deleting values as necessary. | |
SetValue | Sets the first value in the array to newValue, and deletes. | |
SetValues | Sets num values starting at index start to the values. | |
SetValuesBuffer | Sets the field to contain the values stored in userData. | |
StartEditing | Returns a pointer to the internally maintained array that can be modified. | |
ToString |
Converts this SoMFField structure to a human readable string.
(Inherited from SoMField.) | |
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. |
Name | Description | |
---|---|---|
Equality | ||
Inequality |
Name | Description | |
---|---|---|
Count | Returns the number of values currently in the field. | |
IsUserDefinedBuffer | (Inherited from SoMField.) | |
Item | Returns the i'th value of the field. |
This field contains a set of OIV.Inventor.Nodes.SoInstanceParameter instances.
An OIV.Inventor.Fields.SoMFInstanceParameter is written to file as one or more SoInstanceParameters. When more than one value is present, all of the values are enclosed in square brackets and separated by commas.
Convenience methods, for example (), are provide to more easily set commonly used instance parameters.
Note |
---|
Node available since Open Inventor 9.5 |