vtkSMParaViewPipelineControllerWithRendering.h

Go to the documentation of this file.

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

#include "vtkParaViewDeprecation.h"
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSMParaViewPipelineController.h"

class vtkSMSourceProxy;
class vtkSMViewLayoutProxy;
class vtkSMViewProxy;

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

  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);

  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view,
    const char* representationType);

  void ShowAll(vtkSMViewProxy* view);

  virtual vtkSMProxy* Hide(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);

  virtual void Hide(vtkSMProxy* repr, vtkSMViewProxy* view);

  virtual void HideAll(vtkSMViewProxy* view);

  vtkSMProxy* SetVisibility(
    vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view, bool visible)
  {
    return (
      visible ? this->Show(producer, outputPort, view) : this->Hide(producer, outputPort, view));
  }

  virtual bool GetVisibility(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);

  virtual vtkSMViewProxy* ShowInPreferredView(
    vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);

  virtual const char* GetPreferredViewType(vtkSMSourceProxy* producer, int outputPort);

  virtual const char* GetPipelineIcon(vtkSMSourceProxy* producer, int outputPort);

  using Superclass::RegisterRepresentationProxy;
  bool RegisterRepresentationProxy(vtkSMProxy* proxy) override;

  PARAVIEW_DEPRECATED_IN_6_0_0(
    "Use vtkPVGeneralSettings::SetScalarBarMode(AUTOMATICALLY_HIDE_SCALAR_BARS) instead")
  static void SetHideScalarBarOnHide(bool);


  PARAVIEW_DEPRECATED_IN_6_0_0(
    "Use vtkPVGeneralSettings::SetInheritRepresentationProperties() instead")
  static void SetInheritRepresentationProperties(bool);
  PARAVIEW_DEPRECATED_IN_6_0_0(
    "Use vtkPVGeneralSettings::GetInheritRepresentationProperties() instead")
  static bool GetInheritRepresentationProperties();

  bool PostInitializeProxy(vtkSMProxy* proxy) override;

  virtual bool RegisterLayoutProxy(vtkSMProxy* proxy, const char* proxyname = nullptr);

  virtual void AssignViewToLayout(
    vtkSMViewProxy* view, vtkSMViewLayoutProxy* layout = nullptr, int hint = 0);

protected:
  vtkSMParaViewPipelineControllerWithRendering();
  ~vtkSMParaViewPipelineControllerWithRendering() override;

  virtual void UpdatePipelineBeforeDisplay(
    vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);

  virtual bool AlsoShowInCurrentView(
    vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* currentView);

private:
  vtkSMParaViewPipelineControllerWithRendering(
    const vtkSMParaViewPipelineControllerWithRendering&) = delete;
  void operator=(const vtkSMParaViewPipelineControllerWithRendering&) = delete;
  bool SkipUpdatePipelineBeforeDisplay;
};

#endif