vtkPVRepresentedArrayListSettings Class Reference

singleton used to filter out undesired data attribute from the representation. More...

#include <vtkPVRepresentedArrayListSettings.h>

Inheritance diagram for vtkPVRepresentedArrayListSettings:

Collaboration diagram for vtkPVRepresentedArrayListSettings:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual bool	ShouldUseMagnitudeMode (int ncomp) const
	Check if the array mode for this number of components should be the magnitude mode or not. More...
virtual void	SetNumberOfFilterExpressions (int n)
	Set/get the number of filter expressions. More...
virtual int	GetNumberOfFilterExpressions ()
	Set/get the number of filter expressions. More...
virtual void	SetFilterExpression (int i, const char *expression)
	Set/get the filter expression at index i. More...
virtual const char *	GetFilterExpression (int i)
	Set/get the filter expression at index i. More...
virtual void	SetComputeArrayMagnitude (bool)
	Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field. More...
virtual void	SetArrayMagnitudeException (int idx, int ncomp)
	Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field. More...
virtual void	SetNumberOfArrayMagnitudeExceptions (int nexceptions)
	Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field. More...
virtual void	SetNumberOfChartsDefaultXAxis (int n)
	ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts. More...
virtual int	GetNumberOfChartsDefaultXAxis () const
	ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts. More...
virtual void	SetChartsDefaultXAxis (int i, const char *expression)
	ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts. More...
virtual const char *	GetChartsDefaultXAxis (int i) const
	ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts. More...
virtual const std::vector< std::string > &	GetAllChartsDefaultXAxis () const
	ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts. More...
virtual void	SetNumberOfChartsHiddenAttributes (int n)
	ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart. More...
virtual int	GetNumberOfChartsHiddenAttributes () const
	ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart. More...
virtual void	SetChartsHiddenAttributes (int i, const char *expression)
	ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart. More...
virtual const std::vector< vtksys::RegularExpression > &	GetAllChartsHiddenAttributes () const
	ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart. More...
virtual bool	GetSeriesVisibilityDefault (const char *name) const
	ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart. 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 vtkPVRepresentedArrayListSettings *	New ()
static int	IsTypeOf (const char *type)
static vtkPVRepresentedArrayListSettings *	SafeDownCast (vtkObject *o)
static vtkPVRepresentedArrayListSettings *	GetInstance ()
	Access the singleton. 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
	vtkPVRepresentedArrayListSettings ()
	~vtkPVRepresentedArrayListSettings () override
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 &)

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

singleton used to filter out undesired data attribute from the representation.

Currently represent the "Represented Attributes" section of ParaView settings.

vtkPVRepresentedArrayListSettings is a singleton used to keep track of a list of regular expressions that filter out arrays in a RepresentedArrayList domain, and contains other settings controlling which array should be visible in which situation.

All calls to vtkPVRepresentedArrayListSettings::New() returns a reference to the singleton instance.

Definition at line 36 of file vtkPVRepresentedArrayListSettings.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPVRepresentedArrayListSettings::Superclass

Definition at line 40 of file vtkPVRepresentedArrayListSettings.h.

Constructor & Destructor Documentation

vtkPVRepresentedArrayListSettings()

vtkPVRepresentedArrayListSettings::vtkPVRepresentedArrayListSettings ( )

protected

~vtkPVRepresentedArrayListSettings()

vtkPVRepresentedArrayListSettings::~vtkPVRepresentedArrayListSettings ( )

overrideprotected

Member Function Documentation

New()

static vtkPVRepresentedArrayListSettings* vtkPVRepresentedArrayListSettings::New ( )

static

GetClassName()

virtual const char* vtkPVRepresentedArrayListSettings::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

GetInstance()

static vtkPVRepresentedArrayListSettings* vtkPVRepresentedArrayListSettings::GetInstance ( )

static

Access the singleton.

SetNumberOfFilterExpressions()

virtual void vtkPVRepresentedArrayListSettings::SetNumberOfFilterExpressions ( int  n )

virtual

Set/get the number of filter expressions.

GetNumberOfFilterExpressions()

virtual int vtkPVRepresentedArrayListSettings::GetNumberOfFilterExpressions ( )

virtual

Set/get the number of filter expressions.

SetFilterExpression()

virtual void vtkPVRepresentedArrayListSettings::SetFilterExpression ( int  i, const char *  expression  )

virtual

Set/get the filter expression at index i.

If the index is outside the valid range, this call is a noop.

GetFilterExpression()

virtual const char* vtkPVRepresentedArrayListSettings::GetFilterExpression ( int  i )

virtual

Set/get the filter expression at index i.

If the index is outside the valid range, this call is a noop.

SetComputeArrayMagnitude()

virtual void vtkPVRepresentedArrayListSettings::SetComputeArrayMagnitude ( bool  )

virtual

Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field.

If ComputeArrayMagnitude is true then ParaView will always compute the magnitude. Otherwise it will not.

