vtkSMProxySelectionModel.h

Go to the documentation of this file.

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

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // Needed for vtkSMMessage*
#include "vtkSMRemoteObject.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.

class vtkSMProxySelectionModelInternal;
class vtkCollection;
class vtkSMProxy;

#include <list> // needed for vtkset::list.

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

  void SetSession(vtkSMSession*) override;


  void SetFollowingMaster(bool following);
  bool IsFollowingMaster();

  typedef std::list<vtkSmartPointer<vtkSMProxy>> SelectionType;

  // vtkSMProxy selection flags
  enum ProxySelectionFlag
  {
    NO_UPDATE = 0,
    CLEAR = 1,
    SELECT = 2,
    DESELECT = 4,
    CLEAR_AND_SELECT = CLEAR | SELECT
  };

  vtkSMProxy* GetCurrentProxy();

  void SetCurrentProxy(vtkSMProxy* proxy, int command);

  bool IsSelected(vtkSMProxy* proxy);

  // Returns the number of selected proxies.
  unsigned int GetNumberOfSelectedProxies();

  vtkSMProxy* GetSelectedProxy(unsigned int index);

  const SelectionType& GetSelection() { return this->Selection; }

  void Select(const SelectionType& proxies, int command);

  void Select(vtkSMProxy* proxy, int command);

  void Clear() { this->Select(nullptr, CLEAR); }
  void Select(vtkSMProxy* proxy) { this->Select(proxy, SELECT); }
  void Deselect(vtkSMProxy* proxy) { this->Select(proxy, DESELECT); }
  void ClearAndSelect(vtkSMProxy* proxy) { this->Select(proxy, CLEAR_AND_SELECT); }

  bool GetSelectionDataBounds(double bounds[6]);

  const vtkSMMessage* GetFullState() override;

  void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) override;

protected:
  vtkSMProxySelectionModel();
  ~vtkSMProxySelectionModel() override;

  void InvokeCurrentChanged(vtkSMProxy* proxy);
  void InvokeSelectionChanged();

  vtkSmartPointer<vtkSMProxy> Current;
  SelectionType Selection;

  void PushStateToSession();

  // Cached version of State
  vtkSMMessage* State;

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

  class vtkInternal;
  friend class vtkInternal;
  vtkInternal* Internal;
};

#endif