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

abstract superclass for all map properties More...

#include <vtkSMMapProperty.h>

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

Public Types

typedef vtkSMProperty Superclass
 
- Public Types inherited from vtkSMProperty
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 vtkIdType GetNumberOfElements ()
 Returns the number of elements for the value type. More...
 
virtual bool IsValueDefault ()
 Returns true if the current value is the same as the default value. More...
 
virtual void Copy (vtkSMProperty *src)
 Copy all property values. More...
 
- Public Member Functions inherited from vtkSMProperty
void PrintSelf (ostream &os, vtkIndent indent)
 
int IsInDomains ()
 Returns true if all values are in all domains, false otherwise. More...
 
int IsInDomains (vtkSMDomain **domain)
 Overload of IsInDomains() that provides a mechanism to return the first domain that fails the check. More...
 
virtual void UnRegister (vtkObjectBase *obj)
 Overloaded to break the reference loop caused by the internal domain iterator. More...
 
vtkSMDomainIteratorNewDomainIterator ()
 Creates, initializes and returns a new domain iterator. More...
 
vtkSMDomainGetDomain (const char *name)
 Returns a domain give a name. More...
 
vtkSMDomainFindDomain (const char *classname)
 Returns the first domain which is of the specified type. More...
 
unsigned int GetNumberOfDomains ()
 Returns the number of domains this property has. More...
 
void UpdateDependentDomains ()
 Calls Update() on all domains contained by the property as well as all dependant domains. More...
 
void AddDomain (const char *name, vtkSMDomain *dom)
 Properties can have one or more domains. More...
 
virtual void AddLinkedProperty (vtkSMProperty *targetProperty)
 Add a link to a property whose value should be synchronized with this property value. More...
 
virtual void RemoveLinkedProperty (vtkSMProperty *targetProperty)
 Remove a link to a property added with AddLinkedProperty() More...
 
virtual void RemoveFromSourceLink ()
 Remove a link from the source property. More...
 
void ResetToDefault ()
 Simply calls this->ResetToDomainDefaults() and if that returns false, calls this->ResetToXMLDefaults(). More...
 
virtual void ResetToXMLDefaults ()
 For properties that support specifying defaults in XML configuration, this method will reset the property value to the default values specified in the XML. More...
 
virtual bool ResetToDomainDefaults (bool use_unchecked_values=false)
 Iterates over all domains and call SetDefaultValues() on each domain until the first one returns true i.e. More...
 
vtkSMProxyGetParent ()
 Get the proxy to which this property belongs. More...
 
virtual bool IsStateIgnored ()
 
bool HasDomainsWithRequiredProperties ()
 Returns true if the property has a domain with required properties. More...
 
virtual void ClearUncheckedElements ()
 Use this method to clear unchecked values set of this property. More...
 
virtual void SetCommand (const char *)
 The command name used to set the value on the server object. More...
 
virtual char * GetCommand ()
 The command name used to set the value on the server object. More...
 
virtual void SetImmediateUpdate (int)
 If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...
 
virtual int GetImmediateUpdate ()
 If ImmediateUpdate is true, the value of the property will be pushed to the server as soon as it is modified. More...
 
virtual int GetInformationOnly ()
 Is InformationOnly is set to true, this property is used to get information from server instead of setting values. More...
 
virtual int GetIgnoreSynchronization ()
 If IgnoreSynchronization is set to true, this property is used to prevent that property from beeing updated when changed remotely by another collaborative client. More...
 
virtual vtkSMPropertyGetInformationProperty ()
 Get the associated information property. More...
 
virtual void SetAnimateable (int)
 Get/Set if the property is animateable. More...
 
virtual int GetAnimateable ()
 Get/Set if the property is animateable. More...
 
virtual void SetIsInternal (int)
 Get/Set if the property is internal to server manager. More...
 
virtual int GetIsInternal ()
 Get/Set if the property is internal to server manager. More...
 
virtual void SetNoCustomDefault (int)
 Sets whether the property should ignore custom default settings. More...
 
virtual int GetNoCustomDefault ()
 Gets whether the property should ignore custom default settings. More...
 
virtual void SetPanelVisibility (const char *)
 Sets the panel visibility for the property. More...
 
virtual char * GetPanelVisibility ()
 Returns the panel visibility for the property. More...
 
virtual void SetPanelVisibilityDefaultForRepresentation (const char *)
 Sets the panel visibility to default if the current representation type matches representation. More...
 
virtual char * GetPanelVisibilityDefaultForRepresentation ()
 Returns which representation type the property will be shown by default for. More...
 
virtual void SetPanelWidget (const char *)
 Sets the name of the custom panel widget to use for the property. More...
 
virtual char * GetPanelWidget ()
 Returns name of the panel widget for the property. More...
 
virtual vtkSMDocumentationGetDocumentation ()
 Returns the documentation for this proxy. More...
 
virtual char * GetXMLLabel ()
 The label assigned by the xml parser. More...
 
virtual char * GetXMLName ()
 The name assigned by the xml parser. More...
 
virtual int GetRepeatable ()
 If repeatable, a property can have 1 or more values of the same kind. More...
 
virtual vtkPVXMLElementGetHints ()
 The server manager configuration XML may define <Hints> element for a property. More...
 
