vtkSMIdTypeVectorProperty.h

Go to the documentation of this file.

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

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMVectorProperty.h"

#include <vector> // for std::vector

class vtkSMStateLocator;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMIdTypeVectorProperty : public vtkSMVectorProperty
{
public:
  static vtkSMIdTypeVectorProperty* New();
  vtkTypeMacro(vtkSMIdTypeVectorProperty, vtkSMVectorProperty);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  unsigned int GetNumberOfElements() override;

  void SetNumberOfElements(unsigned int num) override;

  int SetElement(unsigned int idx, vtkIdType value);


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


  int SetUncheckedElements(const vtkIdType* values);
  int SetUncheckedElements(const vtkIdType* values, unsigned int numValues);

  int SetElements1(vtkIdType value0);

  int SetElements2(vtkIdType value0, vtkIdType value1);

  int SetElements3(vtkIdType value0, vtkIdType value1, vtkIdType value2);

  int AppendElements(const vtkIdType* values, unsigned int numValues);

  int AppendUncheckedElements(const vtkIdType* values, unsigned int numValues);

  vtkIdType GetElement(unsigned int idx);

  vtkIdType GetUncheckedElement(unsigned int idx);

  void SetUncheckedElement(unsigned int idx, vtkIdType value);

  unsigned int GetNumberOfUncheckedElements() override;


  const std::vector<vtkIdType>& GetElements() const;
  const std::vector<vtkIdType>& GetUncheckedElements() const;


  vtkGetMacro(ArgumentIsArray, int);
  vtkSetMacro(ArgumentIsArray, int);
  vtkBooleanMacro(ArgumentIsArray, int);

  void Copy(vtkSMProperty* src) override;

  void ClearUncheckedElements() override;

  void ResetToXMLDefaults() override;

protected:
  vtkSMIdTypeVectorProperty();
  ~vtkSMIdTypeVectorProperty() override;

  void WriteTo(vtkSMMessage*) override;

  void ReadFrom(const vtkSMMessage*, int msg_offset, vtkSMProxyLocator*) override;

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

  int ArgumentIsArray;

  void SetNumberOfUncheckedElements(unsigned int num) override;

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

  // Save concrete property values into the XML state property declaration
  void SaveStateValues(vtkPVXMLElement* propElement) override;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif