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

a domain with two values: true or false More...

#include <vtkSMBooleanDomain.h>

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

Public Types

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 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 Update (vtkSMProperty *requestingProperty)
 Update self based on the "unchecked" values of all required properties. 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 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 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

 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

a domain with two values: true or false

vtkSMBooleanDomain does not really restrict the values of the property that contains it. All integer values are valid. Rather, it is used to specified that the property represents a true/false state. This domains works with only vtkSMIntVectorProperty.

See also
vtkSMDomain vtkSMIntVectorProperty

Definition at line 33 of file vtkSMBooleanDomain.h.

Member Typedef Documentation

§ Superclass

Definition at line 37 of file vtkSMBooleanDomain.h.

Constructor & Destructor Documentation

§ vtkSMBooleanDomain()

vtkSMBooleanDomain::vtkSMBooleanDomain ( )
protected

§ ~vtkSMBooleanDomain()

vtkSMBooleanDomain::~vtkSMBooleanDomain ( )
protected

Member Function Documentation

§ New()

static vtkSMBooleanDomain* vtkSMBooleanDomain::New ( )
static

§ GetClassName()

virtual const char* vtkSMBooleanDomain::GetClassName ( )
virtual

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMChartUseIndexForAxisDomain.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMDomain.

Reimplemented in vtkSMChartUseIndexForAxisDomain.

§ SafeDownCast()

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

§ PrintSelf()

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

§ IsInDomain()

virtual int vtkSMBooleanDomain::IsInDomain ( vtkSMProperty property)
virtual

Returns true if the propery is a vtkSMIntVectorProperty.

Return 0 otherwise.

Implements vtkSMDomain.

§ SetAnimationValue()

virtual void vtkSMBooleanDomain::SetAnimationValue ( vtkSMProperty property,
int  idx,
double  value 
)
virtual

Set the value of an element of a property from the animation editor.


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