Click or drag to resize
PbDataMapping Class

Abstract class for data mapping.

Inheritance Hierarchy

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

The PbDataMapping type exposes the following members.

Methods
  NameDescription
Public methodCopyFrom(PbBase)

Assignment operator.

(Inherited from PbBase.)
Public methodCopyFrom(PbDataMapping)

Assignment operator.

Public methodEnableConnection

Activates/deactivates the mechanism of connection.

(Inherited from PbBase.)
Public methodEnableThresholds

Enable/Disable the taking into account of threshold values.

Public methodEnableTransparency

Enable/Disable the taking into account of transparency.

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.

Public methodGetHLSColor(Single, Single)

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

Public methodGetMaxHLSThreshold(Single)

Gets the maximum threshold and its associated HLS color.

Public methodGetMaxHLSThreshold(Single, Single)

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

Public methodGetMaxRGBThreshold(Single)

Gets the maximum threshold and its associated RGB color.

Public methodGetMaxRGBThreshold(Single, Single)

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

Public methodGetMinHLSThreshold(Single)

Gets the minimum threshold and its associated HLS color.

Public methodGetMinHLSThreshold(Single, Single)

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

Public methodGetMinRGBThreshold(Single)

Gets the minimum threshold and its associated RGB color.

Public methodGetMinRGBThreshold(Single, Single)

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

Public methodGetRGBColor(Single)

Gets RGB color associated to a value.

Public methodGetRGBColor(Single, Single)

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

Public methodGetTransparencyValueDeletedParts

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

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.

Public methodSetMaxThreshold(Single)

Sets a maximum threshold.

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

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

Public methodSetMaxThreshold(Single, Single, Single)

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

Public methodSetMinThreshold(Single)

Sets a minimum threshold.

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

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

Public methodSetMinThreshold(Single, Single, Single)

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

Public methodSetTransparencyValueDeletedParts

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

Public methodThresholdsEnabled

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

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

Data mapping defines an association between colors, transparencies and floating-point values. Giving transparencies is not compulsory. When they are not given, they are supposed to be equal to 0 , i.e. each color is opaque.

Whichever data mapping, two threshold values can be defined, threshold_min and threshold_max. One color (cmin) and one transparency (transp_min) are associated to threshold_min . As well, cmax and transp_max are associated to threshold_max. For a given value vi <= threshold_min, the associated color ci is cmin and the associated transparency ti is transp_min. As well, for a given value vi >= threshold_max, the associated color ci is cmax and the associated transparency ti is transp_max.

By default min and max thresholds are disabled, threshold_min = 0 and threshold_max = 1 and no color is associated to threshold_min and threshold_max. Each part of primitive of which transparency is greater or equal 0.95 is deleted. This default value can be changed by the method OIV.MeshViz.Graph.PbDataMapping.SetTransparencyValueDeletedParts(System.Single).

See Also