Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkSMChartSeriesSelectionDomain Class Reference

extends vtkSMChartSeriesListDomain to add logic to better handle default values suitable for series-parameter type properties such as SeriesVisibility, SeriesLabel, etc. More...

#include <vtkSMChartSeriesSelectionDomain.h>

Inheritance diagram for vtkSMChartSeriesSelectionDomain:
Inheritance graph
[legend]
Collaboration diagram for vtkSMChartSeriesSelectionDomain:
Collaboration graph
[legend]

Public Types

enum  DefaultModes {
  UNDEFINED, VISIBILITY, LABEL, COLOR,
  VALUE
}
 
typedef vtkSMStringListDomain Superclass
 
- Public Types inherited from vtkSMStringListDomain
typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
enum  IsInDomainReturnCodes { NOT_APPLICABLE = -1, NOT_IN_DOMAIN = 0, IN_DOMAIN = 1 }
 Return values for IsInDomain calls. More...
 
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void Update (vtkSMProperty *) override
 Update self checking the "unchecked" values of all required properties. More...
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 Set the property's default value based on the domain. More...
 
virtual void SetDefaultValue (const char *)
 
virtual int GetDefaultMode ()
 Get the default-mode that controls how SetDefaultValues() behaves. More...
 
- Public Member Functions inherited from vtkSMStringListDomain
int IsInDomain (vtkSMProperty *property) override
 Returns true if the value of the property is in the domain. More...
 
int IsInDomain (const char *string, unsigned int &idx)
 Returns true if the string is in the domain. More...
 
const char * GetString (unsigned int idx)
 Returns a string in the domain. More...
 
unsigned int GetNumberOfStrings ()
 Returns the number of strings in the domain. More...
 
void SetAnimationValue (vtkSMProperty *, int, double) override
 Set the value of an element of a property from the animation editor. More...
 
virtual char * GetNoneString ()
 Return the string that is used as "none_string" in XML configuration. More...
 
virtual void SetNoneString (const char *)
 Return the string that is used as "none_string" in XML configuration. More...
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
- Public Member Functions inherited from vtkSMDomain
virtual int IsInDomain (vtkSMProperty *vtkNotUsed(property))
 Is the (unchecked) value of the property in the domain? Overwritten by sub-classes. More...
 
virtual void SetAnimationValue (vtkSMProperty *, int vtkNotUsed(index), double vtkNotUsed(value))
 Set the value of an element of a property from the animation editor. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool vtkNotUsed(use_unchecked_values))
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
vtkSMPropertyGetProperty ()
 Provides access to the vtkSMProperty on which this domain is hooked up. More...
 
virtual unsigned int GetNumberOfInputConnections (const char *function)
 Helper method to get the number of input connections hence the number of available vtkPVDataInformation from input proxy connected to the required property with the given function. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. More...
 
virtual char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
virtual vtkPVDataInformationGetInputSubsetDataInformation (unsigned int compositeIndex, const char *function, unsigned int index=0)
 Helper methods to get vtkPVDataInformation from input proxy connected to the required property with the given function and provided input index. More...
 
- Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMChartSeriesSelectionDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMChartSeriesSelectionDomainSafeDownCast (vtkObject *o)
 
static void AddSeriesVisibilityDefault (const char *regex, bool value)
 Add/Remove series names to hide by default. More...
 
static void SetLoadNoChartVariables (bool choice)
 Global flag to toggle between (a) the default behavior and (b) setting default visibility to off. More...
 
static bool GetLoadNoChartVariables ()
 
- Static Public Member Functions inherited from vtkSMStringListDomain
static vtkSMStringListDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMStringListDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMDomain
static vtkSMDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMChartSeriesSelectionDomain ()
 
 ~vtkSMChartSeriesSelectionDomain () override
 
vtkPVDataInformationGetInputInformation ()
 Returns the datainformation from the current input, if possible. More...
 
int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element) override
 Process any specific XML definition tags. More...
 
virtual bool GetDefaultSeriesVisibility (const char *)
 Returns the default visibility for a series given its name. More...
 
virtual std::vector< std::stringGetDefaultValue (const char *series)
 Get the default value that will be used for the series with the given name by this domain. More...
 
virtual void PopulateAvailableArrays (const std::string &blockName, std::vector< std::string > &strings, vtkPVDataInformation *dataInfo, int fieldAssociation, bool flattenTable)
 Build up the domain with available series names. More...
 
