ParaView
vtkSMVectorProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMVectorProperty.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
26 #ifndef vtkSMVectorProperty_h
27 #define vtkSMVectorProperty_h
28 
29 #include "vtkPVServerManagerCoreModule.h" //needed for exports
30 #include "vtkSMProperty.h"
31 
32 class VTKPVSERVERMANAGERCORE_EXPORT vtkSMVectorProperty : public vtkSMProperty
33 {
34 public:
36  void PrintSelf(ostream& os, vtkIndent indent);
37 
41  virtual unsigned int GetNumberOfElements() = 0;
42 
46  virtual void SetNumberOfElements(unsigned int num) = 0;
47 
49 
52  virtual unsigned int GetNumberOfUncheckedElements() = 0;
53  virtual void SetNumberOfUncheckedElements(unsigned int num) = 0;
54  virtual void ClearUncheckedElements() = 0;
56 
58 
70  vtkGetMacro(RepeatCommand, int);
71  vtkSetMacro(RepeatCommand, int);
72  vtkBooleanMacro(RepeatCommand, int);
74 
76 
88  vtkGetMacro(NumberOfElementsPerCommand, int);
89  vtkSetMacro(NumberOfElementsPerCommand, int);
91 
93 
105  vtkGetMacro(UseIndex, int);
106  vtkSetMacro(UseIndex, int);
107  vtkBooleanMacro(UseIndex, int);
109 
111 
116  vtkSetStringMacro(CleanCommand);
117  vtkGetStringMacro(CleanCommand);
119 
123  virtual void Copy(vtkSMProperty* src);
124 
126 
130  vtkSetStringMacro(SetNumberCommand);
131  vtkGetStringMacro(SetNumberCommand);
133 
134  vtkSetStringMacro(InitialString);
135  vtkGetStringMacro(InitialString);
136 
144  virtual bool ResetToDomainDefaults(bool use_unchecked_values = false);
145 
146 protected:
149 
152  int UseIndex;
153 
157 
161  virtual int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element);
162 
163 private:
164  vtkSMVectorProperty(const vtkSMVectorProperty&) VTK_DELETE_FUNCTION;
165  void operator=(const vtkSMVectorProperty&) VTK_DELETE_FUNCTION;
166 };
167 
168 #endif
virtual int ReadXMLAttributes(vtkSMProxy *parent, vtkPVXMLElement *element)
Set the appropriate ivars from the xml element.
superclass for all SM properties
virtual void Copy(vtkSMProperty *src)
Copy all property values.
abstract superclass for all vector properties
virtual bool ResetToDomainDefaults(bool use_unchecked_values=false)
Iterates over all domains and call SetDefaultValues() on each domain until the first one returns true...
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
void PrintSelf(ostream &os, vtkIndent indent)
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
virtual void ClearUncheckedElements()
Use this method to clear unchecked values set of this property.