| PbNonLinearDataMapping2 Class |
Class to define non linear data mapping.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.MeshViz.GraphPbBase
OIV.MeshViz.GraphPbDataMapping
OIV.MeshViz.GraphPbNonLinearDataMapping2
Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.2.2.0 (10.16.2.0)
SyntaxThe PbNonLinearDataMapping2 type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PbNonLinearDataMapping2 | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| CopyFrom(PbBase) | Assignment operator. |
| CopyFrom(PbDataMapping) | Assignment operator. |
| CopyFrom(PbNonLinearDataMapping2) | Assignment operator. |
| EnableConnection | Activates/deactivates the mechanism of connection. |
| EnableThresholds | Enable/Disable the taking into account of threshold values. |
| EnableTransparency | Enable/Disable the taking into account of transparency. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetHLSColor(Single) | Gets HLS color associated with a value. |
| GetHLSColor(Single, Single) | Gets the HLS color and the transparency associated to a value. |
| GetMaxHLSThreshold(Single) | Gets the maximum threshold and its associated HLS color. |
| GetMaxHLSThreshold(Single, Single) | Gets the maximum threshold, its associated HLS color and transparency. |
| GetMaxRGBThreshold(Single) | Gets the maximum threshold and its associated RGB color. |
| GetMaxRGBThreshold(Single, Single) | Gets the maximum threshold, its associated RGB color and transparency. |
| GetMinHLSThreshold(Single) | Gets the minimum threshold and its associated HLS color. |
| GetMinHLSThreshold(Single, Single) | Gets the minimum threshold, its associated HLS color and transparency. |
| GetMinRGBThreshold(Single) | Gets the minimum threshold and its associated RGB color. |
| GetMinRGBThreshold(Single, Single) | Gets the minimum threshold, its associated RGB color and transparency. |
| GetRGBColor(Single) | Gets RGB color associated to a value. |
| GetRGBColor(Single, Single) | Gets the RGB color and the transparency associated with a value. |
| GetRGBColorsList | Gets the list of RGB colors defining the current non linear data mapping. |
| GetTransparencyList | Gets the list of transparencies defining the current non linear data mapping. |
| GetTransparencyValueDeletedParts | Gets a value that defines the following property : each primitive part of which transparency >= value, is deleted. |
| GetType | Returns the data mapping type. |
| GetValuesList | Gets the list of values defining the current non linear data mapping. |
| IsConnectionEnabled | Returns true if the connection mechanism is active, otherwise false. |
| IsTransparencyEnabled | Returns true if transparency is enabled, otherwise false. |
| SetMaxThreshold(Single) | Sets a maximum threshold. |
| SetMaxThreshold(Single, SbColor) | Calls SetMaxThreshold(threshold_max, cmax, 0.0). (Inherited from PbDataMapping.) |
| SetMaxThreshold(Single, Single) | Calls SetMaxThreshold(threshold_max, cmax, 0.0). (Inherited from PbDataMapping.) |
| SetMaxThreshold(Single, SbColor, Single) | Sets a maximum threshold, associated to a RGB color and a transparency value. |
| SetMaxThreshold(Single, Single, Single) | Sets a maximum threshold, associated to a HLS color and a transparency value. |
| SetMinThreshold(Single) | Sets a minimum threshold. |
| SetMinThreshold(Single, SbColor) | Calls SetMinThreshold(threshold_min, cmin, 0.0). (Inherited from PbDataMapping.) |
| SetMinThreshold(Single, Single) | Calls SetMinThreshold(threshold_min, cmin, 0.0). (Inherited from PbDataMapping.) |
| SetMinThreshold(Single, SbColor, Single) | Sets a minimum threshold, associated to a RGB color and a transparency value. |
| SetMinThreshold(Single, Single, Single) | Sets a minimum threshold, associated to a HLS color and a transparency value. |
| SetTransparencyValueDeletedParts | Sets a value that defines the following property : each primitive part of which transparency >= value, is deleted. |
| SetValues(PbNonLinearDataMapping2Types, Single, SbColor) | Sets non linear function for data mapping, with RGB color. |
| SetValues(PbNonLinearDataMapping2Types, Single, SbColor, Single) | Sets non linear function for data mapping, with RGB color and transparencies. |
| ThresholdsEnabled | Returns min=true if the minimum threshold is enabled, otherwise false. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Touch | Simulates the changing of an instance of this object, so all connected objects are informed of this change. |
RemarksThis object defines a non linear association between colors, transparencies and floating-point values. In other words, this association is defined by 2 functions F(c,v) and F(c,t):
F(c,v)(V) = C (with c being a color and v being a value).
F(t,v)(V) = T (with t being a transparency and v being a value).
There are two ways to express F(c,v)(V):F(c,v)(V) is non linear, but linear per level, so a list of values sorted in increasing order and a list of colors associated define this function. Thus, the association is (V1,C1), (V2,C2),...,(Vn,Cn) with V1 < V2 <...< Vn. For a given value vi, Vk <= vi <= Vk+1, the associated color ci is determined by a linear interpolation between (Vk,Ck) and (Vk+1,Ck+1).
F(c,v)(V) is defined by level, so a list of n values sorted in increasing order and a list of n+1 colors associated define this function. Thus, the association is C1, (V1,C2), (V2,C3),...,(Vn,Cn+1) with V1 < V2 <...< Vn. For a given value vi, Vk <= vi < Vk+1, the associated color ci is Ck+1. If vi < V1, the associated color ci is C1. In the two methods, the list of values is sorted in increasing order (and the associated colors also). By default, F(c,v)(V) is linear by level (LINEAR_PER_LEVEL), the number of colors and values is 2 with V1=0, V2=0, C1=(0,0,0) (black) and C2=(1,1,1) (white).
There are as well, two ways to express F(t,v)(V)
See Also