virtual void PopulateArrayComponents (vtkChartRepresentation *chartRepr, const std::string &blockName, std::vector< std::string > &strings, std::set< std::string > &unique_strings, vtkPVArrayInformation *dataInfo, bool flattenTable)
 Build up the domain with provided array. More...
 
virtual void SetDefaultVisibilityOverride (const std::string &arrayname, bool visibility)
 Call this method in PopulateAvailableArrays() to override a specific array's default visibility. More...
 
- Protected Member Functions inherited from vtkSMStringListDomain
void ChildSaveState (vtkPVXMLElement *domainElement) override
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetStrings (const std::vector< std::string > &strings)
 Call to set the strings. More...
 
const std::vector< std::string > & GetStrings ()
 Call to set the strings. More...
 
 vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 ~vtkSMStringListDomain () override
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain () override
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. More...
 
void RemoveRequiredProperty (vtkSMProperty *prop)
 Remove the given property from the required properties list. More...
 
void AddRequiredProperty (vtkSMProperty *prop, const char *function)
 Add a new required property to this domain. More...
 
void DomainModified ()
 Invokes DomainModifiedEvent. More...
 
void InvokeModified ()
 
unsigned int GetNumberOfRequiredProperties ()
 Gets the number of required properties added. More...
 
void SetProperty (vtkSMProperty *)
 Set the domain's property. More...
 
void SaveState (vtkPVXMLElement *parent, const char *uid)
 Add the header and creates a new vtkPVXMLElement for the domain, fills it up with the common attributes. More...
 
virtual void SetIsOptional (bool)
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
virtual void SetXMLName (const char *)
 Assigned by the XML parser. More...
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () 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 &)
 

Protected Attributes

int DefaultMode
 
bool FlattenTable
 Specify if table components should be split. More...
 
bool HidePartialArrays
 Specify if Partial Arrays should be hidden. More...
 
char * DefaultValue
 Value used when DefaultMode==VALUE. More...
 
- Protected Attributes inherited from vtkSMStringListDomain
char * NoneString
 Default string always present in this string list. More...
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static bool LoadNoVariables
 

Detailed Description

extends vtkSMChartSeriesListDomain to add logic to better handle default values suitable for series-parameter type properties such as SeriesVisibility, SeriesLabel, etc.

vtkSMChartSeriesSelectionDomain extends vtkSMChartSeriesListDomain to add logic to better handle default values suitable for series-parameter type properties such as SeriesVisibility, SeriesLabel, etc.

This domain also supports an experimental feature (we can generalize this to vtkSMDomain is found useful in other places). Generally, a vtkSMProperty never changes unless the application/user updates it. However for things like series parameters, it is useful if the property is updated to handle changed/newly added series consistently in the Qt application and the Python. To support that, this domain resets the property value to default every time the domain changes preserving status for existing series i.e. it won't affect the state for any series that already set on the property. Thus, it's not a true "reset", but more like "update".

Supported XML attributes

Definition at line 53 of file vtkSMChartSeriesSelectionDomain.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkSMChartSeriesSelectionDomain.h.

Member Enumeration Documentation

◆ DefaultModes

Enumerator
UNDEFINED 
VISIBILITY 
LABEL 
COLOR 
VALUE 

Definition at line 66 of file vtkSMChartSeriesSelectionDomain.h.

Constructor & Destructor Documentation

◆ vtkSMChartSeriesSelectionDomain()

vtkSMChartSeriesSelectionDomain::vtkSMChartSeriesSelectionDomain ( )
protected

◆ ~vtkSMChartSeriesSelectionDomain()

vtkSMChartSeriesSelectionDomain::~vtkSMChartSeriesSelectionDomain ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMChartSeriesSelectionDomain* vtkSMChartSeriesSelectionDomain::New ( )
static

◆ GetClassName()

virtual const char* vtkSMChartSeriesSelectionDomain::GetClassName ( )
virtual

Reimplemented from vtkSMStringListDomain.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMStringListDomain.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMChartSeriesSelectionDomain::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMStringListDomain.

◆ Update()

void vtkSMChartSeriesSelectionDomain::Update ( vtkSMProperty )
overridevirtual

Update self checking the "unchecked" values of all required properties.

Reimplemented from vtkSMStringListDomain.

◆ SetDefaultValues()

int vtkSMChartSeriesSelectionDomain::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
override

Set the property's default value based on the domain.

How the value is determined using the range is controlled by DefaultMode.

