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
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
 
int SetDefaultValues (vtkSMProperty *, bool use_unchecked_values) override
 Set the default values for the property. More...
 
void Update (vtkSMProperty *requestingProperty) override
 Overridden to fire DomainModified when the required property changes. More...
 
- Public Member Functions inherited from vtkSMBooleanDomain
int IsInDomain (vtkSMProperty *property) override
 Returns true if the property is a vtkSMIntVectorProperty. More...
 
void SetAnimationValue (vtkSMProperty *property, int idx, double value) override
 Set the value of an element of a property from the animation editor. 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 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 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

 vtkSMChartUseIndexForAxisDomain ()
 
 ~vtkSMChartUseIndexForAxisDomain () override
 
- Protected Member Functions inherited from vtkSMBooleanDomain
 vtkSMBooleanDomain ()
 
 ~vtkSMBooleanDomain () override
 
- 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...
 
virtual int ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *elem)
 Set the appropriate ivars from the xml element. 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 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 () 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 &)
 

Additional Inherited Members

- 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
 

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 contains 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 ( )
overrideprotected

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

Reimplemented from vtkSMBooleanDomain.

◆ SetDefaultValues()

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

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

void vtkSMChartUseIndexForAxisDomain::Update ( vtkSMProperty requestingProperty)
overridevirtual

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: