helper for color map editor handling More...

#include <vtkSMColorMapEditorHelper.h>

Static Public Member Functions
static bool	HideScalarBarIfNotNeeded (vtkSMProxy repr, vtkSMProxy view)
	While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation. More...


static vtkSMProxy *	GetLUTProxy (vtkSMProxy proxy, vtkSMProxy view)
	Returns the lut proxy of this representation in the given view. More...

static vtkSMProxy *	GetBlockLUTProxy (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector)
	Returns the lut proxy of this representation in the given view. More...


static bool	GetUsingScalarColoring (vtkSMProxy *proxy)
	Returns true if scalar coloring is enabled. More...

static bool	GetBlockUsingScalarColoring (vtkSMProxy *proxy, const std::string &blockSelector)
	Returns true if scalar coloring is enabled. More...

static bool	GetAnyBlockUsingScalarColoring (vtkSMProxy *proxy)
	Returns true if scalar coloring is enabled. More...


static void	SetupLookupTable (vtkSMProxy *proxy)
	Given the input registered representation `proxy`, sets up a lookup table associated with the representation if a scalar bar is being used for `proxy`. More...

static void	SetupBlockLookupTable (vtkSMProxy *proxy, const std::string &blockSelector)
	Given the input registered representation `proxy`, sets up a lookup table associated with the representation if a scalar bar is being used for `proxy`. More...


static bool	UpdateScalarBarRange (vtkSMProxy proxy, vtkSMProxy view, bool deleteRange)
	Updates the ranges shown in the scalar bar. More...

static bool	UpdateBlockScalarBarRange (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector, bool deleteRange)
	Updates the ranges shown in the scalar bar. More...


static bool	SetScalarColoring (vtkSMProxy proxy, const char arrayName, int attributeType)
	Enable/disable scalar coloring using the specified array. More...

static bool	SetBlockScalarColoring (vtkSMProxy proxy, const std::string &blockSelector, const char arrayName, int attributeType)
	Enable/disable scalar coloring using the specified array. More...


static bool	SetScalarColoring (vtkSMProxy proxy, const char arrayName, int attributeType, int component)
	Enable/disable scalar coloring using the specified array. More...

static bool	SetBlockScalarColoring (vtkSMProxy proxy, const std::string &blockSelector, const char arrayName, int attributeType, int component)
	Enable/disable scalar coloring using the specified array. More...


static bool	RescaleTransferFunctionToDataRange (vtkSMProxy *proxy, bool extend=false, bool force=true)
	Rescales the color transfer function and opacity transfer function using the current data range. More...

static bool	RescaleBlockTransferFunctionToDataRange (vtkSMProxy *proxy, const std::string &blockSelector, bool extend=false, bool force=true)
	Rescales the color transfer function and opacity transfer function using the current data range. More...


static bool	RescaleTransferFunctionToDataRange (vtkSMProxy proxy, const char arrayName, int attributeType, bool extend=false, bool force=true)
	Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array. More...

static bool	RescaleBlockTransferFunctionToDataRange (vtkSMProxy proxy, const std::string &blockSelector, const char arrayName, int attributeType, bool extend=false, bool force=true)
	Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array. More...


static bool	RescaleTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy)
	Rescales the color transfer function and opacity transfer function using the current data range over time. More...

static bool	RescaleBlockTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy, const std::string &blockSelector)
	Rescales the color transfer function and opacity transfer function using the current data range over time. More...


static bool	RescaleTransferFunctionToDataRangeOverTime (vtkSMProxy proxy, const char arrayName, int attributeType)
	Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. More...

static bool	RescaleBlockTransferFunctionToDataRangeOverTime (vtkSMProxy proxy, const std::string &blockSelector, const char arrayName, int attributeType)
	Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array. More...


static bool	RescaleTransferFunctionToVisibleRange (vtkSMProxy proxy, vtkSMProxy view)
	Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements. More...

static bool	RescaleTransferFunctionToVisibleRange (vtkSMProxy proxy, vtkSMProxy view, const char *arrayName, int attributeType)
	Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements. More...

static bool	RescaleBlockTransferFunctionToVisibleRange (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector)
	Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements. More...

static bool	RescaleBlockTransferFunctionToVisibleRange (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector, const char *arrayName, int attributeType)
	Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements. More...


