| SbColor Structure |
Color vector class.
Namespace: OIV.Inventor
Assembly: OIV.Inventor.SbLinear (in OIV.Inventor.SbLinear.dll) Version: 2024.2.2.Release.778f4cc64de03c89c1282c66aa1f73c0e9a1408b
SyntaxThe SbColor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SbColor(Single) |
Constructor that takes an array of 3 floats.
|
| SbColor(SbVec3f) |
Constructor that takes a SbVec3f value.
|
| SbColor(Single, Single, Single) |
Constructor that takes 3 floats.
|
Methods| Name | Description | |
|---|---|---|
| Equals |
Returns a value indicating whether this instance is equal to a specified object.
(Overrides ValueTypeEquals(Object).) |
| GetHashCode |
Returns the hash code for the value of this instance.
(Overrides ValueTypeGetHashCode.) |
 | GetHSVColor |
Gets a color vector from 3 HSV (hue, saturation, and value) components. |
| GetHSVValue(Single) |
Fill an array of 3 HSV components. |
| GetHSVValue(Single, Single, Single) |
Returns 3 individual HSV components.
|
| GetPackedValue |
Returns an RGBA packed color value, derived from the color vector
with a transparency value to 0 (means no transparency).
|
| GetPackedValue(Single) |
Returns an RGBA packed color value, derived from the color vector
and the passed transparency value.
|
| GetRGBValue(Single) |
Fill an array of 3 RGB components.
|
| GetRGBValue(Single, Single, Single) |
Returns 3 individual RGB components.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetHSVValue(Single) |
Sets value of color vector from array of 3 HSV components.
|
| SetHSVValue(Single, Single, Single) |
Sets value of color vector from 3 HSV (hue, saturation, and value) components. |
| SetPackedValue |
Sets value of color vector from an RGBA packed color value. |
| SetRGBValue(Single) |
Sets value of color vector from array of 3 RGB components.
|
| SetRGBValue(Single, Single, Single) |
Sets value of color vector from 3 RGB (Red, Green, and Blue) components.
|
| ToString |
Converts this SbColor structure to a human readable string.
(Overrides ValueTypeToString.) |
Operators| Name | Description | |
|---|---|---|
 | Addition |
Additive (+) operator. Performs the addition between the vectors c1
and c2.
|
| Division(SbColor, SbColor) |
The division operator (/) divides each components of vector c1
by components of vector c2.
|
| Division(SbColor, Single) |
The division operator (/) divides each components of vector c1
by d.
|
| Equality |
The equality operator.
|
| (SbColor to SbColorRGBA) |
Explicit cast operator to SbColorRGBA.
|
| (SbColor to SbVec3f) |
Implicit cast operator to SbVec3f.
|
| Inequality |
The inequality operator.
|
| Multiply(Single, SbColor) |
The multiplication operator (*), which applies on each component of
c1 the d multiplicative factor.
|
| Multiply(SbColor, SbColor) |
The multiplication operator (*), which multiply each component of
c1 by each component of vector c2.
|
| Multiply(SbColor, Single) |
The multiplication operator (*), which applies on each component of
c1 the d multiplicative factor.
|
| Subtraction |
Subtraction (–) operator. Performs the difference between the vectors c1
and c2.
|
| UnaryNegation |
The unary negation operator (-). Negates each vector component.
|
Properties| Name | Description | |
|---|---|---|
 | B |
Gets or sets the blue component of the color.
|
| G |
Gets or sets the green component of the color.
|
| Item |
Gets or sets the element at the specified index.
|
| R |
Gets or sets the red component of the color.
|
Remarks This class is used to represent an RGB color.
Each component of the vector is a floating-point number between 0.0 and 1.0.
There are routines to convert back and forth between RGB and HSV.
See Also