vtkSMSelectionHelper.h

Go to the documentation of this file.

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

#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSMObject.h"

class vtkCollection;
class vtkSelection;
class vtkSelectionNode;
class vtkSMProxy;
class vtkSMSession;
class vtkSMSourceProxy;

class VTKREMOTINGVIEWS_EXPORT vtkSMSelectionHelper : public vtkSMObject
{
public:
  static vtkSMSelectionHelper* New();
  vtkTypeMacro(vtkSMSelectionHelper, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkSMProxy* NewAppendSelectionsFromSelectionSource(vtkSMSourceProxy* selectionSource);

  enum class CombineOperation
  {
    DEFAULT = 0,
    ADDITION = 1,
    SUBTRACTION = 2,
    TOGGLE = 3
  };


  static bool CombineSelection(vtkSMSourceProxy* appendSelections1,
    vtkSMSourceProxy* appendSelections2, CombineOperation operation, bool deepCopy = false);
  static bool IgnoreSelection(
    vtkSMSourceProxy* appendSelections1, vtkSMSourceProxy* appendSelections2, bool deepCopy = false)
  {
    return CombineSelection(
      appendSelections1, appendSelections2, CombineOperation::DEFAULT, deepCopy);
  }
  static bool AddSelection(
    vtkSMSourceProxy* appendSelections1, vtkSMSourceProxy* appendSelections2, bool deepCopy = false)
  {
    return CombineSelection(
      appendSelections1, appendSelections2, CombineOperation::ADDITION, deepCopy);
  }
  static bool SubtractSelection(
    vtkSMSourceProxy* appendSelections1, vtkSMSourceProxy* appendSelections2, bool deepCopy = false)
  {
    return CombineSelection(
      appendSelections1, appendSelections2, CombineOperation::SUBTRACTION, deepCopy);
  }
  static bool ToggleSelection(
    vtkSMSourceProxy* appendSelections1, vtkSMSourceProxy* appendSelections2, bool deepCopy = false)
  {
    return CombineSelection(
      appendSelections1, appendSelections2, CombineOperation::TOGGLE, deepCopy);
  }

  static vtkSMProxy* NewSelectionSourceFromSelection(
    vtkSMSession* session, vtkSelection* selection, bool ignore_composite_keys = false);

  static void NewSelectionSourcesFromSelection(vtkSelection* selection, vtkSMProxy* view,
    vtkCollection* selSources, vtkCollection* selRepresentations);

  static vtkSMProxy* ConvertAppendSelections(int outputType, vtkSMSourceProxy* appendSelections,
    vtkSMSourceProxy* dataSource, int dataPort, bool& selectionChanged);

  static vtkSMProxy* ConvertSelectionSource(int outputType, vtkSMSourceProxy* selectionSourceProxy,
    vtkSMSourceProxy* dataSource, int dataPort);

protected:
  vtkSMSelectionHelper() = default;
  ~vtkSMSelectionHelper() override = default;

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

  static vtkSMProxy* NewSelectionSourceFromSelectionInternal(
    vtkSMSession*, vtkSelectionNode* selection, vtkSMProxy* selSource, bool ignore_composite_keys);

  static vtkSMProxy* ConvertInternal(
    vtkSMSourceProxy* inSource, vtkSMSourceProxy* dataSource, int dataPort, int outputType);

  static const std::string SubSelectionBaseName;
};

#endif