static bool	SetScalarBarVisibility (vtkSMProxy proxy, vtkSMProxy view, bool visible)
	Set the scalar bar visibility. More...

static bool	SetBlockScalarBarVisibility (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector, bool visible)
	Set the scalar bar visibility. More...


static bool	IsScalarBarVisible (vtkSMProxy repr, vtkSMProxy view)
	Check scalar bar visibility. More...

static bool	IsBlockScalarBarVisible (vtkSMProxy repr, vtkSMProxy view, const std::string &blockSelector)
	Check scalar bar visibility. More...


static vtkPVArrayInformation *	GetArrayInformationForColorArray (vtkSMProxy *proxy, bool checkRepresentedData=true)
	Returns the array information for the data array used for scalar coloring, from input data. More...

static vtkPVArrayInformation *	GetBlockArrayInformationForColorArray (vtkSMProxy *proxy, const std::string &blockSelector, bool checkRepresentedData=true)
	Returns the array information for the data array used for scalar coloring, from input data. More...


static std::string	GetDecoratedArrayName (vtkSMProxy *proxy, const std::string &arrayName)
	In case of UseSeparateColorMap enabled, this function prefix the given arrayName with unique identifier, otherwise it acts as a passthrough. More...

static std::string	GetBlockDecoratedArrayName (vtkSMProxy *proxy, const std::string &blockSelector, const std::string &arrayName)
	In case of UseSeparateColorMap enabled, this function prefix the given arrayName with unique identifier, otherwise it acts as a passthrough. More...


static vtkPVProminentValuesInformation *	GetProminentValuesInformationForColorArray (vtkSMProxy *proxy, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false)
	Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More...

static vtkPVProminentValuesInformation *	GetBlockProminentValuesInformationForColorArray (vtkSMProxy *proxy, const std::string &blockSelector, double uncertaintyAllowed=1e-6, double fraction=1e-3, bool force=false)
	Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any. More...


static int	GetEstimatedNumberOfAnnotationsOnScalarBar (vtkSMProxy proxy, vtkSMProxy view)
	Get an estimated number of annotation shown on this representation scalar bar. More...

static int	GetBlockEstimatedNumberOfAnnotationsOnScalarBar (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector)
	Get an estimated number of annotation shown on this representation scalar bar. More...


static int	IsScalarBarStickyVisible (vtkSMProxy proxy, vtkSMProxy view)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...

static int	IsBlockScalarBarStickyVisible (vtkSMProxy proxy, vtkSMProxy view, const std::string &blockSelector)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...

static void	SetBlockColorArray (vtkSMProxy *proxy, const std::string &blockSelector, int attributeType, std::string arrayName)
	Set/Get the block color array name. More...

static std::pair< int, std::string >	GetBlockColorArray (vtkSMProxy *proxy, const std::string &blockSelector)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...

static int	GetBlockColorArrayAssociation (vtkSMProxy *proxy, const std::string &blockSelector)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...

static std::string	GetBlockColorArrayName (vtkSMProxy *proxy, const std::string &blockSelector)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...


static void	SetBlockUseSeparateColorMap (vtkSMProxy *proxy, const std::string &blockSelector, bool use)
	Set/Get if we should use a separate color map for this block. More...

