vtkSubsetInclusionLattice.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkSubsetInclusionLattice.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSubsetInclusionLattice_h
#define vtkSubsetInclusionLattice_h

#include "vtkObject.h"

#include "vtkNew.h"                       // For vtkNew.
#include "vtkPVVTKExtensionsCoreModule.h" // For export macro
#include "vtkSmartPointer.h"              // For vtkSmartPointer
#include <map>                            // for std::map
#include <vector>                         // for std::vector

class vtkInformation;
class vtkInformationObjectBaseKey;
class vtkInformationVector;

class VTKPVVTKEXTENSIONSCORE_EXPORT vtkSubsetInclusionLattice : public vtkObject
{
public:
  static vtkSubsetInclusionLattice* New();
  vtkTypeMacro(vtkSubsetInclusionLattice, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize();

  std::string Serialize() const;


  bool Deserialize(const std::string& data);
  bool Deserialize(const char* data);

  void DeepCopy(const vtkSubsetInclusionLattice* other);

  void Merge(const std::string& state);

  void Merge(const vtkSubsetInclusionLattice* other);

  int AddNode(const char* name, int parent = 0);

  int AddNodeAtPath(const char* path);

  bool AddCrossLink(int src, int dst);

  int FindNode(const char* path) const;

  enum SelectionStates
  {
    NotSelected = 0,
    Selected,
    PartiallySelected,
  };

  SelectionStates GetSelectionState(int node) const;

  SelectionStates GetSelectionState(const char* path) const
  {
    return this->GetSelectionState(this->FindNode(path));
  }

  bool Select(const char* path);

  bool Deselect(const char* path);


  bool Select(int node);
  bool Deselect(int node);

  void ClearSelections();


  bool SelectAll(const char* path);
  bool DeselectAll(const char* path);

  vtkGetMacro(SelectionChangeTime, vtkMTimeType);

  std::vector<int> GetChildren(int node) const;

  int GetParent(int node, int* childIndex = nullptr) const;

  const char* GetNodeName(int node) const;

  using SelectionType = std::map<std::string, bool>;

  SelectionType GetSelection() const;

  void SetSelection(const SelectionType& selection);

  void Modified() override;

  static vtkInformationObjectBaseKey* SUBSET_INCLUSION_LATTICE();


  static vtkSubsetInclusionLattice* GetSIL(vtkInformation* info);
  static vtkSubsetInclusionLattice* GetSIL(vtkInformationVector* v, int i = 0);

  static vtkSmartPointer<vtkSubsetInclusionLattice> Clone(const vtkSubsetInclusionLattice* other);

  bool IsMaxedOut();

protected:
  vtkSubsetInclusionLattice();
  ~vtkSubsetInclusionLattice();

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

  class vtkInternals;
  vtkInternals* Internals;
  friend class vtkInternals;

  void TriggerSelectionChanged(int node);

  vtkTimeStamp SelectionChangeTime;
};

#endif