vtkSMDoubleMapProperty.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMMapProperty.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 =========================================================================*/
22 #ifndef vtkSMDoubleMapProperty_h
23 #define vtkSMDoubleMapProperty_h
24 
25 #include "vtkRemotingServerManagerModule.h" //needed for exports
26 #include "vtkSMMapProperty.h"
27 
28 class vtkSMDoubleMapPropertyPrivate;
30 
32 {
33 public:
34  static vtkSMDoubleMapProperty* New();
36  void PrintSelf(ostream& os, vtkIndent indent) override;
37 
41  void SetNumberOfComponents(unsigned int components);
42 
46  unsigned int GetNumberOfComponents();
47 
51  void SetElement(vtkIdType index, double value);
52 
56  void SetElements(vtkIdType index, const double* values);
57 
61  void SetElements(vtkIdType index, const double* values, unsigned int numValues);
62 
66  void SetElementComponent(vtkIdType index, unsigned int component, double value);
67 
71  double GetElement(vtkIdType index);
72 
76  double* GetElements(vtkIdType index);
77 
81  double GetElementComponent(vtkIdType index, vtkIdType component);
82 
86  void RemoveElement(vtkIdType index);
87 
91  vtkIdType GetNumberOfElements() override;
92 
96  bool HasElement(vtkIdType index);
97 
101  void ClearElements();
102 
107  vtkSMDoubleMapPropertyIterator* NewIterator();
108 
109  void* GetMapPointer();
110 
114  void Copy(vtkSMProperty* src) override;
115 
121  void ResetToXMLDefaults() override;
122 
123 protected:
125  ~vtkSMDoubleMapProperty() override;
126 
127  void WriteTo(vtkSMMessage* msg) override;
128 
129  void ReadFrom(
130  const vtkSMMessage* message, int message_offset, vtkSMProxyLocator* locator) override;
131 
132  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;
133 
134  void SaveStateValues(vtkPVXMLElement* propertyElement) override;
135  int LoadState(vtkPVXMLElement* element, vtkSMProxyLocator* loader) override;
136 
137 private:
139  void operator=(const vtkSMDoubleMapProperty&) = delete;
140 
141  vtkSMDoubleMapPropertyPrivate* Private;
142 };
143 
144 #endif // vtkSMDoubleMapProperty_h
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.
#define VTKREMOTINGSERVERMANAGER_EXPORT
int ReadXMLAttributes(vtkSMProxy *parent, vtkPVXMLElement *element) override
Set the appropriate ivars from the xml element.
void PrintSelf(ostream &os, vtkIndent indent) override
superclass for all SM properties
int vtkIdType
a map property storing double values
virtual vtkIdType GetNumberOfElements()
Returns the number of elements for the value type.
int LoadState(vtkPVXMLElement *element, vtkSMProxyLocator *loader) override
Updates state from an XML element.
void Copy(vtkSMProperty *src) override
Copy all property values.
Header class that setup every thing in order to use Protobuf messages in a transparent manner...
static vtkSMProperty * New()
#define VTK_NEWINSTANCE
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.
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.
abstract superclass for all map properties