static bool	GetBlockUseSeparateColorMap (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get if we should use a separate color map for this block. More...

Static Protected Member Functions
static bool	SetScalarColoringInternal (vtkSMProxy proxy, const char arrayName, int attributeType, bool useComponent, int component)
	Internal method to set scalar coloring, do not use directly. More...

static bool	SetBlockScalarColoringInternal (vtkSMProxy proxy, const std::string &blockSelector, const char arrayName, int attributeType, bool useComponent, int component)


static bool	RescaleTransferFunctionToDataRange (vtkSMProxy proxy, vtkPVArrayInformation info, bool extend=false, bool force=true)
	Rescales transfer function ranges using the array information provided. More...

static bool	RescaleBlockTransferFunctionToDataRange (vtkSMProxy proxy, const std::string &blockSelector, vtkPVArrayInformation info, bool extend=false, bool force=true)
	Rescales transfer function ranges using the array information provided. More...


static void	SetBlockLookupTable (vtkSMProxy proxy, const std::string &blockSelector, vtkSMProxy lutProxy)
	Set/Get/Remove the block lookup table proxy. More...

static vtkSMProxy *	GetBlockLookupTable (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get/Remove the block lookup table proxy. More...

static void	RemoveBlockLookupTable (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get/Remove the block lookup table proxy. More...


static vtkSMProxy *	GetLastLUTProxy (vtkSMProxy *proxy)
	Used as a memory of what was the last LUT proxy linked to this representation. More...

static void	SetLastLUTProxy (vtkSMProxy proxy, vtkSMProxy lutProxy)
	Used as a memory of what was the last LUT proxy linked to this representation. More...

static vtkSMProxy *	GetLastBlockLUTProxy (vtkSMProxy *proxy, const std::string &blockSelector)
	Used as a memory of what was the last LUT proxy linked to this representation. More...

static void	SetLastBlockLUTProxy (vtkSMProxy proxy, const std::string &blockSelector, vtkSMProxy lutProxy)
	Used as a memory of what was the last LUT proxy linked to this representation. More...

Friends
class	vtkSMPVRepresentationProxy

Detailed Description

helper for color map editor handling

It provides helper functions for controlling transfer functions, scalar coloring, etc. Scalar bar controlling is still working for RenderView only for now, as it's controlling the widget.

Definition at line 23 of file vtkSMColorMapEditorHelper.h.

Member Function Documentation

◆ GetLUTProxy()

static vtkSMProxy* vtkSMColorMapEditorHelper::GetLUTProxy	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

static

Returns the lut proxy of this representation in the given view.

This method will return nullptr if no lut proxy exists in this view.

◆ GetBlockLUTProxy()

static vtkSMProxy* vtkSMColorMapEditorHelper::GetBlockLUTProxy	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector
	)

static

Returns the lut proxy of this representation in the given view.

This method will return nullptr if no lut proxy exists in this view.

◆ GetUsingScalarColoring()

static bool vtkSMColorMapEditorHelper::GetUsingScalarColoring ( vtkSMProxy * proxy )

static

Returns true if scalar coloring is enabled.

This checks whether a property named "ColorArrayName" exists and has a non-empty string. This does not check for the validity of the array.

◆ GetBlockUsingScalarColoring()

static bool vtkSMColorMapEditorHelper::GetBlockUsingScalarColoring	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

static

Returns true if scalar coloring is enabled.

This checks whether a property named "ColorArrayName" exists and has a non-empty string. This does not check for the validity of the array.

◆ GetAnyBlockUsingScalarColoring()

static bool vtkSMColorMapEditorHelper::GetAnyBlockUsingScalarColoring ( vtkSMProxy * proxy )

static

Returns true if scalar coloring is enabled.

This checks whether a property named "ColorArrayName" exists and has a non-empty string. This does not check for the validity of the array.

◆ SetupLookupTable()

static void vtkSMColorMapEditorHelper::SetupLookupTable ( vtkSMProxy * proxy )

static

Given the input registered representation proxy, sets up a lookup table associated with the representation if a scalar bar is being used for proxy.

◆ SetupBlockLookupTable()

static void vtkSMColorMapEditorHelper::SetupBlockLookupTable	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

static

Given the input registered representation proxy, sets up a lookup table associated with the representation if a scalar bar is being used for proxy.

◆ UpdateScalarBarRange()

static bool vtkSMColorMapEditorHelper::UpdateScalarBarRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		bool	deleteRange
	)

static

Updates the ranges shown in the scalar bar.

If deleteRange is true, then the range stored for current representation proxy is deleted. This should be done when the scalar bar gets separated or becomes not visible. If deleteRange is false, then the range stored for current representation proxy is updated with the new range value.

◆ UpdateBlockScalarBarRange()

static bool vtkSMColorMapEditorHelper::UpdateBlockScalarBarRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector,
		bool	deleteRange
	)

static

Updates the ranges shown in the scalar bar.

If deleteRange is true, then the range stored for current representation proxy is deleted. This should be done when the scalar bar gets separated or becomes not visible. If deleteRange is false, then the range stored for current representation proxy is updated with the new range value.

◆ SetScalarColoring() [1/2]

static bool vtkSMColorMapEditorHelper::SetScalarColoring	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType
	)

static

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. attributeType must be one of vtkDataObject::AttributeTypes.

