helper for color map editor handling More...

#include <vtkSMColorMapEditorHelper.h>

Inheritance diagram for vtkSMColorMapEditorHelper:

Collaboration diagram for vtkSMColorMapEditorHelper:

[legend]

Public Types
enum	SelectedPropertiesTypes { Representation = 0, Blocks = 1 }

enum	BlockPropertyState : std::uint8_t { Disabled = 0x0, RepresentationInherited = 0x1, BlockInherited = 0x2, MixedInherited = 0x3, Set = 0x4, SetAndRepresentationInherited = 0x5, SetAndBlockInherited = 0x6, SetAndMixedInherited = 0x7, NumberOfStates = 0x8 }

typedef vtkObject	Superclass

using	Color = std::array< double, 3 >

using	ColorArray = std::pair< int, std::string >

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

std::vector< vtkSMProxy * >	GetSelectedLookupTables (vtkSMProxy *proxy)

std::vector< vtkSMProxy * >	GetSelectedLookupTables (vtkSMProxy proxy, vtkSMProxy view)


virtual void	SetSelectedPropertiesType (int)
	Set/Get the selected properties type. More...

void	SetSelectedPropertiesTypeToRepresentation ()
	Set/Get the selected properties type. More...

void	SetSelectedPropertiesTypeToBlocks ()
	Set/Get the selected properties type. More...

virtual int	GetSelectedPropertiesType ()
	Set/Get the selected properties type. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMColorMapEditorHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkSMColorMapEditorHelper *	SafeDownCast (vtkObject *o)

static SelectedPropertiesTypes	GetPropertyType (vtkSMProperty *property)
	Determine if a property is a block property. More...

static std::vector< std::string >	GetSelectedBlockSelectors (vtkSMProxy *proxy)
	Returns the selected block selectors for this representation. More...

static std::vector< std::string >	GetColorArraysBlockSelectors (vtkSMProxy *proxy)
	Returns the selectors that use a color array for this representation. More...

static vtkSMProxy *	GetLookupTable (vtkSMProxy *proxy)

static vtkSMProxy *	GetLookupTable (vtkSMProxy proxy, vtkSMProxy view)

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

static std::vector< vtkSMProxy * >	GetBlocksLookupTables (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)

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

static std::vector< vtkSMProxy * >	GetBlocksLookupTables (vtkSMProxy proxy, vtkSMProxy view, const std::vector< std::string > &blockSelectors)


static std::pair< std::string, BlockPropertyState >	HasBlockProperty (vtkSMProxy *proxy, const std::string &blockSelector, const std::string &propertyName)
	Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed. More...

static std::pair< std::string, BlockPropertyState >	GetBlockPropertyStateFromBlockPropertyStates (const std::vector< std::pair< std::string, BlockPropertyState >> &states)
	Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed. More...

static std::pair< std::string, BlockPropertyState >	HasBlockProperty (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, const std::string &propertyName)
	Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed. More...

static std::pair< std::string, BlockPropertyState >	HasBlockProperties (vtkSMProxy *proxy, const std::string &blockSelector, const std::vector< std::string > &propertyNames)
	Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed. More...