◆ GetDefaultMode()

virtual int vtkSMChartSeriesSelectionDomain::GetDefaultMode ( )
virtual

Get the default-mode that controls how SetDefaultValues() behaves.

◆ AddSeriesVisibilityDefault()

static void vtkSMChartSeriesSelectionDomain::AddSeriesVisibilityDefault ( const char *  regex,
bool  value 
)
static

Add/Remove series names to hide by default.

These are regular expressions.

◆ SetLoadNoChartVariables()

static void vtkSMChartSeriesSelectionDomain::SetLoadNoChartVariables ( bool  choice)
inlinestatic

Global flag to toggle between (a) the default behavior and (b) setting default visibility to off.

Definition at line 97 of file vtkSMChartSeriesSelectionDomain.h.

◆ GetLoadNoChartVariables()

static bool vtkSMChartSeriesSelectionDomain::GetLoadNoChartVariables ( )
inlinestatic

Definition at line 101 of file vtkSMChartSeriesSelectionDomain.h.

◆ SetDefaultValue()

virtual void vtkSMChartSeriesSelectionDomain::SetDefaultValue ( const char *  )
virtual

◆ GetInputInformation()

vtkPVDataInformation* vtkSMChartSeriesSelectionDomain::GetInputInformation ( )
protected

Returns the datainformation from the current input, if possible.

◆ ReadXMLAttributes()

int vtkSMChartSeriesSelectionDomain::ReadXMLAttributes ( vtkSMProperty prop,
vtkPVXMLElement element 
)
overrideprotectedvirtual

Process any specific XML definition tags.

Reimplemented from vtkSMStringListDomain.

◆ GetDefaultSeriesVisibility()

virtual bool vtkSMChartSeriesSelectionDomain::GetDefaultSeriesVisibility ( const char *  )
protectedvirtual

Returns the default visibility for a series given its name.

◆ GetDefaultValue()

virtual std::vector<std::string> vtkSMChartSeriesSelectionDomain::GetDefaultValue ( const char *  series)
protectedvirtual

Get the default value that will be used for the series with the given name by this domain.

◆ PopulateAvailableArrays()

virtual void vtkSMChartSeriesSelectionDomain::PopulateAvailableArrays ( const std::string blockName,
std::vector< std::string > &  strings,
vtkPVDataInformation dataInfo,
int  fieldAssociation,
bool  flattenTable 
)
protectedvirtual

Build up the domain with available series names.

Add arrays from dataInfo to strings. If blockName is non-empty, then it's used to "uniquify" the array names.

◆ PopulateArrayComponents()

virtual void vtkSMChartSeriesSelectionDomain::PopulateArrayComponents ( vtkChartRepresentation chartRepr,
const std::string blockName,
std::vector< std::string > &  strings,
std::set< std::string > &  unique_strings,
vtkPVArrayInformation dataInfo,
bool  flattenTable 
)
protectedvirtual

Build up the domain with provided array.

Add array component from dataArray to strings. If blockName is non-empty, then it's used to "uniquify" the array names.

◆ SetDefaultVisibilityOverride()

virtual void vtkSMChartSeriesSelectionDomain::SetDefaultVisibilityOverride ( const std::string arrayname,
bool  visibility 
)
protectedvirtual

Call this method in PopulateAvailableArrays() to override a specific array's default visibility.

Used for hiding array components, by default, for example.

Member Data Documentation

◆ DefaultMode

int vtkSMChartSeriesSelectionDomain::DefaultMode
protected

Definition at line 155 of file vtkSMChartSeriesSelectionDomain.h.

◆ DefaultValue

char* vtkSMChartSeriesSelectionDomain::DefaultValue
protected

Value used when DefaultMode==VALUE.

Definition at line 161 of file vtkSMChartSeriesSelectionDomain.h.

◆ FlattenTable

bool vtkSMChartSeriesSelectionDomain::FlattenTable
protected

Specify if table components should be split.

Definition at line 167 of file vtkSMChartSeriesSelectionDomain.h.

◆ HidePartialArrays

bool vtkSMChartSeriesSelectionDomain::HidePartialArrays
protected

Specify if Partial Arrays should be hidden.

Definition at line 172 of file vtkSMChartSeriesSelectionDomain.h.

◆ LoadNoVariables

bool vtkSMChartSeriesSelectionDomain::LoadNoVariables
staticprotected

Definition at line 174 of file vtkSMChartSeriesSelectionDomain.h.


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