◆ SetBlockScalarColoring() [1/2]

static bool vtkSMColorMapEditorHelper::SetBlockScalarColoring	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType
	)

static

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. attributeType must be one of vtkDataObject::AttributeTypes.

◆ SetScalarColoring() [2/2]

static bool vtkSMColorMapEditorHelper::SetScalarColoring	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType,
		int	component
	)

static

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. attributeType must be one of vtkDataObject::AttributeTypes. component enables choosing a component to color with, -1 will change to Magnitude, >=0 will change to corresponding component.

◆ SetBlockScalarColoring() [2/2]

static bool vtkSMColorMapEditorHelper::SetBlockScalarColoring	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType,
		int	component
	)

static

Enable/disable scalar coloring using the specified array.

This will set up a color and opacity transfer functions using vtkSMTransferFunctionProxy instance. If arrayName is nullptr, then scalar coloring is turned off. attributeType must be one of vtkDataObject::AttributeTypes. component enables choosing a component to color with, -1 will change to Magnitude, >=0 will change to corresponding component.

◆ RescaleTransferFunctionToDataRange() [1/3]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		bool	extend = `false`,
		bool	force = `true`
	)

static

Rescales the color transfer function and opacity transfer function using the current data range.

Returns true if rescale was successful. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

◆ RescaleBlockTransferFunctionToDataRange() [1/3]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		bool	extend = `false`,
		bool	force = `true`
	)

static

Rescales the color transfer function and opacity transfer function using the current data range.

Returns true if rescale was successful. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

◆ RescaleTransferFunctionToDataRange() [2/3]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType,
		bool	extend = `false`,
		bool	force = `true`
	)

static

Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array.

Returns true if rescale was successful. attributeType must be one of vtkDataObject::AttributeTypes. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

◆ RescaleBlockTransferFunctionToDataRange() [2/3]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType,
		bool	extend = `false`,
		bool	force = `true`
	)

static

Rescales the color transfer function and opacity transfer function using the current data range for the chosen data-array.

Returns true if rescale was successful. attributeType must be one of vtkDataObject::AttributeTypes. If extend is true (false by default), the transfer function range will only be extended as needed to fit the data range. If force is false (true by default), then the transfer function range is not changed if locked.

◆ RescaleTransferFunctionToDataRangeOverTime() [1/2]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToDataRangeOverTime ( vtkSMProxy * proxy )

static

Rescales the color transfer function and opacity transfer function using the current data range over time.

Returns true if rescale was successful.

◆ RescaleBlockTransferFunctionToDataRangeOverTime() [1/2]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToDataRangeOverTime	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

static

Rescales the color transfer function and opacity transfer function using the current data range over time.

Returns true if rescale was successful.

◆ RescaleTransferFunctionToDataRangeOverTime() [2/2]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToDataRangeOverTime	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType
	)

static

Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array.

Returns true if rescale was successful. attributeType must be one of vtkDataObject::AttributeTypes,

◆ RescaleBlockTransferFunctionToDataRangeOverTime() [2/2]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToDataRangeOverTime	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType
	)

static

Rescales the color transfer function and opacity transfer function using the current data range over time for the chosen data-array.

Returns true if rescale was successful. attributeType must be one of vtkDataObject::AttributeTypes,

◆ RescaleTransferFunctionToVisibleRange() [1/2]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToVisibleRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

static

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements.

◆ RescaleTransferFunctionToVisibleRange() [2/2]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToVisibleRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const char *	arrayName,
		int	attributeType
	)

static

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements.

◆ RescaleBlockTransferFunctionToVisibleRange() [1/2]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToVisibleRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector
	)

static

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements.

◆ RescaleBlockTransferFunctionToVisibleRange() [2/2]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToVisibleRange	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType
	)

static

Rescales the color transfer function and the opacity transfer function using the current data range, limited to the current visible elements.

◆ SetScalarBarVisibility()

static bool vtkSMColorMapEditorHelper::SetScalarBarVisibility	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		bool	visible
	)

static

Set the scalar bar visibility.

This will create a new scalar bar as needed. Scalar bar is only shown if scalar coloring is indeed being used.

◆ SetBlockScalarBarVisibility()

