vtkChartRepresentation.h

Go to the documentation of this file.

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

#include "vtkPVDataRepresentation.h"
#include "vtkParaViewDeprecation.h" // for deprecation
#include "vtkSmartPointer.h"        // needed for vtkSmartPointer
#include "vtkWeakPointer.h"         // needed for vtkWeakPointer

#include <map>    // needed for std::map
#include <set>    // needed for std::set
#include <vector> // needed for std::vector

class vtkChartSelectionRepresentation;
class vtkAbstractChartExporter;
class vtkCSVExporter;
class vtkDataObjectTree;
class vtkPVContextView;
class vtkSelectionDeliveryFilter;
class vtkTable;

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

  void SetSelectionRepresentation(vtkChartSelectionRepresentation*);

  void SetVisibility(bool visible) override;

  void MarkModified() override;

  // *************************************************************************


  void SetFieldAssociation(int);
  vtkGetMacro(FieldAssociation, int);


  vtkSetStringMacro(ActiveAssembly);
  vtkGetStringMacro(ActiveAssembly);


  void AddBlockSelector(const char* selector);
  void RemoveAllBlockSelectors();


  PARAVIEW_DEPRECATED_IN_6_1_0("Use AddBlockSelector() with SetActiveAssembly instead. "
                               "CompositeDataSetIndex is no longer used.")
  void SetCompositeDataSetIndex(unsigned int); // only used for single block selection
  PARAVIEW_DEPRECATED_IN_6_1_0("Use AddBlockSelector() with SetActiveAssembly instead. "
                               "CompositeDataSetIndex is no longer used.")
  void AddCompositeDataSetIndex(unsigned int);
  PARAVIEW_DEPRECATED_IN_6_1_0("Use RemoveAllBlockSelectors() with SetActiveAssembly instead. "
                               "CompositeDataSetIndex is no longer used.")
  void ResetCompositeDataSetIndices();

  unsigned int Initialize(unsigned int minIdAvailable, unsigned int maxIdAvailable) override;

  int ProcessViewRequest(vtkInformationRequestKey* request_type, vtkInformation* inInfo,
    vtkInformation* outInfo) override;

  virtual std::string GetDefaultSeriesLabel(
    const std::string& tableName, const std::string& columnName);


  vtkSetMacro(FlattenTable, int);
  vtkGetMacro(FlattenTable, int);

  virtual bool MapSelectionToInput(vtkSelection* sel);

  virtual bool MapSelectionToView(vtkSelection* sel);


  virtual bool Export(vtkAbstractChartExporter* vtkNotUsed(exporter)) { return false; }

  enum ArraySelectionModes
  {
    MERGED_BLOCKS = 0,
    INDIVIDUAL_BLOCKS = 1,
  };


  vtkGetMacro(ArraySelectionMode, int);
  void SetArraySelectionMode(int mode);


  vtkGetMacro(ShowBlockName, bool);
  vtkSetMacro(ShowBlockName, bool);
  vtkBooleanMacro(ShowBlockName, bool);


  void SetPlaceHolderDataType(int datatype);
  vtkGetMacro(PlaceHolderDataType, int);
protected:
  vtkChartRepresentation();
  ~vtkChartRepresentation() override;

  int FillInputPortInformation(int port, vtkInformation* info) override;

  virtual void PrepareForRendering() {}

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  bool AddToView(vtkView* view) override;

  bool RemoveFromView(vtkView* view) override;

  vtkTable* GetLocalOutput(bool pre_delivery = false);

  virtual vtkSmartPointer<vtkDataObject> TransformInputData(vtkDataObject* data);

  virtual vtkSmartPointer<vtkDataObject> ReduceDataToRoot(vtkDataObject* data);

  virtual vtkSmartPointer<vtkDataObject> TransformTable(vtkSmartPointer<vtkDataObject> table);

  using MapOfTables = std::map<std::string, std::pair<vtkSmartPointer<vtkTable>, unsigned int>>;
  bool GetLocalOutput(MapOfTables& tables);

  vtkWeakPointer<vtkPVContextView> ContextView;
  vtkSmartPointer<vtkDataObjectTree> LocalOutput;

  std::vector<std::string> BlockSelectors;
  std::set<unsigned int> CompositeIndices; // the selected blocks

private:
  int FieldAssociation;
  int FlattenTable;
  int ArraySelectionMode = MERGED_BLOCKS;

  // This is used to be able to create the correct placeHolder in RequestData for the client
  int PlaceHolderDataType = VTK_PARTITIONED_DATA_SET_COLLECTION;

  char* ActiveAssembly = nullptr;

  vtkWeakPointer<vtkChartSelectionRepresentation> SelectionRepresentation;

  bool ShowBlockName = true;

  vtkChartRepresentation(const vtkChartRepresentation&) = delete;
  void operator=(const vtkChartRepresentation&) = delete;

  vtkTimeStamp PrepareForRenderingTime;
  vtkMTimeType LastLocalOutputMTime;
  vtkSmartPointer<vtkChartSelectionRepresentation> DummyRepresentation;
  vtkSmartPointer<vtkDataObjectTree> LocalOutputRequestData;
};

#endif