vtkSMDoubleVectorProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMDoubleVectorProperty.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 =========================================================================*/
25 #ifndef vtkSMDoubleVectorProperty_h
26 #define vtkSMDoubleVectorProperty_h
27 
28 #include "vtkRemotingServerManagerModule.h" //needed for exports
29 #include "vtkSMVectorProperty.h"
30 
31 class vtkSMStateLocator;
32 
34 {
35 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
43  unsigned int GetNumberOfElements() override;
44 
49  void SetNumberOfElements(unsigned int num) override;
50 
56  int SetElement(unsigned int idx, double value);
57 
59 
66  int SetElements(const double* values);
67  int SetElements(const double* values, unsigned int numValues);
68  double* GetElements();
70 
72 
75  int SetUncheckedElements(const double* values);
76  int SetUncheckedElements(const double* values, unsigned int numValues);
78 
85  int SetElements1(double value0);
86 
93  int SetElements2(double value0, double value1);
94 
101  int SetElements3(double value0, double value1, double value2);
102 
109  int SetElements4(double value0, double value1, double value2, double value3);
110 
114  int AppendElements(const double* values, unsigned int numValues);
115 
119  int AppendUncheckedElements(const double* values, unsigned int numValues);
120 
124  double GetElement(unsigned int idx);
125 
131  unsigned int GetNumberOfUncheckedElements() override;
132 
139  double GetUncheckedElement(unsigned int idx);
140 
146  void SetUncheckedElement(unsigned int idx, double value);
147 
149 
161  vtkGetMacro(ArgumentIsArray, int);
162  vtkSetMacro(ArgumentIsArray, int);
164 
168  void Copy(vtkSMProperty* src) override;
169 
170  void ClearUncheckedElements() override;
171 
172  bool IsValueDefault() override;
173 
179  void ResetToXMLDefaults() override;
180 
181 protected:
183  ~vtkSMDoubleVectorProperty() override;
184 
185  friend class vtkSMRenderViewProxy;
186 
190  void WriteTo(vtkSMMessage*) override;
191 
195  void ReadFrom(const vtkSMMessage*, int msg_offset, vtkSMProxyLocator*) override;
196 
197  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;
198 
200 
206  void SetNumberOfUncheckedElements(unsigned int num) override;
207 
211  int LoadState(vtkPVXMLElement* element, vtkSMProxyLocator* loader) override;
212 
213  // Save concrete property values into the XML state property declaration
214  void SaveStateValues(vtkPVXMLElement* propElement) override;
215 
216 private:
218  void operator=(const vtkSMDoubleVectorProperty&) = delete;
219 
220  class vtkInternals;
221  vtkInternals* Internals;
222 };
223 
224 #endif
virtual void SaveStateValues(vtkPVXMLElement *propertyElement)
This method must be overridden by concrete class in order to save the real property data...
virtual void WriteTo(vtkSMMessage *msg)
Let the property write its content into the stream.
void PrintSelf(ostream &os, vtkIndent indent) override
virtual void SetNumberOfUncheckedElements(unsigned int num)=0
API for setting unchecked element values.
#define VTKREMOTINGSERVERMANAGER_EXPORT
superclass for all SM properties
void Copy(vtkSMProperty *src) override
Copy all property values.
virtual void SetNumberOfElements(unsigned int num)=0
Sets the size of the vector.
abstract superclass for all vector properties
Header class that setup every thing in order to use Protobuf messages in a transparent manner...
static vtkSMProperty * New()
implementation for View that includes render window and renderers.
virtual unsigned int GetNumberOfUncheckedElements()=0
API for setting unchecked element values.
property representing a vector of doubles
virtual void ReadFrom(const vtkSMMessage *, int vtkNotUsed(message_offset), vtkSMProxyLocator *)
Let the property read and set its content from the stream.
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
is used to locate proxies referred to in state xmls while loading state files.
void ClearUncheckedElements() override=0
API for setting unchecked element values.
virtual void ResetToXMLDefaults()
For properties that support specifying defaults in XML configuration, this method will reset the prop...
This is used by vtkPVXMLParser to represent an XML document starting at the root element.
virtual int LoadState(vtkPVXMLElement *element, vtkSMProxyLocator *loader)
Updates state from an XML element.
int ReadXMLAttributes(vtkSMProxy *parent, vtkPVXMLElement *element) override
Set the appropriate ivars from the xml element.
virtual bool IsValueDefault()
Returns true if the property's value is different from the default value.
virtual unsigned int GetNumberOfElements()=0
Returns the size of the vector.
Class used to retrieve a given message state based on its GlobalID.