vtkSMDoubleMapProperty.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMDoubleMapProperty_h
#define vtkSMDoubleMapProperty_h

#include "vtkParaViewDeprecation.h"         // for deprec macro
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMapProperty.h"

class vtkSMDoubleMapPropertyPrivate;
class vtkSMDoubleMapPropertyIterator;

class PARAVIEW_DEPRECATED_IN_6_3_0(
  "No property uses this class anymore.") VTKREMOTINGSERVERMANAGER_EXPORT vtkSMDoubleMapProperty
  : public vtkSMMapProperty
{
public:
  static vtkSMDoubleMapProperty* New();
  vtkTypeMacro(vtkSMDoubleMapProperty, vtkSMMapProperty);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetNumberOfComponents(unsigned int components);

  unsigned int GetNumberOfComponents();

  void SetElement(vtkIdType index, double value);

  void SetElements(vtkIdType index, const double* values);

  void SetElements(vtkIdType index, const double* values, unsigned int numValues);

  void SetElementComponent(vtkIdType index, unsigned int component, double value);

  double GetElement(vtkIdType index);

  double* GetElements(vtkIdType index);

  double GetElementComponent(vtkIdType index, vtkIdType component);

  void RemoveElement(vtkIdType index);

  vtkIdType GetNumberOfElements() override;

  bool HasElement(vtkIdType index);

  void ClearElements();

  VTK_NEWINSTANCE
  vtkSMDoubleMapPropertyIterator* NewIterator();

  void* GetMapPointer();

  void Copy(vtkSMProperty* src) override;

  void ResetToXMLDefaults() override;

protected:
  vtkSMDoubleMapProperty();
  ~vtkSMDoubleMapProperty() override;

  void WriteTo(vtkSMMessage* msg) override;

  void ReadFrom(
    const vtkSMMessage* message, int message_offset, vtkSMProxyLocator* locator) override;

  int ReadXMLAttributes(vtkSMProxy* parent, vtkPVXMLElement* element) override;

  void SaveStateValues(vtkPVXMLElement* propertyElement) override;
  int LoadState(vtkPVXMLElement* element, vtkSMProxyLocator* loader) override;

private:
  vtkSMDoubleMapProperty(const vtkSMDoubleMapProperty&) = delete;
  void operator=(const vtkSMDoubleMapProperty&) = delete;

  vtkSMDoubleMapPropertyPrivate* Private;
};

#endif // vtkSMDoubleMapProperty_h