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

extends vtkSMBooleanDomain to pick a good default for properties such as "UseIndexForXAxis" on chart representations. More...

#include <vtkSMChartUseIndexForAxisDomain.h>

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

Public Types

typedef vtkSMBooleanDomain Superclass
 
- Public Types inherited from vtkSMBooleanDomain
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 int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values)
 Set the default values for the property. More...
 
virtual void Update (vtkSMProperty *requestingProperty)
 Overridden to fire DomainModified when the required property changes. More...
 
- Public Member Functions inherited from vtkSMBooleanDomain
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsInDomain (vtkSMProperty *property)
 Returns true if the propery is a vtkSMIntVectorProperty. More...
 
virtual void SetAnimationValue (vtkSMProperty *property, int idx, double value)
 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 vtkSMChartUseIndexForAxisDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMChartUseIndexForAxisDomainSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMBooleanDomain
static vtkSMBooleanDomainNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMBooleanDomainSafeDownCast (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

 vtkSMChartUseIndexForAxisDomain ()
 
 ~vtkSMChartUseIndexForAxisDomain ()
 
- Protected Member Functions inherited from vtkSMBooleanDomain
 vtkSMBooleanDomain ()
 
 ~vtkSMBooleanDomain ()
 
- 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...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem)
 Set the appropriate ivars from the xml element. 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 ChildSaveState (vtkPVXMLElement *domainElement)
 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 vtkSMDomain
char * XMLName
 
bool IsOptional
 
vtkSMDomainInternals * Internals
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Detailed Description

extends vtkSMBooleanDomain to pick a good default for properties such as "UseIndexForXAxis" on chart representations.

vtkSMChartUseIndexForAxisDomain extends vtkSMBooleanDomain to add logic to pick an appropriate default e.g. UseIndexForXAxis for bar and line charts needs to be set to 0 by default, if the XArrayName is one of the known arrays such as "bin_extents", "arc_length", and set to 1 otherwise. This class encapsulates that logic.

Supported Required-Property functions:

Definition at line 38 of file vtkSMChartUseIndexForAxisDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 42 of file vtkSMChartUseIndexForAxisDomain.h.

Constructor & Destructor Documentation

§ vtkSMChartUseIndexForAxisDomain()

vtkSMChartUseIndexForAxisDomain::vtkSMChartUseIndexForAxisDomain ( )
protected

§ ~vtkSMChartUseIndexForAxisDomain()

vtkSMChartUseIndexForAxisDomain::~vtkSMChartUseIndexForAxisDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMChartUseIndexForAxisDomain* vtkSMChartUseIndexForAxisDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMChartUseIndexForAxisDomain::GetClassName ( )
virtual

Reimplemented from vtkSMBooleanDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMBooleanDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetDefaultValues()

virtual int vtkSMChartUseIndexForAxisDomain::SetDefaultValues ( vtkSMProperty ,
bool  use_unchecked_values 
)
virtual

Set the default values for the property.

Overridden to handle the default value for "UseIndexForXAxis" property, if any. UseIndexForXAxis needs to be OFF by default, if the required property e.g. XArrayName property has one of the known types of arrays, otherwise it must be ON.

§ Update()

virtual void vtkSMChartUseIndexForAxisDomain::Update ( vtkSMProperty requestingProperty)
virtual

Overridden to fire DomainModified when the required property changes.

This ensures that SetDefaultValues() is called during proxy post-initialization after the required property has been reset to default.

Reimplemented from vtkSMDomain.


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