vtkCompositeDataDisplayAttributes.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkCompositeDataDisplayAttributes.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 vtkCompositeDataDisplayAttributes_h
#define vtkCompositeDataDisplayAttributes_h
#include <functional>               // for std::function
#include <unordered_map>            // for std::unordered_map

#include "vtkColor.h"               // for vtkColor3d
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // for export macro


class vtkBoundingBox;
class vtkDataObject;

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

  bool HasBlockVisibilities() const;


  void SetBlockVisibility(vtkDataObject* data_object, bool visible);
  bool GetBlockVisibility(vtkDataObject* data_object) const;

  bool HasBlockVisibility(vtkDataObject* data_object) const;

  void RemoveBlockVisibility(vtkDataObject* data_object);

  void RemoveBlockVisibilities();
  // This method is deprecated and will be removed in VTK 8.2. It is misspelled.
  VTK_LEGACY(void RemoveBlockVisibilites());

  bool HasBlockPickabilities() const;


  void SetBlockPickability(vtkDataObject* data_object, bool visible);
  bool GetBlockPickability(vtkDataObject* data_object) const;

  bool HasBlockPickability(vtkDataObject* data_object) const;

  void RemoveBlockPickability(vtkDataObject* data_object);

  void RemoveBlockPickabilities();


  void SetBlockColor(vtkDataObject* data_object, const double color[3]);
  void GetBlockColor(vtkDataObject* data_object, double color[3]) const;
  vtkColor3d GetBlockColor(vtkDataObject* data_object) const;

  bool HasBlockColors() const;

  bool HasBlockColor(vtkDataObject* data_object) const;

  void RemoveBlockColor(vtkDataObject* data_object);

  void RemoveBlockColors();


  void SetBlockOpacity(vtkDataObject* data_object, double opacity);
  double GetBlockOpacity(vtkDataObject* data_object) const;

  bool HasBlockOpacities() const;

  bool HasBlockOpacity(vtkDataObject* data_object) const;

  void RemoveBlockOpacity(vtkDataObject* data_object);

  void RemoveBlockOpacities();


  void SetBlockMaterial(vtkDataObject* data_object, const std::string& material);
  const std::string& GetBlockMaterial(vtkDataObject* data_object) const;

  bool HasBlockMaterials() const;

  bool HasBlockMaterial(vtkDataObject* data_object) const;

  void RemoveBlockMaterial(vtkDataObject* data_object);

  void RemoveBlockMaterials();

  static void ComputeVisibleBounds(
    vtkCompositeDataDisplayAttributes* cda,
    vtkDataObject *dobj,
    double bounds[6]);

  static vtkDataObject* DataObjectFromIndex(const unsigned int flat_index,
    vtkDataObject* parent_obj, unsigned int& current_flat_index);

  void VisitVisibilities(std::function<bool(vtkDataObject*, bool)> visitor)
  {
    for (auto entry : this->BlockVisibilities)
    {
      if (visitor(entry.first, entry.second))
      {
        break;
      }
    }
  }
protected:
  vtkCompositeDataDisplayAttributes();
  ~vtkCompositeDataDisplayAttributes() override;

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

  static void ComputeVisibleBoundsInternal(
    vtkCompositeDataDisplayAttributes* cda,
    vtkDataObject *dobj,
    vtkBoundingBox* bbox,
    bool parentVisible = true);

  using BoolMap = std::unordered_map<vtkDataObject*, bool>;
  using DoubleMap = std::unordered_map<vtkDataObject*, double>;
  using ColorMap = std::unordered_map<vtkDataObject*, vtkColor3d>;
  using StringMap = std::unordered_map<vtkDataObject*, std::string>;

  BoolMap BlockVisibilities;
  ColorMap BlockColors;
  DoubleMap BlockOpacities;
  StringMap BlockMaterials;
  BoolMap BlockPickabilities;
};

#endif // vtkCompositeDataDisplayAttributes_h