| SoMFColorRGBA Class |
Multiple-value field containing any number of RGBA colors stored as four floats.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.FieldsSoField
OIV.Inventor.FieldsSoMField
OIV.Inventor.FieldsSoMFColorRGBA
Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.2.0 (10.16.2.0)
SyntaxThe SoMFColorRGBA type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoMFColorRGBA | 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 | 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(SbColorRGBA) | Calls Find(targetValue, false). |
| Find(SbColorRGBA, Boolean) | Finds the given targetValue in the array and returns the index of that value. |
| 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. |
| 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. |
| Set1HSVAValue(Int32, Single) | Sets one of N HSV plus Alpha colors from an array of 4 floats. |
| Set1HSVAValue(Int32, Single, Single, Single, Single) | Sets one of N HSV plus Alpha colors from 4 floats. |
| Set1Value(Int32, SbColorRGBA) | Obsolete. Sets the index'th value in the array to newValue. |
| Set1Value(Int32, SbVec4f) | Sets one of N RGBA colors from OIV.Inventor.SbVec4f. |
| Set1Value(Int32, Single) | Sets one of N RGBA colors from an array of 4 floats. |
| Set1Value(Int32, Single, Single, Single, Single) | Sets one of N RGBA colors from 4 floats. |
| SetHSVAValue(Single) | Sets the field to contain one and only one value, the given color (expressed as an array of HSV plus Alpha floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values. |
| SetHSVAValue(Single, Single, Single, Single) | Sets the field to contain one and only one value, the given color (expressed as HSV plus Alpha floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values. |
| 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(Single) | Sets the field to contain one and only one value, the given color (expressed as an array of RGBA floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values. |
| SetValue(SbColorRGBA) | Sets the first value in the array to newValue, and deletes. |
| SetValue(SbVec4f) | Sets the field to contain one and only one value, the given color (expressed as RGBA floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values. |
| SetValue(Single, Single, Single, Single) | Sets the field to contain one and only one value, the given color (expressed as RGBA floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values. |
| SetValues(Int32, SbColorRGBA) | Sets num values starting at index start to the values. |
| SetValues(Int32, Int32, Single) | Sets num RGBA values from an array of arrays of 4 floats. |
| 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. |
Operators| Name | Description | |
|---|---|---|
  | Equality | |
| Inequality |
Properties| 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. |
RemarksA multiple-value field that contains any number of RGBA colors, stored as instances of OIV.Inventor.SbColorRGBA. RGBA stands for red, green, blue and alpha. Values should be in the range 0 to 1. Alpha is the inverse of "transparency", in other words 0 is fully transparent and 1 is fully opaque.
Values can also be specified or queried in the HSV (hue, saturation and value) color space, but values are stored internally as RGBA values.
SoMFColorRGBAs are written to file as one or more RGBA quadruples of floating point numbers in standard scientific notation. When more than one value is present, all of the values are enclosed in square brackets and separated by commas. For example:
[ 1.0 0.0 0.0 0.5, 0 1 0 1, 0 0 1 .25 ]represents the three colors half transparent red, fully opeque green, and one quarter transparent blue.
Data copying:
SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The SetValuesBuffer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see OIV.Inventor.Fields.SoMFVec3f for more information and example code.
See Also