ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMFunctionalBagChartSeriesSelectionDomain Class Reference

extends vtkSMChartSeriesListDomain to add logic to better handle default visibility suitable for bag and outliers. More...

#include <vtkSMFunctionalBagChartSeriesSelectionDomain.h>

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

Public Types

typedef vtkSMChartSeriesSelectionDomain Superclass
 
- Public Types inherited from vtkSMChartSeriesSelectionDomain
enum  DefaultModes {
  UNDEFINED, VISIBILITY, LABEL, COLOR,
  VALUE
}
 
typedef vtkSMStringListDomain Superclass
 
- Public Types inherited from vtkSMStringListDomain
typedef vtkSMDomain Superclass
 
- Public Types inherited from vtkSMDomain
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)
 
virtual bool GetDefaultSeriesVisibility (const char *)
 Returns the default visibility for a series given its name. More...
 
- Public Member Functions inherited from vtkSMChartSeriesSelectionDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Update (vtkSMProperty *)
 Update self checking the "unchecked" values of all required properties. More...
 
virtual int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 Set the property's default value based on the domain. More...
 
virtual int GetDefaultMode ()
 Get the default-mode that controls how SetDefaultValues() behaves. More...
 
- Public Member Functions inherited from vtkSMStringListDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 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...
 
virtual void SetAnimationValue (vtkSMProperty *, int, double)
 Set the value of an element of a property from the animation editor. More...
 
- Public Member Functions inherited from vtkSMDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
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 char * GetXMLName ()
 Assigned by the XML parser. More...
 
virtual bool GetIsOptional ()
 When the IsOptional flag is set, IsInDomain() always returns true. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent)
 
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 vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMFunctionalBagChartSeriesSelectionDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMFunctionalBagChartSeriesSelectionDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMChartSeriesSelectionDomain
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 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)
 

Protected Member Functions

 vtkSMFunctionalBagChartSeriesSelectionDomain ()
 
 ~vtkSMFunctionalBagChartSeriesSelectionDomain ()
 
virtual std::vector< vtkStdString > GetDefaultValue (const char *series)
 Get the default value that will be used for the series with the given name by this domain. More...
 
- Protected Member Functions inherited from vtkSMChartSeriesSelectionDomain
 vtkSMChartSeriesSelectionDomain ()
 
 ~vtkSMChartSeriesSelectionDomain ()
 
vtkPVDataInformationGetInputInformation ()
 Returns the datainformation from the current input, if possible. More...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
 Process any specific XML definition tags. More...
 
virtual void PopulateAvailableArrays (const std::string &blockName, std::vector< vtkStdString > &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< vtkStdString > &strings, std::set< vtkStdString > &unique_strings, vtkPVArrayInformation *dataInfo, bool flattenTable)
 Build up the domain with provided array. More...
 
virtual void SetDefaultVisibilityOverride (const vtkStdString &arrayname, bool visibility)
 Call this method in PopulateAvailableArrays() to override a specific array's default visibility. More...
 
virtual void SetDefaultValue (const char *)
 Value used when DefaultMode==VALUE. More...
 
- Protected Member Functions inherited from vtkSMStringListDomain
virtual void ChildSaveState (vtkPVXMLElement *domainElement)
 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< vtkStdString > &strings)
 Call to set the strings. More...
 
const std::vector< vtkStdString > & GetStrings ()
 Call to set the strings. More...
 
 vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
 ~vtkSMStringListDomain ()
 A vtkSMProperty is often defined with a default value in the XML itself. More...
 
- Protected Member Functions inherited from vtkSMDomain
 vtkSMDomain ()
 
 ~vtkSMDomain ()
 
virtual int LoadState (vtkPVXMLElement *vtkNotUsed(domainElement), vtkSMProxyLocator *vtkNotUsed(loader))
 Load the state of the domain from the XML. More...
 
vtkSMPropertyGetRequiredProperty (const char *function)
 Returns a given required property of the given function. 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...
 
virtual vtkPVDataInformationGetInputDataInformation (const char *function, int index=0)
 Helper method to get vtkPVDataInformation from input proxy connected to the required property with the given function. 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 ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMChartSeriesSelectionDomain
int DefaultMode
 
bool FlattenTable
 Specify if table components should be split. More...
 
char * DefaultValue
 Value used when DefaultMode==VALUE. More...
 
- Protected Attributes inherited from vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 
- Static Protected Attributes inherited from vtkSMChartSeriesSelectionDomain
static bool LoadNoVariables
 

Detailed Description

extends vtkSMChartSeriesListDomain to add logic to better handle default visibility suitable for bag and outliers.

vtkSMFunctionalBagChartSeriesSelectionDomain extends vtkSMChartSeriesSelectionDomain to handle default values visibility for bags and outliers.

Definition at line 30 of file vtkSMFunctionalBagChartSeriesSelectionDomain.h.

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ vtkSMFunctionalBagChartSeriesSelectionDomain()

vtkSMFunctionalBagChartSeriesSelectionDomain::vtkSMFunctionalBagChartSeriesSelectionDomain ( )
protected

§ ~vtkSMFunctionalBagChartSeriesSelectionDomain()

vtkSMFunctionalBagChartSeriesSelectionDomain::~vtkSMFunctionalBagChartSeriesSelectionDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMFunctionalBagChartSeriesSelectionDomain* vtkSMFunctionalBagChartSeriesSelectionDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMFunctionalBagChartSeriesSelectionDomain::GetClassName ( )
virtual

Reimplemented from vtkSMChartSeriesSelectionDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMChartSeriesSelectionDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ GetDefaultSeriesVisibility()

virtual bool vtkSMFunctionalBagChartSeriesSelectionDomain::GetDefaultSeriesVisibility ( const char *  )
virtual

Returns the default visibility for a series given its name.

Reimplemented from vtkSMChartSeriesSelectionDomain.

§ GetDefaultValue()

virtual std::vector<vtkStdString> vtkSMFunctionalBagChartSeriesSelectionDomain::GetDefaultValue ( const char *  series)
protectedvirtual

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

Reimplemented from vtkSMChartSeriesSelectionDomain.


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