| SoSFArray3D Class |
Field containing a 3D array value.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.FieldsSoField
OIV.Inventor.FieldsSoSField
OIV.Inventor.FieldsSoSFArray
OIV.Inventor.FieldsSoSFArray3D
Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoSFArray3D type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoSFArray3D | 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(SoSFArray) | Copy from another field of same type. |
| CopyFrom(SoSFArray3D) | 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 | (Overrides SoSFArrayEquals(Object).) |
| 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. |
| 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. |
| GetDataType | Returns the data type of the array. |
| 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.) |
| GetNumConnections | Returns the number of connections to this field. |
| GetNumSigBits | Returns the number of significant bits. |
| GetSize | Returns the dimensions of the array. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | Returns a read-only pointer to the array's values . |
| GetValue(SbVec3i32, SbDataType) | Returns a read-only pointer to the array's values and its dimensions and data type. |
| GetValueSize | Gets the 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. |
| IsEmpty | Returns true if the current array is empty. |
| IsIgnored | Gets the ignore flag for this field. |
| IsNeverWrite | Returns the "neverWrite" flag. |
| 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. |
| SetNeverWrite | Sets the "neverWrite" flag. |
| SetValue(SbVec3i32, SbDataType, SbNativeArrayByte) | Calls SetValue(size, dataType, data, OIV.Inventor.Fields.SoSFArray.CopyPolicies( .SoSFArray.COPY )). (Inherited from SoSFArray.) |
| SetValue(SbVec3i32, SbDataType, SbNativeArrayByte, SoSFArrayCopyPolicies) | Fill the array with data of the specified dimensions and type using the specified copy policy. |
| SetValue(SbVec3i32, SbDataType, UInt32, SbNativeArrayByte, SoSFArrayCopyPolicies) | Fill the array with data of the specified dimensions and type using the specified copy policy. |
| StartEditing | Returns a pointer to the internally maintained array that can be modified. |
| 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. |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
RemarksThis field contains a 3D array of values of a specified type. The OIV.Inventor.Fields.SoSFArray3D.SetValue(OIV.Inventor.SbVec3i32, OIV.Inventor.SbDataType, System.UInt32, OIV.Inventor.Generic.SbNativeArray{{System.Byte}}, OIV.Inventor.Fields.SoSFArray.CopyPolicies) method allows you to specify the dimensions and type of data the array will contain, as well as the number of significant bits. The CopyPolicy allows you to control whether Open Inventor will make a copy of the data and, if not, whether the application or Open Inventor is responsible for managing the memory.
In ASCII format, an OIV.Inventor.Fields.SoSFArray3D is written to file in the following format:
Three numbers define the dimensions of the array
One string defines the type of the data:
BYTE for signed bytes
UBYTE for unsigned bytes
SHORT for signed shorts
USHORT for unsigned shorts
INT32 for signed 32 bits ints
UINT32 for unsigned 32 bits ints
FLOAT for floating point values
A list of values in decimal, hexadecimal, or octal format for integers or in standard scientific notation for float. Numbers are separated by a blank (space, tab, return...).
One number defines the number of significant bits
2 2 2 UBYTE 0 1 2 3 4 5 6 7 8 * \verbatim * * An SoSFArray3D may be empty or contain only dimension and type information, * but no data values. With no data values the previous example would be * written with the prefix "NODATA" like this: * \verbatim NODATA 2 2 2 UBYTE 8
See Also