static bool vtkSMColorMapEditorHelper::SetBlockScalarBarVisibility	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector,
		bool	visible
	)

static

Set the scalar bar visibility.

This will create a new scalar bar as needed. Scalar bar is only shown if scalar coloring is indeed being used.

◆ HideScalarBarIfNotNeeded()

static bool vtkSMColorMapEditorHelper::HideScalarBarIfNotNeeded	(	vtkSMProxy *	repr,
		vtkSMProxy *	view
	)

static

While SetScalarBarVisibility can be used to hide a scalar bar, it will always simply hide the scalar bar even if its being used by some other representation.

Use this method instead to only hide the scalar/color bar if no other visible representation in the view is mapping data using the scalar bar.

◆ IsScalarBarVisible()

static bool vtkSMColorMapEditorHelper::IsScalarBarVisible	(	vtkSMProxy *	repr,
		vtkSMProxy *	view
	)

static

Check scalar bar visibility.

Return true if the scalar bar for this representation and view is visible, return false otherwise.

◆ IsBlockScalarBarVisible()

static bool vtkSMColorMapEditorHelper::IsBlockScalarBarVisible	(	vtkSMProxy *	repr,
		vtkSMProxy *	view,
		const std::string &	blockSelector
	)

static

Check scalar bar visibility.

Return true if the scalar bar for this representation and view is visible, return false otherwise.

◆ GetArrayInformationForColorArray()

static vtkPVArrayInformation* vtkSMColorMapEditorHelper::GetArrayInformationForColorArray	(	vtkSMProxy *	proxy,
		bool	checkRepresentedData = `true`
	)

static

Returns the array information for the data array used for scalar coloring, from input data.

If checkRepresentedData is true, it will also check in the represented data. Default is true. If none is found, returns nullptr.

◆ GetBlockArrayInformationForColorArray()

static vtkPVArrayInformation* vtkSMColorMapEditorHelper::GetBlockArrayInformationForColorArray	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		bool	checkRepresentedData = `true`
	)

static

Returns the array information for the data array used for scalar coloring, from input data.

If checkRepresentedData is true, it will also check in the represented data. Default is true. If none is found, returns nullptr.

◆ GetDecoratedArrayName()

static std::string vtkSMColorMapEditorHelper::GetDecoratedArrayName	(	vtkSMProxy *	proxy,
		const std::string &	arrayName
	)

static

In case of UseSeparateColorMap enabled, this function prefix the given arrayName with unique identifier, otherwise it acts as a passthrough.

◆ GetBlockDecoratedArrayName()

static std::string vtkSMColorMapEditorHelper::GetBlockDecoratedArrayName	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const std::string &	arrayName
	)

static

In case of UseSeparateColorMap enabled, this function prefix the given arrayName with unique identifier, otherwise it acts as a passthrough.

◆ GetProminentValuesInformationForColorArray()

static vtkPVProminentValuesInformation* vtkSMColorMapEditorHelper::GetProminentValuesInformationForColorArray	(	vtkSMProxy *	proxy,
		double	uncertaintyAllowed = `1e-6`,
		double	fraction = `1e-3`,
		bool	force = `false`
	)

static

Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.

Otherwise returns nullptr.

◆ GetBlockProminentValuesInformationForColorArray()

static vtkPVProminentValuesInformation* vtkSMColorMapEditorHelper::GetBlockProminentValuesInformationForColorArray	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		double	uncertaintyAllowed = `1e-6`,
		double	fraction = `1e-3`,
		bool	force = `false`
	)

static

Call vtkSMRepresentationProxy::GetProminentValuesInformation() for the array used for scalar color, if any.

Otherwise returns nullptr.

◆ GetEstimatedNumberOfAnnotationsOnScalarBar()

static int vtkSMColorMapEditorHelper::GetEstimatedNumberOfAnnotationsOnScalarBar	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

static

Get an estimated number of annotation shown on this representation scalar bar.

◆ GetBlockEstimatedNumberOfAnnotationsOnScalarBar()

static int vtkSMColorMapEditorHelper::GetBlockEstimatedNumberOfAnnotationsOnScalarBar	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector
	)

static

Get an estimated number of annotation shown on this representation scalar bar.

◆ IsScalarBarStickyVisible()

static int vtkSMColorMapEditorHelper::IsScalarBarStickyVisible	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

