PbDataMapping Class

PbDataMapping Class

Abstract class for data mapping.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.MeshViz.GraphPbBase
      OIV.MeshViz.GraphPbDataMapping
        OIV.MeshViz.GraphPbLinearDataMapping
        OIV.MeshViz.GraphPbNonLinearDataMapping
        OIV.MeshViz.GraphPbNonLinearDataMapping2

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class PbDataMapping : PbBase

Public Class PbDataMapping
	Inherits PbBase

public ref class PbDataMapping : public PbBase

type PbDataMapping =  
    class
        inherit PbBase
    end

The PbDataMapping type exposes the following members.

Methods

	Name	Description
	CopyFrom(PbBase)	Assignment operator. (Inherited from PbBase.)
	CopyFrom(PbDataMapping)	Assignment operator.
	EnableConnection	Activates/deactivates the mechanism of connection. (Inherited from PbBase.)
	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.
	GetTransparencyValueDeletedParts	Gets a value that defines the following property : each primitive part of which transparency >= value, is deleted.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConnectionEnabled	Returns true if the connection mechanism is active, otherwise false. (Inherited from PbBase.)
	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).
	SetMaxThreshold(Single, Single)	Calls SetMaxThreshold(threshold_max, cmax, 0.0).
	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).
	SetMinThreshold(Single, Single)	Calls SetMinThreshold(threshold_min, cmin, 0.0).
	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.
	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. (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).

Reference

OIV.MeshViz.Graph Namespace