vtkCompositeDataDisplayAttributes.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkCompositeDataDisplayAttributes_h
#define vtkCompositeDataDisplayAttributes_h
 
#include "vtkObject.h"
 
#include "vtkColor.h"               // for vtkColor3d
#include "vtkRenderingCoreModule.h" // for export macro
#include "vtkSmartPointer.h"        // for arg
#include "vtkVector.h"              // for vtkVector2d
#include "vtkWrappingHints.h"       // For VTK_MARSHALMANUAL
 
#include <functional>    // for std::function
#include <unordered_map> // for std::unordered_map
 
VTK_ABI_NAMESPACE_BEGIN
class vtkBoundingBox;
class vtkDataObject;
class vtkDeserializer;
class vtkScalarsToColors;
class vtkSerializer;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALMANUAL 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();

  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 SetBlockScalarVisibility(vtkDataObject* data_object, bool value);
  bool GetBlockScalarVisibility(vtkDataObject* data_object) const;
  bool HasBlockScalarVisibility(vtkDataObject* data_object) const;
  bool HasBlockScalarVisibilities() const;
  void RemoveBlockScalarVisibility(vtkDataObject* data_object);
  void RemoveBlockScalarVisibilities();


  void SetBlockUseLookupTableScalarRange(vtkDataObject* data_object, bool value);
  bool GetBlockUseLookupTableScalarRange(vtkDataObject* data_object) const;
  bool HasBlockUseLookupTableScalarRange(vtkDataObject* data_object) const;
  bool HasBlockUseLookupTableScalarRanges() const;
  void RemoveBlockUseLookupTableScalarRange(vtkDataObject* data_object);
  void RemoveBlockUseLookupTableScalarRanges();


  void SetBlockInterpolateScalarsBeforeMapping(vtkDataObject* data_object, bool value);
  bool GetBlockInterpolateScalarsBeforeMapping(vtkDataObject* data_object) const;
  bool HasBlockInterpolateScalarsBeforeMapping(vtkDataObject* data_object) const;
  bool HasBlockInterpolateScalarsBeforeMappings() const;
  void RemoveBlockInterpolateScalarsBeforeMapping(vtkDataObject* data_object);
  void RemoveBlockInterpolateScalarsBeforeMappings();


  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();


  void SetBlockColorMode(vtkDataObject* data_object, int value);
  int GetBlockColorMode(vtkDataObject* data_object) const;
  bool HasBlockColorMode(vtkDataObject* data_object) const;
  bool HasBlockColorModes() const;
  void RemoveBlockColorMode(vtkDataObject* data_object);
  void RemoveBlockColorModes();


  void SetBlockScalarMode(vtkDataObject* data_object, int value);
  int GetBlockScalarMode(vtkDataObject* data_object) const;
  bool HasBlockScalarMode(vtkDataObject* data_object) const;
  bool HasBlockScalarModes() const;
  void RemoveBlockScalarMode(vtkDataObject* data_object);
  void RemoveBlockScalarModes();


  void SetBlockArrayAccessMode(vtkDataObject* data_object, int value);
  int GetBlockArrayAccessMode(vtkDataObject* data_object) const;
  bool HasBlockArrayAccessMode(vtkDataObject* data_object) const;
  bool HasBlockArrayAccessModes() const;
  void RemoveBlockArrayAccessMode(vtkDataObject* data_object);
  void RemoveBlockArrayAccessModes();


  void SetBlockArrayComponent(vtkDataObject* data_object, int value);
  int GetBlockArrayComponent(vtkDataObject* data_object) const;
  bool HasBlockArrayComponent(vtkDataObject* data_object) const;
  bool HasBlockArrayComponents() const;
  void RemoveBlockArrayComponent(vtkDataObject* data_object);
  void RemoveBlockArrayComponents();


  void SetBlockArrayId(vtkDataObject* data_object, int value);
  int GetBlockArrayId(vtkDataObject* data_object) const;
  bool HasBlockArrayId(vtkDataObject* data_object) const;
  bool HasBlockArrayIds() const;
  void RemoveBlockArrayId(vtkDataObject* data_object);
  void RemoveBlockArrayIds();


  void SetBlockScalarRange(vtkDataObject* data_object, const vtkVector2d& value);
  vtkVector2d GetBlockScalarRange(vtkDataObject* data_object) const;
  bool HasBlockScalarRange(vtkDataObject* data_object) const;
  bool HasBlockScalarRanges() const;
  void RemoveBlockScalarRange(vtkDataObject* data_object);
  void RemoveBlockScalarRanges();


  void SetBlockArrayName(vtkDataObject* data_object, const std::string& value);
  std::string GetBlockArrayName(vtkDataObject* data_object) const;
  bool HasBlockArrayName(vtkDataObject* data_object) const;
  bool HasBlockArrayNames() const;
  void RemoveBlockArrayName(vtkDataObject* data_object);
  void RemoveBlockArrayNames();


  void SetBlockFieldDataTupleId(vtkDataObject* data_object, vtkIdType value);
  vtkIdType GetBlockFieldDataTupleId(vtkDataObject* data_object) const;
  bool HasBlockFieldDataTupleId(vtkDataObject* data_object) const;
  bool HasBlockFieldDataTupleIds() const;
  void RemoveBlockFieldDataTupleId(vtkDataObject* data_object);
  void RemoveBlockFieldDataTupleIds();


  void SetBlockLookupTable(vtkDataObject* data_object, vtkSmartPointer<vtkScalarsToColors> lut);
  vtkSmartPointer<vtkScalarsToColors> GetBlockLookupTable(vtkDataObject* data_object) const;
  bool HasBlockLookupTable(vtkDataObject* data_object) const;
  bool HasBlockLookupTables() const;
  void RemoveBlockLookupTable(vtkDataObject* data_object);
  void RemoveBlockLookupTables();

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

  static vtkDataObject* DataObjectFromIndex(
    unsigned int flat_index, vtkDataObject* parent_obj, unsigned int current_flat_index = 0);
 
  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 IntMap = std::unordered_map<vtkDataObject*, int>;
  using VtkIdTypeMap = std::unordered_map<vtkDataObject*, vtkIdType>;
  using ColorMap = std::unordered_map<vtkDataObject*, vtkColor3d>;
  using RangeMap = std::unordered_map<vtkDataObject*, vtkVector2d>;
  using StringMap = std::unordered_map<vtkDataObject*, std::string>;
  using LookupTableMap = std::unordered_map<vtkDataObject*, vtkSmartPointer<vtkScalarsToColors>>;
 
  BoolMap BlockVisibilities;
  ColorMap BlockColors;
  DoubleMap BlockOpacities;
  StringMap BlockMaterials;
  BoolMap BlockPickabilities;
  BoolMap BlockScalarVisibilities;
  BoolMap BlockUseLookupTableScalarRanges;
  BoolMap BlockInterpolateScalarsBeforeMappings;
  IntMap BlockColorModes;
  IntMap BlockScalarModes;
  IntMap BlockArrayAccessModes;
  IntMap BlockArrayComponents;
  IntMap BlockArrayIds;
  RangeMap BlockScalarRanges;
  StringMap BlockArrayNames;
  LookupTableMap BlockLookupTables;
  VtkIdTypeMap BlockFieldDataTupleIds;
 
  friend class vtkCompositeDataDisplayAttributesSerDesHelper;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkCompositeDataDisplayAttributes_h