Click or drag to resize
PbNonLinearDataMapping2 Class

Class to define non linear data mapping.

Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.MeshViz.GraphPbBase
      OIV.MeshViz.GraphPbDataMapping
        OIV.MeshViz.GraphPbNonLinearDataMapping2

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class PbNonLinearDataMapping2 : PbDataMapping

The PbNonLinearDataMapping2 type exposes the following members.

Constructors
  NameDescription
Public methodPbNonLinearDataMapping2

Default constructor.

Top
Methods
  NameDescription
Public methodCopyFrom(PbBase)

Assignment operator.

(Inherited from PbBase.)
Public methodCopyFrom(PbDataMapping)

Assignment operator.

(Inherited from PbDataMapping.)
Public methodCopyFrom(PbNonLinearDataMapping2)

Assignment operator.

Public methodEnableConnection

Activates/deactivates the mechanism of connection.

(Inherited from PbBase.)
Public methodEnableThresholds

Enable/Disable the taking into account of threshold values.

(Inherited from PbDataMapping.)
Public methodEnableTransparency

Enable/Disable the taking into account of transparency.

(Inherited from PbDataMapping.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetHLSColor(Single)

Gets HLS color associated with a value.

(Inherited from PbDataMapping.)
Public methodGetHLSColor(Single, Single)

Gets the HLS color and the transparency associated to a value.

(Inherited from PbDataMapping.)
Public methodGetMaxHLSThreshold(Single)

Gets the maximum threshold and its associated HLS color.

(Inherited from PbDataMapping.)
Public methodGetMaxHLSThreshold(Single, Single)

Gets the maximum threshold, its associated HLS color and transparency.

(Inherited from PbDataMapping.)
Public methodGetMaxRGBThreshold(Single)

Gets the maximum threshold and its associated RGB color.

(Inherited from PbDataMapping.)
Public methodGetMaxRGBThreshold(Single, Single)

Gets the maximum threshold, its associated RGB color and transparency.

(Inherited from PbDataMapping.)
Public methodGetMinHLSThreshold(Single)

Gets the minimum threshold and its associated HLS color.

(Inherited from PbDataMapping.)
Public methodGetMinHLSThreshold(Single, Single)

Gets the minimum threshold, its associated HLS color and transparency.

(Inherited from PbDataMapping.)
Public methodGetMinRGBThreshold(Single)

Gets the minimum threshold and its associated RGB color.

(Inherited from PbDataMapping.)
Public methodGetMinRGBThreshold(Single, Single)

Gets the minimum threshold, its associated RGB color and transparency.

(Inherited from PbDataMapping.)
Public methodGetRGBColor(Single)

Gets RGB color associated to a value.

(Inherited from PbDataMapping.)
Public methodGetRGBColor(Single, Single)

Gets the RGB color and the transparency associated with a value.

(Inherited from PbDataMapping.)
Public methodGetRGBColorsList

Gets the list of RGB colors defining the current non linear data mapping.

Public methodGetTransparencyList

Gets the list of transparencies defining the current non linear data mapping.

Public methodGetTransparencyValueDeletedParts

Gets a value that defines the following property : each primitive part of which transparency >= value, is deleted.

(Inherited from PbDataMapping.)
Public methodGetType

Returns the data mapping type.

Public methodGetValuesList

Gets the list of values defining the current non linear data mapping.

Public methodIsConnectionEnabled

Returns true if the connection mechanism is active, otherwise false.

(Inherited from PbBase.)
Public methodIsTransparencyEnabled

Returns true if transparency is enabled, otherwise false.

(Inherited from PbDataMapping.)
Public methodSetMaxThreshold(Single)

Sets a maximum threshold.

(Inherited from PbDataMapping.)
Public methodSetMaxThreshold(Single, SbColor)
Calls SetMaxThreshold(threshold_max, cmax, 0.0).
(Inherited from PbDataMapping.)
Public methodSetMaxThreshold(Single, Single)
Calls SetMaxThreshold(threshold_max, cmax, 0.0).
(Inherited from PbDataMapping.)
Public methodSetMaxThreshold(Single, SbColor, Single)

Sets a maximum threshold, associated to a RGB color and a transparency value.

(Inherited from PbDataMapping.)
Public methodSetMaxThreshold(Single, Single, Single)

Sets a maximum threshold, associated to a HLS color and a transparency value.

(Inherited from PbDataMapping.)
Public methodSetMinThreshold(Single)

Sets a minimum threshold.

(Inherited from PbDataMapping.)
Public methodSetMinThreshold(Single, SbColor)
Calls SetMinThreshold(threshold_min, cmin, 0.0).
(Inherited from PbDataMapping.)
Public methodSetMinThreshold(Single, Single)
Calls SetMinThreshold(threshold_min, cmin, 0.0).
(Inherited from PbDataMapping.)
Public methodSetMinThreshold(Single, SbColor, Single)

Sets a minimum threshold, associated to a RGB color and a transparency value.

(Inherited from PbDataMapping.)
Public methodSetMinThreshold(Single, Single, Single)

Sets a minimum threshold, associated to a HLS color and a transparency value.

(Inherited from PbDataMapping.)
Public methodSetTransparencyValueDeletedParts

Sets a value that defines the following property : each primitive part of which transparency >= value, is deleted.

(Inherited from PbDataMapping.)
Public methodSetValues(PbNonLinearDataMapping2Types, Single, SbColor)

Sets non linear function for data mapping, with RGB color.

Public methodSetValues(PbNonLinearDataMapping2Types, Single, SbColor, Single)

Sets non linear function for data mapping, with RGB color and transparencies.

Public methodThresholdsEnabled

Returns min=true if the minimum threshold is enabled, otherwise false.

(Inherited from PbDataMapping.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTouch

Simulates the changing of an instance of this object, so all connected objects are informed of this change.

(Inherited from PbBase.)
Top
Remarks

This 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