static

Checks if the scalar bar of this representation in view is sticky visible, i.e.

should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.

◆ IsBlockScalarBarStickyVisible()

static int vtkSMColorMapEditorHelper::IsBlockScalarBarStickyVisible	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::string &	blockSelector
	)

static

Checks if the scalar bar of this representation in view is sticky visible, i.e.

should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.

◆ SetBlockColorArray()

static void vtkSMColorMapEditorHelper::SetBlockColorArray	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		int	attributeType,
		std::string	arrayName
	)

static

Set/Get the block color array name.

◆ GetBlockColorArray()

static std::pair<int, std::string> vtkSMColorMapEditorHelper::GetBlockColorArray	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

static

Checks if the scalar bar of this representation in view is sticky visible, i.e.

should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.

◆ GetBlockColorArrayAssociation()

static int vtkSMColorMapEditorHelper::GetBlockColorArrayAssociation	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

inlinestatic

Checks if the scalar bar of this representation in view is sticky visible, i.e.

should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.

Definition at line 261 of file vtkSMColorMapEditorHelper.h.

◆ GetBlockColorArrayName()

static std::string vtkSMColorMapEditorHelper::GetBlockColorArrayName	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

inlinestatic

Checks if the scalar bar of this representation in view is sticky visible, i.e.

should be visible whenever this representation is also visible. It returns 1 if the scalar bar is sticky visible, 0 other wise. If any problem is encountered, for example if view == nullptr, or if the scalar bar representation is not instanciated / found, it returns -1.

Definition at line 265 of file vtkSMColorMapEditorHelper.h.

◆ SetBlockUseSeparateColorMap()

static void vtkSMColorMapEditorHelper::SetBlockUseSeparateColorMap	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		bool	use
	)

static

Set/Get if we should use a separate color map for this block.

◆ GetBlockUseSeparateColorMap()

static bool vtkSMColorMapEditorHelper::GetBlockUseSeparateColorMap	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

static

Set/Get if we should use a separate color map for this block.

◆ RescaleTransferFunctionToDataRange() [3/3]

static bool vtkSMColorMapEditorHelper::RescaleTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		vtkPVArrayInformation *	info,
		bool	extend = `false`,
		bool	force = `true`
	)

staticprotected

Rescales transfer function ranges using the array information provided.

◆ RescaleBlockTransferFunctionToDataRange() [3/3]

static bool vtkSMColorMapEditorHelper::RescaleBlockTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		vtkPVArrayInformation *	info,
		bool	extend = `false`,
		bool	force = `true`
	)

staticprotected

Rescales transfer function ranges using the array information provided.

◆ SetBlockLookupTable()

static void vtkSMColorMapEditorHelper::SetBlockLookupTable	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		vtkSMProxy *	lutProxy
	)

staticprotected

Set/Get/Remove the block lookup table proxy.

◆ GetBlockLookupTable()

static vtkSMProxy* vtkSMColorMapEditorHelper::GetBlockLookupTable	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

staticprotected

Set/Get/Remove the block lookup table proxy.

◆ RemoveBlockLookupTable()

static void vtkSMColorMapEditorHelper::RemoveBlockLookupTable	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

staticprotected

Set/Get/Remove the block lookup table proxy.

◆ SetScalarColoringInternal()

static bool vtkSMColorMapEditorHelper::SetScalarColoringInternal	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType,
		bool	useComponent,
		int	component
	)

staticprotected

Internal method to set scalar coloring, do not use directly.

◆ SetBlockScalarColoringInternal()

static bool vtkSMColorMapEditorHelper::SetBlockScalarColoringInternal	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const char *	arrayName,
		int	attributeType,
		bool	useComponent,
		int	component
	)

staticprotected

◆ GetLastLUTProxy()

static vtkSMProxy* vtkSMColorMapEditorHelper::GetLastLUTProxy ( vtkSMProxy * proxy )

staticprotected

Used as a memory of what was the last LUT proxy linked to this representation.

This is used in UpdateScalarBarRange to update the scalar bar range when turning off the coloring for this representation.

◆ SetLastLUTProxy()

static void vtkSMColorMapEditorHelper::SetLastLUTProxy	(	vtkSMProxy *	proxy,
		vtkSMProxy *	lutProxy
	)

staticprotected

