// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkChartSelectionRepresentation
 * @brief   representation for showing selections
 * in chart views.
 *
 * vtkChartSelectionRepresentation is a representation showing selections in
 * chart views. It works with vtkChartSelectionRepresentation (namely
 * vtkChartSelectionRepresentation::MapSelectionToView) to map the input
 * vtkSelection to selection form that the view can understand and then passes
 * it alone to the vtkPVContextView.
 * For client-server cases, this class also handles delivering of the selection
 * to all "rendering" nodes.
 */

#ifndef vtkChartSelectionRepresentation_h
#define vtkChartSelectionRepresentation_h

#include "vtkPVDataRepresentation.h"
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSmartPointer.h"        // needed for vtkWeakPointer.
#include "vtkWeakPointer.h"         // needed for vtkWeakPointer.

class vtkChartRepresentation;
class vtkPVContextView;
class vtkSelection;

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

  /**
   * This needs to be called on all instances of vtkChartSelectionRepresentation when
   * the input is modified.
   */
  void MarkModified() override { this->Superclass::MarkModified(); }

  /**
   * Set visibility of the representation.
   */
  void SetVisibility(bool visible) override;

  /**
   * Get/Set the chart representation for which this is a selection
   * representation. This is not reference counted.
   */
  void SetChartRepresentation(vtkChartRepresentation* repr);

  int ProcessViewRequest(
    vtkInformationRequestKey* request, vtkInformation* ininfo, vtkInformation* outinfo) override;

protected:
  vtkChartSelectionRepresentation();
  ~vtkChartSelectionRepresentation() override;

  int FillInputPortInformation(int port, vtkInformation* info) override;
  int RequestData(
    vtkInformation*, vtkInformationVector** inputVector, vtkInformationVector*) override;

  /**
   * Adds the representation to the view.  This is called from
   * vtkView::AddRepresentation().  Subclasses should override this method.
   * Returns true if the addition succeeds.
   */
  bool AddToView(vtkView* view) override;

  /**
   * Removes the representation to the view.  This is called from
   * vtkView::RemoveRepresentation().  Subclasses should override this method.
   * Returns true if the removal succeeds.
   */
  bool RemoveFromView(vtkView* view) override;

  vtkWeakPointer<vtkPVContextView> ContextView;
  vtkWeakPointer<vtkChartRepresentation> ChartRepresentation;

  // Flag updated in AddToView to indicate if the configuration requires
  // server-side rendering.
  bool EnableServerSideRendering;

  vtkSmartPointer<vtkSelection> Cache;

private:
  vtkChartSelectionRepresentation(const vtkChartSelectionRepresentation&) = delete;
  void operator=(const vtkChartSelectionRepresentation&) = delete;
};

#endif