void SetHints (vtkPVXMLElement *hints)
 The server manager configuration XML may define <Hints> element for a property. More...
 
virtual void Modified ()
 Overridden to support blocking of modified events. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSMMapPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMProperty
static vtkSMPropertyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMPropertySafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMMapProperty ()
 
 ~vtkSMMapProperty ()
 
virtual int LoadState (vtkPVXMLElement *element, vtkSMProxyLocator *loader)
 Updates state from an XML element. More...
 
virtual int ReadXMLAttributes (vtkSMProxy *parent, vtkPVXMLElement *element)
 Set the appropriate ivars from the xml element. More...
 
- Protected Member Functions inherited from vtkSMProperty
 vtkSMProperty ()
 
 ~vtkSMProperty ()
 
virtual void WriteTo (vtkSMMessage *msg)
 Let the property write its content into the stream. More...
 
virtual void ReadFrom (const vtkSMMessage *, int vtkNotUsed(message_offset), vtkSMProxyLocator *)
 Let the property read and set its content from the stream. More...
 
virtual void UpdateAllInputs ()
 Update all proxies referred by this property (if any). More...
 
vtkSMPropertyNewProperty (const char *name)
 Internal. More...
 
void AddDependent (vtkSMDomain *dom)
 Internal. More...
 
void RemoveAllDependents ()
 Removes all dependents. More...
 
void UpdateDomains ()
 Calls Update() on all domains contained by the property as well as all dependant domains. More...
 
virtual void SaveState (vtkPVXMLElement *parent, const char *property_name, const char *uid, int saveDomains=1)
 Save the property state in XML. More...
 
virtual void SaveStateValues (vtkPVXMLElement *propertyElement)
 This method must be overiden by concrete class in order to save the real property data. More...
 
virtual void SaveDomainState (vtkPVXMLElement *propertyElement, const char *uid)
 Save property domain. More...
 
virtual void SetXMLLabel (const char *)
 
virtual void SetInformationOnly (int)
 
virtual void SetIgnoreSynchronization (int)
 
void SetInformationProperty (vtkSMProperty *ip)
 
void SetDocumentation (vtkSMDocumentation *)
 
void SetParent (vtkSMProxy *proxy)
 
virtual void SetStateIgnored (bool)
 
virtual void StateIgnoredOn ()
 
virtual void StateIgnoredOff ()
 
virtual void SetXMLName (const char *)
 The name assigned by the xml parser. More...
 
bool SetBlockModifiedEvents (bool block)
 Block/unblock modified events, returns the current state of the block flag. More...
 
virtual bool GetPendingModifiedEvents ()
 Returns if any modified evetns are pending. More...
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkSMProperty
vtkPVXMLElementHints
 
char * Command
 
vtkSMPropertyInternalsPInternals
 
int ImmediateUpdate
 
int Animateable
 
int IsInternal
 
int NoCustomDefault
 
char * XMLName
 
char * XMLLabel
 
char * PanelVisibility
 
char * PanelVisibilityDefaultForRepresentation
 
char * PanelWidget
 
vtkSMDomainIteratorDomainIterator
 
int InformationOnly
 
int IgnoreSynchronization
 
vtkSMInformationHelper * InformationHelper
 
vtkSMPropertyInformationProperty
 
vtkSMDocumentationDocumentation
 
int Repeatable
 
vtkWeakPointer< vtkSMProxyProxy
 
bool StateIgnored
 
vtkSMPropertyLinkLinks
 

Detailed Description

abstract superclass for all map properties

vtkSMMapProperty defines an interface common for all map properties. A map property stores a set of keys and values.

Definition at line 29 of file vtkSMMapProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 of file vtkSMMapProperty.h.

Constructor & Destructor Documentation

◆ vtkSMMapProperty()

vtkSMMapProperty::vtkSMMapProperty ( )
protected

◆ ~vtkSMMapProperty()

vtkSMMapProperty::~vtkSMMapProperty ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMMapProperty::GetClassName ( )
virtual

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleMapProperty.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleMapProperty.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ GetNumberOfElements()

virtual vtkIdType vtkSMMapProperty::GetNumberOfElements ( )
virtual

Returns the number of elements for the value type.

Reimplemented in vtkSMDoubleMapProperty.

◆ IsValueDefault()

virtual bool vtkSMMapProperty::IsValueDefault ( )
virtual

Returns true if the current value is the same as the default value.

Reimplemented from vtkSMProperty.

◆ Copy()

virtual void vtkSMMapProperty::Copy ( vtkSMProperty src)
virtual

Copy all property values.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleMapProperty.

◆ LoadState()

virtual int vtkSMMapProperty::LoadState ( vtkPVXMLElement element,
vtkSMProxyLocator loader 
)
protectedvirtual

Updates state from an XML element.

Returns 0 on failure.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleMapProperty.

◆ ReadXMLAttributes()

virtual int vtkSMMapProperty::ReadXMLAttributes ( vtkSMProxy parent,
vtkPVXMLElement element 
)
protectedvirtual

Set the appropriate ivars from the xml element.

Should be overwritten by subclass if adding ivars.

Reimplemented from vtkSMProperty.

Reimplemented in vtkSMDoubleMapProperty.


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