static std::pair< std::string, BlockPropertyState >	HasBlocksProperties (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, const std::vector< std::string > &propertyNames)
	Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed. 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	SetupBlocksLookupTables (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 bool	UpdateScalarBarRange (vtkSMProxy proxy, vtkSMProxy view, bool deleteRange)
	Updates the ranges shown in the scalar bar. More...

static std::vector< vtkTypeBool >	UpdateBlocksScalarBarRange (vtkSMProxy proxy, vtkSMProxy view, bool deleteRange)
	Updates the ranges shown in the scalar bar. 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	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 bool	HideBlocksScalarBarIfNotNeeded (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 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 std::vector< vtkTypeBool >	IsBlocksScalarBarVisible (vtkSMProxy repr, vtkSMProxy view, const std::vector< std::string > &blockSelectors)
	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)
	Returns the array information for the data array used for scalar coloring, from input data. More...

static std::vector< vtkPVArrayInformation * >	GetBlocksArrayInformationForColorArray (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	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 std::vector< std::string >	GetBlocksDecoratedArrayNames (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, 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 std::vector< vtkPVProminentValuesInformation * >	GetBlocksProminentValuesInformationForColorArray (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, 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	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 std::vector< int >	IsBlocksScalarBarStickyVisible (vtkSMProxy proxy, vtkSMProxy view, const std::vector< std::string > &blockSelectors)
	Checks if the scalar bar of this representation in view is sticky visible, i.e. More...


static void	ResetBlockProperty (vtkSMProxy *proxy, const std::string &blockSelector, const std::string &propertyName)
	Reset a block property. More...

static void	RemoveBlockProperties (vtkSMProxy *proxy, const std::string &blockSelector, const std::vector< std::string > &propertyNames)
	Reset a block property. More...

static void	ResetBlocksProperty (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, const std::string &propertyName)
	Reset a block property. More...

static void	ResetBlocksProperties (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, const std::vector< std::string > &propertyNames)
	Reset a block property. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMColorMapEditorHelper ()

	~vtkSMColorMapEditorHelper () override

std::vector< vtkTypeBool >	SetSelectedScalarColoringInternal (vtkSMProxy proxy, const char arrayName, int attributeType, bool useComponent, int component)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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 std::vector< vtkTypeBool >	SetBlocksScalarColoringInternal (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, 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 std::vector< vtkTypeBool >	RescaleBlocksTransferFunctionToDataRange (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, std::vector< vtkPVArrayInformation > infos, bool extend=false, bool force=true)
	Rescales transfer function ranges using the array information provided. More...


static void	SetColorArray (vtkSMProxy *proxy, int attributeType, std::string arrayName)
	Set the color array name. More...

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

static void	SetBlocksColorArray (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, int attributeType, std::string arrayName)
	Set the color array name. More...

static void	RemoveBlockColorArray (vtkSMProxy *proxy, const std::string &blockSelector)
	Set the color array name. More...

static void	RemoveBlocksColorArrays (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set the color array name. More...

static ColorArray	GetColorArray (vtkSMProxy *proxy)
	Set the color array name. More...

static ColorArray	GetBlockColorArray (vtkSMProxy *proxy, const std::string &blockSelector)
	Set the color array name. More...


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

static void	SetBlocksLookupTable (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, vtkSMProxy lutProxy)
	Set the block lookup table proxy. More...

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

static void	RemoveBlocksLookupTables (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set the block lookup table proxy. More...


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

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

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

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

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

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

Friends
class	vtkSMPVRepresentationProxy

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 std::vector< vtkTypeBool >	GetBlocksUsingScalarColoring (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Returns true if scalar coloring is enabled. More...

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

std::vector< vtkTypeBool >	GetSelectedUsingScalarColorings (vtkSMProxy *proxy)
	Returns true if scalar coloring is enabled. More...

bool	GetAnySelectedUsingScalarColoring (vtkSMProxy *proxy)
	Returns true if scalar coloring is enabled. 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 std::vector< vtkTypeBool >	SetBlocksScalarColoring (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, const char arrayName, int attributeType)
	Enable/disable scalar coloring using the specified array. More...

std::vector< vtkTypeBool >	SetSelectedScalarColoring (vtkSMProxy proxy, 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 std::vector< vtkTypeBool >	SetBlocksScalarColoring (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, const char arrayName, int attributeType, int component)
	Enable/disable scalar coloring using the specified array. More...

std::vector< vtkTypeBool >	SetSelectedScalarColoring (vtkSMProxy proxy, 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 std::vector< vtkTypeBool >	RescaleBlocksTransferFunctionToDataRange (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, bool extend=false, bool force=true)
	Rescales the color transfer function and opacity transfer function using the current data range. More...

std::vector< vtkTypeBool >	RescaleSelectedTransferFunctionToDataRange (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	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 std::vector< vtkTypeBool >	RescaleBlocksTransferFunctionToDataRange (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, 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...

std::vector< vtkTypeBool >	RescaleSelectedTransferFunctionToDataRange (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	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 std::vector< vtkTypeBool >	RescaleBlocksTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Rescales the color transfer function and opacity transfer function using the current data range over time. More...

std::vector< vtkTypeBool >	RescaleSelectedTransferFunctionToDataRangeOverTime (vtkSMProxy *proxy)
	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 std::vector< vtkTypeBool >	RescaleBlocksTransferFunctionToDataRangeOverTime (vtkSMProxy proxy, const std::vector< std::string > &blockSelectors, 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...

std::vector< vtkTypeBool >	RescaleSelectedTransferFunctionToDataRangeOverTime (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	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 std::vector< vtkTypeBool >	SetBlocksScalarBarVisibility (vtkSMProxy proxy, vtkSMProxy view, const std::vector< std::string > &blockSelectors, bool visible)
	Set the scalar bar visibility. More...

std::vector< vtkTypeBool >	SetSelectedScalarBarVisibility (vtkSMProxy proxy, vtkSMProxy view, bool visible)
	Set the scalar bar visibility. 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 std::vector< int >	GetBlocksEstimatedNumberOfAnnotationsOnScalarBars (vtkSMProxy proxy, vtkSMProxy view, const std::vector< std::string > &blockSelectors)
	Get an estimated number of annotation shown on this representation scalar bar. More...

std::vector< int >	GetSelectedEstimatedNumberOfAnnotationsOnScalarBars (vtkSMProxy proxy, vtkSMProxy view)
	Get an estimated number of annotation shown on this representation scalar bar. More...

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

static bool	IsColorValid (Color color)
	Set/Get the color of the representation. More...

static void	SetColor (vtkSMProxy *proxy, Color color)
	Set/Get the color of the representation. More...

static void	SetBlockColor (vtkSMProxy *proxy, const std::string &blockSelector, Color color)
	Set/Get the color of the representation. More...

static void	SetBlocksColor (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, Color color)
	Set/Get the color of the representation. More...

static void	RemoveBlockColor (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the color of the representation. More...

static void	RemoveBlocksColors (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the color of the representation. More...

static Color	GetColor (vtkSMProxy *proxy)
	Set/Get the color of the representation. More...

static Color	GetBlockColor (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the color of the representation. More...

static std::vector< Color >	GetBlocksColors (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the color of the representation. More...

void	SetSelectedColor (vtkSMProxy *proxy, Color color)
	Set/Get the color of the representation. More...

std::vector< Color >	GetSelectedColors (vtkSMProxy *proxy)
	Set/Get the color of the representation. More...

static vtkSMProperty *	GetColorArrayProperty (vtkSMProxy *proxy)
	Get Color array property. More...

static vtkSMProperty *	GetBlockColorArrayProperty (vtkSMProxy *proxy)
	Get Color array property. More...

vtkSMProperty *	GetSelectedColorArrayProperty (vtkSMProxy *proxy)
	Get Color array property. More...

static bool	IsColorArrayValid (const ColorArray &array)
	Get the color array name. More...

static std::vector< ColorArray >	GetBlocksColorArrays (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Get the color array name. More...

static int	GetBlockColorArrayAssociation (vtkSMProxy *proxy, const std::string &blockSelector)
	Get the color array name. More...

static std::string	GetBlockColorArrayName (vtkSMProxy *proxy, const std::string &blockSelector)
	Get the color array name. More...

static std::map< ColorArray, std::vector< std::string > >	GetCommonColorArraysBlockSelectors (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Get the color array name. More...

std::vector< ColorArray >	GetSelectedColorArrays (vtkSMProxy *proxy)
	Get the color array name. More...

static vtkSMProperty *	GetUseSeparateColorMapProperty (vtkSMProxy *proxy)
	Get use separate color map property. More...

static vtkSMProperty *	GetBlockUseSeparateColorMapProperty (vtkSMProxy *proxy)
	Get use separate color map property. More...

vtkSMProperty *	GetSelectedUseSeparateColorMapProperty (vtkSMProxy *proxy)
	Get use separate color map property. More...

static bool	IsUseSeparateColorMapValid (int useSeparateColorMap)
	Set/Get if we should use a separate color map. More...

static void	SetUseSeparateColorMap (vtkSMProxy *proxy, bool use)
	Set/Get if we should use a separate color map. More...

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

static void	SetBlocksUseSeparateColorMap (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, bool use)
	Set/Get if we should use a separate color map. More...

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

static void	RemoveBlocksUseSeparateColorMaps (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get if we should use a separate color map. More...

static bool	GetUseSeparateColorMap (vtkSMProxy *proxy)
	Set/Get if we should use a separate color map. More...

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

static std::vector< int >	GetBlocksUseSeparateColorMaps (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get if we should use a separate color map. More...

void	SetSelectedUseSeparateColorMap (vtkSMProxy *proxy, bool use)
	Set/Get if we should use a separate color map. More...

std::vector< int >	GetSelectedUseSeparateColorMaps (vtkSMProxy *proxy)
	Set/Get if we should use a separate color map. More...

bool	GetAnySelectedUseSeparateColorMap (vtkSMProxy *proxy)
	Set/Get if we should use a separate color map. More...

static bool	IsMapScalarsValid (int mapScalars)
	Set/Get the map scalars of the representation. More...

static void	SetMapScalars (vtkSMProxy *proxy, bool mapScalars)
	Set/Get the map scalars of the representation. More...

static void	SetBlockMapScalars (vtkSMProxy *proxy, const std::string &blockSelector, bool mapScalars)
	Set/Get the map scalars of the representation. More...

static void	SetBlocksMapScalars (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, bool mapScalars)
	Set/Get the map scalars of the representation. More...

static void	RemoveBlockMapScalars (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the map scalars of the representation. More...

static void	RemoveBlocksMapScalars (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the map scalars of the representation. More...

static bool	GetMapScalars (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

static int	GetBlockMapScalars (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the map scalars of the representation. More...

static std::vector< int >	GetBlocksMapScalars (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the map scalars of the representation. More...

void	SetSelectedMapScalars (vtkSMProxy *proxy, bool mapScalars)
	Set/Get the map scalars of the representation. More...

std::vector< int >	GetSelectedMapScalars (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

bool	GetAnySelectedMapScalars (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

static bool	IsInterpolateScalarsBeforeMappingValid (int interpolate)
	Set/Get the map scalars of the representation. More...

static void	SetInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, bool interpolate)
	Set/Get the map scalars of the representation. More...

static void	SetBlockInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, const std::string &blockSelector, bool interpolate)
	Set/Get the map scalars of the representation. More...

static void	SetBlocksInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, bool interpolate)
	Set/Get the map scalars of the representation. More...

static void	RemoveBlockInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the map scalars of the representation. More...

static void	RemoveBlocksInterpolateScalarsBeforeMappings (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the map scalars of the representation. More...

static bool	GetInterpolateScalarsBeforeMapping (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

static int	GetBlockInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the map scalars of the representation. More...

static std::vector< int >	GetBlocksInterpolateScalarsBeforeMappings (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the map scalars of the representation. More...

void	SetSelectedInterpolateScalarsBeforeMapping (vtkSMProxy *proxy, bool interpolate)
	Set/Get the map scalars of the representation. More...

std::vector< int >	GetSelectedInterpolateScalarsBeforeMappings (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

bool	GetAnySelectedInterpolateScalarsBeforeMapping (vtkSMProxy *proxy)
	Set/Get the map scalars of the representation. More...

static bool	IsOpacityValid (double opacity)
	Set/Get the opacity of the representation. More...

static void	SetOpacity (vtkSMProxy *proxy, double opacity)
	Set/Get the opacity of the representation. More...

static void	SetBlockOpacity (vtkSMProxy *proxy, const std::string &blockSelector, double opacity)
	Set/Get the opacity of the representation. More...

static void	SetBlocksOpacity (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors, double opacity)
	Set/Get the opacity of the representation. More...

static void	RemoveBlockOpacity (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the opacity of the representation. More...

static void	RemoveBlocksOpacities (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the opacity of the representation. More...

static double	GetOpacity (vtkSMProxy *proxy)
	Set/Get the opacity of the representation. More...

static double	GetBlockOpacity (vtkSMProxy *proxy, const std::string &blockSelector)
	Set/Get the opacity of the representation. More...

static std::vector< double >	GetBlocksOpacities (vtkSMProxy *proxy, const std::vector< std::string > &blockSelectors)
	Set/Get the opacity of the representation. More...

void	SetSelectedOpacity (vtkSMProxy *proxy, double opacity)
	Set/Get the opacity of the representation. More...

std::vector< double >	GetSelectedOpacities (vtkSMProxy *proxy)
	Set/Get the opacity of the representation. More...

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 32 of file vtkSMColorMapEditorHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSMColorMapEditorHelper::Superclass

Definition at line 36 of file vtkSMColorMapEditorHelper.h.

◆ Color

using vtkSMColorMapEditorHelper::Color = std::array<double, 3>

Definition at line 485 of file vtkSMColorMapEditorHelper.h.

◆ ColorArray

using vtkSMColorMapEditorHelper::ColorArray = std::pair<int, std::string>

Definition at line 525 of file vtkSMColorMapEditorHelper.h.

Member Enumeration Documentation

◆ SelectedPropertiesTypes

enum vtkSMColorMapEditorHelper::SelectedPropertiesTypes

Enumerator
Representation
Blocks

Definition at line 39 of file vtkSMColorMapEditorHelper.h.

◆ BlockPropertyState

enum vtkSMColorMapEditorHelper::BlockPropertyState : std::uint8_t

Enumerator
Disabled
RepresentationInherited
BlockInherited
MixedInherited
Set
SetAndRepresentationInherited
SetAndBlockInherited
SetAndMixedInherited
NumberOfStates

Definition at line 45 of file vtkSMColorMapEditorHelper.h.

Constructor & Destructor Documentation

◆ vtkSMColorMapEditorHelper()

vtkSMColorMapEditorHelper::vtkSMColorMapEditorHelper ( )

protected

◆ ~vtkSMColorMapEditorHelper()

vtkSMColorMapEditorHelper::~vtkSMColorMapEditorHelper ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMColorMapEditorHelper* vtkSMColorMapEditorHelper::New ( )

static

◆ GetClassName()

virtual const char* vtkSMColorMapEditorHelper::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkSMColorMapEditorHelper::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSMColorMapEditorHelper::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkSMColorMapEditorHelper* vtkSMColorMapEditorHelper::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkSMColorMapEditorHelper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ SetSelectedPropertiesType()

virtual void vtkSMColorMapEditorHelper::SetSelectedPropertiesType ( int )

virtual

Set/Get the selected properties type.

This variable is used in all instance functions with the Selected key-word in the name.

It decides whether to use a function that uses the representation's or blocks' properties.

Default is false.

◆ SetSelectedPropertiesTypeToRepresentation()

void vtkSMColorMapEditorHelper::SetSelectedPropertiesTypeToRepresentation ( )

inline

Set/Get the selected properties type.

This variable is used in all instance functions with the Selected key-word in the name.

It decides whether to use a function that uses the representation's or blocks' properties.

Default is false.

Definition at line 79 of file vtkSMColorMapEditorHelper.h.

◆ SetSelectedPropertiesTypeToBlocks()

void vtkSMColorMapEditorHelper::SetSelectedPropertiesTypeToBlocks ( )

inline

Set/Get the selected properties type.

This variable is used in all instance functions with the Selected key-word in the name.

It decides whether to use a function that uses the representation's or blocks' properties.

Default is false.

Definition at line 83 of file vtkSMColorMapEditorHelper.h.

◆ GetSelectedPropertiesType()

virtual int vtkSMColorMapEditorHelper::GetSelectedPropertiesType ( )

virtual

Set/Get the selected properties type.

This variable is used in all instance functions with the Selected key-word in the name.

It decides whether to use a function that uses the representation's or blocks' properties.

Default is false.

◆ GetPropertyType()

static SelectedPropertiesTypes vtkSMColorMapEditorHelper::GetPropertyType ( vtkSMProperty * property )

static

Determine if a property is a block property.

◆ HasBlockProperty() [1/2]

static std::pair<std::string, BlockPropertyState> vtkSMColorMapEditorHelper::HasBlockProperty	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const std::string &	propertyName
	)

static

Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed.

if it's RepresentationInherited, the blockSelector will be empty. if it's BlockInherited, the blockSelector will be the inherited block. if it's MixedInherited, the blockSelector will be the inherited block. if it's Set, the block selector will be the block where the property is set. if it's SetAndRepresentationInherited, be the block where the property is set. if it's SetAndBlockInherited, be the block where the property is set. if it's SetAndMixedInherited, be the block where the property is set.

◆ GetBlockPropertyStateFromBlockPropertyStates()

static std::pair<std::string, BlockPropertyState> vtkSMColorMapEditorHelper::GetBlockPropertyStateFromBlockPropertyStates ( const std::vector< std::pair< std::string, BlockPropertyState >> & states )

static

Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed.

if it's RepresentationInherited, the blockSelector will be empty. if it's BlockInherited, the blockSelector will be the inherited block. if it's MixedInherited, the blockSelector will be the inherited block. if it's Set, the block selector will be the block where the property is set. if it's SetAndRepresentationInherited, be the block where the property is set. if it's SetAndBlockInherited, be the block where the property is set. if it's SetAndMixedInherited, be the block where the property is set.

◆ HasBlockProperty() [2/2]

static std::pair<std::string, BlockPropertyState> vtkSMColorMapEditorHelper::HasBlockProperty	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		const std::string &	propertyName
	)

static

Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed.

if it's RepresentationInherited, the blockSelector will be empty. if it's BlockInherited, the blockSelector will be the inherited block. if it's MixedInherited, the blockSelector will be the inherited block. if it's Set, the block selector will be the block where the property is set. if it's SetAndRepresentationInherited, be the block where the property is set. if it's SetAndBlockInherited, be the block where the property is set. if it's SetAndMixedInherited, be the block where the property is set.

◆ HasBlockProperties()

static std::pair<std::string, BlockPropertyState> vtkSMColorMapEditorHelper::HasBlockProperties	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		const std::vector< std::string > &	propertyNames
	)

static

Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed.

if it's RepresentationInherited, the blockSelector will be empty. if it's BlockInherited, the blockSelector will be the inherited block. if it's MixedInherited, the blockSelector will be the inherited block. if it's Set, the block selector will be the block where the property is set. if it's SetAndRepresentationInherited, be the block where the property is set. if it's SetAndBlockInherited, be the block where the property is set. if it's SetAndMixedInherited, be the block where the property is set.

◆ HasBlocksProperties()

static std::pair<std::string, BlockPropertyState> vtkSMColorMapEditorHelper::HasBlocksProperties	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		const std::vector< std::string > &	propertyNames
	)

static

Determine if a propert(y/ies) of a selector(s) is set, inherited from a block, or from the representation, or mixed.

if it's RepresentationInherited, the blockSelector will be empty. if it's BlockInherited, the blockSelector will be the inherited block. if it's MixedInherited, the blockSelector will be the inherited block. if it's Set, the block selector will be the block where the property is set. if it's SetAndRepresentationInherited, be the block where the property is set. if it's SetAndBlockInherited, be the block where the property is set. if it's SetAndMixedInherited, be the block where the property is set.

◆ GetSelectedBlockSelectors()

static std::vector<std::string> vtkSMColorMapEditorHelper::GetSelectedBlockSelectors ( vtkSMProxy * proxy )

static

Returns the selected block selectors for this representation.

◆ GetColorArraysBlockSelectors()

static std::vector<std::string> vtkSMColorMapEditorHelper::GetColorArraysBlockSelectors ( vtkSMProxy * proxy )

static

Returns the selectors that use a color array for this representation.

◆ GetLookupTable() [1/2]

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

static

◆ GetLookupTable() [2/2]

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

static

◆ GetBlockLookupTable() [1/2]

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

inlinestatic

Definition at line 131 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksLookupTables() [1/2]

static std::vector<vtkSMProxy*> vtkSMColorMapEditorHelper::GetBlocksLookupTables	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

◆ GetBlockLookupTable() [2/2]

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

inlinestatic

Definition at line 137 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksLookupTables() [2/2]

static std::vector<vtkSMProxy*> vtkSMColorMapEditorHelper::GetBlocksLookupTables	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::vector< std::string > &	blockSelectors
	)

static

◆ GetSelectedLookupTables() [1/2]

std::vector<vtkSMProxy*> vtkSMColorMapEditorHelper::GetSelectedLookupTables ( vtkSMProxy * proxy )

◆ GetSelectedLookupTables() [2/2]

std::vector<vtkSMProxy*> vtkSMColorMapEditorHelper::GetSelectedLookupTables	(	vtkSMProxy *	proxy,
		vtkSMProxy *	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
	)

inlinestatic

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.

Definition at line 155 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksUsingScalarColoring()

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::GetBlocksUsingScalarColoring	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

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.

◆ GetSelectedUsingScalarColorings()

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::GetSelectedUsingScalarColorings ( vtkSMProxy * proxy )

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.

◆ GetAnySelectedUsingScalarColoring()

bool vtkSMColorMapEditorHelper::GetAnySelectedUsingScalarColoring ( vtkSMProxy * proxy )

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.

◆ SetupBlocksLookupTables()

static void vtkSMColorMapEditorHelper::SetupBlocksLookupTables ( 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.

◆ 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.

◆ UpdateBlocksScalarBarRange()

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::UpdateBlocksScalarBarRange	(	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.

◆ 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
	)

inlinestatic

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.

Definition at line 197 of file vtkSMColorMapEditorHelper.h.

◆ SetBlocksScalarColoring() [1/2]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetBlocksScalarColoring	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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.

◆ SetSelectedScalarColoring() [1/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetSelectedScalarColoring	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType
	)

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
	)

inlinestatic

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.

Definition at line 221 of file vtkSMColorMapEditorHelper.h.

◆ SetBlocksScalarColoring() [2/2]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetBlocksScalarColoring	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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.

◆ SetSelectedScalarColoring() [2/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetSelectedScalarColoring	(	vtkSMProxy *	proxy,
		const char *	arrayName,
		int	attributeType,
		int	component
	)

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`
	)

inlinestatic

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.

Definition at line 246 of file vtkSMColorMapEditorHelper.h.

◆ RescaleBlocksTransferFunctionToDataRange() [1/3]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleBlocksTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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.

◆ RescaleSelectedTransferFunctionToDataRange() [1/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleSelectedTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		bool	extend = `false`,
		bool	force = `true`
	)

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`
	)

inlinestatic

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.

Definition at line 272 of file vtkSMColorMapEditorHelper.h.

◆ RescaleBlocksTransferFunctionToDataRange() [2/3]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleBlocksTransferFunctionToDataRange	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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.

◆ RescaleSelectedTransferFunctionToDataRange() [2/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleSelectedTransferFunctionToDataRange	(	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.

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
	)

inlinestatic

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

Returns true if rescale was successful.

Definition at line 293 of file vtkSMColorMapEditorHelper.h.

◆ RescaleBlocksTransferFunctionToDataRangeOverTime() [1/2]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleBlocksTransferFunctionToDataRangeOverTime	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

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

Returns true if rescale was successful.

◆ RescaleSelectedTransferFunctionToDataRangeOverTime() [1/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleSelectedTransferFunctionToDataRangeOverTime ( vtkSMProxy * proxy )

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
	)

inlinestatic

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,

Definition at line 314 of file vtkSMColorMapEditorHelper.h.

◆ RescaleBlocksTransferFunctionToDataRangeOverTime() [2/2]

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleBlocksTransferFunctionToDataRangeOverTime	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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,

◆ RescaleSelectedTransferFunctionToDataRangeOverTime() [2/2]

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::RescaleSelectedTransferFunctionToDataRangeOverTime	(	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.

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.

◆ 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
	)

inlinestatic

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.

Definition at line 344 of file vtkSMColorMapEditorHelper.h.

◆ SetBlocksScalarBarVisibility()

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetBlocksScalarBarVisibility	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::vector< std::string > &	blockSelectors,
		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.

◆ SetSelectedScalarBarVisibility()

std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::SetSelectedScalarBarVisibility	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		bool	visible
	)

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.

◆ HideBlocksScalarBarIfNotNeeded()

static bool vtkSMColorMapEditorHelper::HideBlocksScalarBarIfNotNeeded	(	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
	)

inlinestatic

Check scalar bar visibility.

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

Definition at line 375 of file vtkSMColorMapEditorHelper.h.

◆ IsBlocksScalarBarVisible()

static std::vector<vtkTypeBool> vtkSMColorMapEditorHelper::IsBlocksScalarBarVisible	(	vtkSMProxy *	repr,
		vtkSMProxy *	view,
		const std::vector< std::string > &	blockSelectors
	)

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
	)

inlinestatic

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.

Definition at line 393 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksArrayInformationForColorArray()

static std::vector<vtkPVArrayInformation*> vtkSMColorMapEditorHelper::GetBlocksArrayInformationForColorArray	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

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
	)

inlinestatic

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

Definition at line 410 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksDecoratedArrayNames()

static std::vector<std::string> vtkSMColorMapEditorHelper::GetBlocksDecoratedArrayNames	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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`
	)

inlinestatic

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

Otherwise returns nullptr.

Definition at line 429 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksProminentValuesInformationForColorArray()

static std::vector<vtkPVProminentValuesInformation*> vtkSMColorMapEditorHelper::GetBlocksProminentValuesInformationForColorArray	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		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.

If the return value is -1, then the value is not set.

◆ GetBlockEstimatedNumberOfAnnotationsOnScalarBar()

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

inlinestatic

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

If the return value is -1, then the value is not set.

Definition at line 450 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksEstimatedNumberOfAnnotationsOnScalarBars()

static std::vector<int> vtkSMColorMapEditorHelper::GetBlocksEstimatedNumberOfAnnotationsOnScalarBars	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::vector< std::string > &	blockSelectors
	)

static

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

If the return value is -1, then the value is not set.

◆ GetSelectedEstimatedNumberOfAnnotationsOnScalarBars()

std::vector<int> vtkSMColorMapEditorHelper::GetSelectedEstimatedNumberOfAnnotationsOnScalarBars	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

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

If the return value is -1, then the value is not set.

◆ GetAnySelectedEstimatedNumberOfAnnotationsOnScalarBar()

int vtkSMColorMapEditorHelper::GetAnySelectedEstimatedNumberOfAnnotationsOnScalarBar	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view
	)

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

If the return value is -1, then the value is not set.

◆ 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 instantiated / found, it returns -1.

◆ IsBlockScalarBarStickyVisible()

static int vtkSMColorMapEditorHelper::IsBlockScalarBarStickyVisible	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		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 instantiated / found, it returns -1.

Definition at line 475 of file vtkSMColorMapEditorHelper.h.

◆ IsBlocksScalarBarStickyVisible()

static std::vector<int> vtkSMColorMapEditorHelper::IsBlocksScalarBarStickyVisible	(	vtkSMProxy *	proxy,
		vtkSMProxy *	view,
		const std::vector< std::string > &	blockSelectors
	)

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 instantiated / found, it returns -1.

◆ IsColorValid()

static bool vtkSMColorMapEditorHelper::IsColorValid ( Color color )

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ SetColor()

static void vtkSMColorMapEditorHelper::SetColor	(	vtkSMProxy *	proxy,
		Color	color
	)

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ SetBlockColor()

static void vtkSMColorMapEditorHelper::SetBlockColor	(	vtkSMProxy *	proxy,
		const std::string &	blockSelector,
		Color	color
	)

inlinestatic

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

Definition at line 494 of file vtkSMColorMapEditorHelper.h.

◆ SetBlocksColor()

static void vtkSMColorMapEditorHelper::SetBlocksColor	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		Color	color
	)

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ RemoveBlockColor()

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

inlinestatic

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

Definition at line 500 of file vtkSMColorMapEditorHelper.h.

◆ RemoveBlocksColors()

static void vtkSMColorMapEditorHelper::RemoveBlocksColors	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ SetSelectedColor()

void vtkSMColorMapEditorHelper::SetSelectedColor	(	vtkSMProxy *	proxy,
		Color	color
	)

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ GetColor()

static Color vtkSMColorMapEditorHelper::GetColor ( vtkSMProxy * proxy )

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ GetBlockColor()

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

inlinestatic

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

Definition at line 507 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksColors()

static std::vector<Color> vtkSMColorMapEditorHelper::GetBlocksColors	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ GetSelectedColors()

std::vector<Color> vtkSMColorMapEditorHelper::GetSelectedColors ( vtkSMProxy * proxy )

Set/Get the color of the representation.

Note: Use IsColorValid to check if the returned value is valid/set.

◆ GetColorArrayProperty()

static vtkSMProperty* vtkSMColorMapEditorHelper::GetColorArrayProperty ( vtkSMProxy * proxy )

static

Get Color array property.

◆ GetBlockColorArrayProperty()

static vtkSMProperty* vtkSMColorMapEditorHelper::GetBlockColorArrayProperty ( vtkSMProxy * proxy )

static

Get Color array property.

◆ GetSelectedColorArrayProperty()

vtkSMProperty* vtkSMColorMapEditorHelper::GetSelectedColorArrayProperty ( vtkSMProxy * proxy )

Get Color array property.

◆ IsColorArrayValid()

static bool vtkSMColorMapEditorHelper::IsColorArrayValid ( const ColorArray & array )

static

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

◆ GetBlocksColorArrays()

static std::vector<ColorArray> vtkSMColorMapEditorHelper::GetBlocksColorArrays	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

◆ GetBlockColorArrayAssociation()

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

inlinestatic

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

Definition at line 535 of file vtkSMColorMapEditorHelper.h.

◆ GetBlockColorArrayName()

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

inlinestatic

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

Definition at line 539 of file vtkSMColorMapEditorHelper.h.

◆ GetCommonColorArraysBlockSelectors()

static std::map<ColorArray, std::vector<std::string> > vtkSMColorMapEditorHelper::GetCommonColorArraysBlockSelectors	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

◆ GetSelectedColorArrays()

std::vector<ColorArray> vtkSMColorMapEditorHelper::GetSelectedColorArrays ( vtkSMProxy * proxy )

Get the color array name.

Note: Use IsColorArrayValid to check if the returned value is valid/set.

◆ GetUseSeparateColorMapProperty()

static vtkSMProperty* vtkSMColorMapEditorHelper::GetUseSeparateColorMapProperty ( vtkSMProxy * proxy )

static

Get use separate color map property.

◆ GetBlockUseSeparateColorMapProperty()

static vtkSMProperty* vtkSMColorMapEditorHelper::GetBlockUseSeparateColorMapProperty ( vtkSMProxy * proxy )

static

Get use separate color map property.

◆ GetSelectedUseSeparateColorMapProperty()

vtkSMProperty* vtkSMColorMapEditorHelper::GetSelectedUseSeparateColorMapProperty ( vtkSMProxy * proxy )

Get use separate color map property.

◆ IsUseSeparateColorMapValid()

static bool vtkSMColorMapEditorHelper::IsUseSeparateColorMapValid ( int useSeparateColorMap )

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ SetUseSeparateColorMap()

static void vtkSMColorMapEditorHelper::SetUseSeparateColorMap	(	vtkSMProxy *	proxy,
		bool	use
	)

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ SetBlockUseSeparateColorMap()

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

inlinestatic

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

Definition at line 565 of file vtkSMColorMapEditorHelper.h.

◆ SetBlocksUseSeparateColorMap()

static void vtkSMColorMapEditorHelper::SetBlocksUseSeparateColorMap	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors,
		bool	use
	)

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ RemoveBlockUseSeparateColorMap()

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

inlinestatic

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

Definition at line 572 of file vtkSMColorMapEditorHelper.h.

◆ RemoveBlocksUseSeparateColorMaps()

static void vtkSMColorMapEditorHelper::RemoveBlocksUseSeparateColorMaps	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ SetSelectedUseSeparateColorMap()

void vtkSMColorMapEditorHelper::SetSelectedUseSeparateColorMap	(	vtkSMProxy *	proxy,
		bool	use
	)

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ GetUseSeparateColorMap()

static bool vtkSMColorMapEditorHelper::GetUseSeparateColorMap ( vtkSMProxy * proxy )

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ GetBlockUseSeparateColorMap()

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

inlinestatic

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

Definition at line 580 of file vtkSMColorMapEditorHelper.h.

◆ GetBlocksUseSeparateColorMaps()

static std::vector<int> vtkSMColorMapEditorHelper::GetBlocksUseSeparateColorMaps	(	vtkSMProxy *	proxy,
		const std::vector< std::string > &	blockSelectors
	)

static

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ GetSelectedUseSeparateColorMaps()

std::vector<int> vtkSMColorMapEditorHelper::GetSelectedUseSeparateColorMaps ( vtkSMProxy * proxy )

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.

◆ GetAnySelectedUseSeparateColorMap()

bool vtkSMColorMapEditorHelper::GetAnySelectedUseSeparateColorMap ( vtkSMProxy * proxy )

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

Note: Use IsUseSeparateColorMapValid to check if the returned value is valid/set.