Used as a memory of what was the last LUT proxy linked to this representation.

This is used in UpdateScalarBarRange to update the scalar bar range when turning off the coloring for this representation.

◆ GetLastBlockLUTProxy()

static vtkSMProxy* vtkSMColorMapEditorHelper::GetLastBlockLUTProxy	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector
	)

staticprotected

Used as a memory of what was the last LUT proxy linked to this representation.

This is used in UpdateScalarBarRange to update the scalar bar range when turning off the coloring for this representation.

◆ SetLastBlockLUTProxy()

static void vtkSMColorMapEditorHelper::SetLastBlockLUTProxy	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		vtkSMProxy *	lutProxy
	)

staticprotected

Used as a memory of what was the last LUT proxy linked to this representation.

This is used in UpdateScalarBarRange to update the scalar bar range when turning off the coloring for this representation.

Friends And Related Function Documentation

◆ vtkSMPVRepresentationProxy

friend class vtkSMPVRepresentationProxy

friend

Definition at line 324 of file vtkSMColorMapEditorHelper.h.

The documentation for this class was generated from the following file:

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMColorMapEditorHelper.h

Static Public Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Function Documentation

◆ GetLUTProxy()

◆ GetBlockLUTProxy()

◆ GetUsingScalarColoring()

◆ GetBlockUsingScalarColoring()

◆ GetAnyBlockUsingScalarColoring()

◆ SetupLookupTable()

◆ SetupBlockLookupTable()

◆ UpdateScalarBarRange()

◆ UpdateBlockScalarBarRange()

◆ SetScalarColoring() [1/2]

◆ SetBlockScalarColoring() [1/2]

◆ SetScalarColoring() [2/2]

◆ SetBlockScalarColoring() [2/2]

◆ RescaleTransferFunctionToDataRange() [1/3]

◆ RescaleBlockTransferFunctionToDataRange() [1/3]

◆ RescaleTransferFunctionToDataRange() [2/3]

◆ RescaleBlockTransferFunctionToDataRange() [2/3]

◆ RescaleTransferFunctionToDataRangeOverTime() [1/2]

◆ RescaleBlockTransferFunctionToDataRangeOverTime() [1/2]

◆ RescaleTransferFunctionToDataRangeOverTime() [2/2]

◆ RescaleBlockTransferFunctionToDataRangeOverTime() [2/2]

◆ RescaleTransferFunctionToVisibleRange() [1/2]

◆ RescaleTransferFunctionToVisibleRange() [2/2]

◆ RescaleBlockTransferFunctionToVisibleRange() [1/2]

◆ RescaleBlockTransferFunctionToVisibleRange() [2/2]

◆ SetScalarBarVisibility()

◆ SetBlockScalarBarVisibility()

◆ HideScalarBarIfNotNeeded()

◆ IsScalarBarVisible()

◆ IsBlockScalarBarVisible()

◆ GetArrayInformationForColorArray()

◆ GetBlockArrayInformationForColorArray()

◆ GetDecoratedArrayName()

◆ GetBlockDecoratedArrayName()

◆ GetProminentValuesInformationForColorArray()

◆ GetBlockProminentValuesInformationForColorArray()

◆ GetEstimatedNumberOfAnnotationsOnScalarBar()

◆ GetBlockEstimatedNumberOfAnnotationsOnScalarBar()

◆ IsScalarBarStickyVisible()

◆ IsBlockScalarBarStickyVisible()

◆ SetBlockColorArray()

◆ GetBlockColorArray()

◆ GetBlockColorArrayAssociation()

◆ GetBlockColorArrayName()

◆ SetBlockUseSeparateColorMap()

◆ GetBlockUseSeparateColorMap()

◆ RescaleTransferFunctionToDataRange() [3/3]

◆ RescaleBlockTransferFunctionToDataRange() [3/3]

◆ SetBlockLookupTable()

◆ GetBlockLookupTable()

◆ RemoveBlockLookupTable()

◆ SetScalarColoringInternal()

◆ SetBlockScalarColoringInternal()

◆ GetLastLUTProxy()

◆ SetLastLUTProxy()

◆ GetLastBlockLUTProxy()

◆ SetLastBlockLUTProxy()

Friends And Related Function Documentation

◆ vtkSMPVRepresentationProxy