ArrayMagnitudeExceptions is the list of exceptions and will behave differently depending on the value of ComputeArrayMagnitude. If ComputeArrayMagnitude is false then the list describes the number of components for which ParaView will still compute the magnitude. Else the list describe the number of components for which ParaView will not compute the magnitude.

See also

ShouldUseMagnitudeMode

SetArrayMagnitudeException()

virtual void vtkPVRepresentedArrayListSettings::SetArrayMagnitudeException ( int  idx, int  ncomp  )

virtual

Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field.

If ComputeArrayMagnitude is true then ParaView will always compute the magnitude. Otherwise it will not.

ArrayMagnitudeExceptions is the list of exceptions and will behave differently depending on the value of ComputeArrayMagnitude. If ComputeArrayMagnitude is false then the list describes the number of components for which ParaView will still compute the magnitude. Else the list describe the number of components for which ParaView will not compute the magnitude.

See also

ShouldUseMagnitudeMode

SetNumberOfArrayMagnitudeExceptions()

virtual void vtkPVRepresentedArrayListSettings::SetNumberOfArrayMagnitudeExceptions ( int  nexceptions )

virtual

Setters to control whether ParaView should allow the user to display the gradient of a given multi-component field.

If ComputeArrayMagnitude is true then ParaView will always compute the magnitude. Otherwise it will not.

ArrayMagnitudeExceptions is the list of exceptions and will behave differently depending on the value of ComputeArrayMagnitude. If ComputeArrayMagnitude is false then the list describes the number of components for which ParaView will still compute the magnitude. Else the list describe the number of components for which ParaView will not compute the magnitude.

See also

ShouldUseMagnitudeMode

ShouldUseMagnitudeMode()

virtual bool vtkPVRepresentedArrayListSettings::ShouldUseMagnitudeMode ( int  ncomp ) const

virtual

Check if the array mode for this number of components should be the magnitude mode or not.

This will internally use the informations given by ComputeArrayMagnitude and ArrayMagnitudeExceptions.

See also

SetComputeArrayMagnitude

SetNumberOfChartsDefaultXAxis()

virtual void vtkPVRepresentedArrayListSettings::SetNumberOfChartsDefaultXAxis ( int  n )

virtual

ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts.

GetNumberOfChartsDefaultXAxis()

virtual int vtkPVRepresentedArrayListSettings::GetNumberOfChartsDefaultXAxis ( ) const

virtual

ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts.

SetChartsDefaultXAxis()

virtual void vtkPVRepresentedArrayListSettings::SetChartsDefaultXAxis ( int  i, const char *  expression  )

virtual

ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts.

GetChartsDefaultXAxis()

virtual const char* vtkPVRepresentedArrayListSettings::GetChartsDefaultXAxis ( int  i ) const

virtual

ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts.

GetAllChartsDefaultXAxis()

virtual const std::vector<std::string>& vtkPVRepresentedArrayListSettings::GetAllChartsDefaultXAxis ( ) const

virtual

ChartsDefaultXAxis is the list of array names that will be selected by default as the X axis when displaying some data in charts.

SetNumberOfChartsHiddenAttributes()

virtual void vtkPVRepresentedArrayListSettings::SetNumberOfChartsHiddenAttributes ( int  n )

virtual

ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart.

If the name of the array matches one of the regex then it will be hidden by defaults, otherwise it will be visible.

See GetSeriesVisibilityDefault to evaluate the default visibility of a given array name.

GetNumberOfChartsHiddenAttributes()

virtual int vtkPVRepresentedArrayListSettings::GetNumberOfChartsHiddenAttributes ( ) const

virtual

ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart.

If the name of the array matches one of the regex then it will be hidden by defaults, otherwise it will be visible.

See GetSeriesVisibilityDefault to evaluate the default visibility of a given array name.

SetChartsHiddenAttributes()

virtual void vtkPVRepresentedArrayListSettings::SetChartsHiddenAttributes ( int  i, const char *  expression  )

virtual

ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart.

If the name of the array matches one of the regex then it will be hidden by defaults, otherwise it will be visible.

See GetSeriesVisibilityDefault to evaluate the default visibility of a given array name.

GetAllChartsHiddenAttributes()

virtual const std::vector<vtksys::RegularExpression>& vtkPVRepresentedArrayListSettings::GetAllChartsHiddenAttributes ( ) const

virtual

ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart.

If the name of the array matches one of the regex then it will be hidden by defaults, otherwise it will be visible.

See GetSeriesVisibilityDefault to evaluate the default visibility of a given array name.

GetSeriesVisibilityDefault()

virtual bool vtkPVRepresentedArrayListSettings::GetSeriesVisibilityDefault ( const char *  name ) const

virtual

ChartsHiddenAttributes is a list of regex that controls whether or not array should be visible by defaults in a chart.

If the name of the array matches one of the regex then it will be hidden by defaults, otherwise it will be visible.

See GetSeriesVisibilityDefault to evaluate the default visibility of a given array name.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVRepresentedArrayListSettings.h