vtkSMParaViewPipelineController.h

Go to the documentation of this file.

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

#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0
#include "vtkSMObject.h"

#include <string> // for std::string

class vtkSMProxy;
class vtkSMSession;
class vtkSMSessionProxyManager;

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

  virtual bool InitializeSession(vtkSMSession* session);

  virtual vtkSMProxy* FindTimeKeeper(vtkSMSession* session);

  virtual vtkSMProxy* FindMaterialLibrary(vtkSMSession* session);

  //---------------------------------------------------------------------------
  virtual bool PreInitializeProxy(vtkSMProxy* proxy);

  virtual bool PostInitializeProxy(vtkSMProxy* proxy);

  bool InitializeProxy(vtkSMProxy* proxy)
  {
    return this->PreInitializeProxy(proxy) && this->PostInitializeProxy(proxy);
  }

  virtual bool FinalizeProxy(vtkSMProxy* proxy);

  //---------------------------------------------------------------------------
  // ******* Methods for Pipeline objects like sources/filters/readers ********

  virtual bool RegisterPipelineProxy(vtkSMProxy* proxy, const char* proxyname);
  virtual bool RegisterPipelineProxy(vtkSMProxy* proxy)
  {
    return this->RegisterPipelineProxy(proxy, nullptr);
  }

  virtual bool UnRegisterPipelineProxy(vtkSMProxy* proxy);

  //---------------------------------------------------------------------------
  // *******  Methods for Views/Displays *********

  virtual bool RegisterViewProxy(vtkSMProxy* proxy)
  {
    return this->RegisterViewProxy(proxy, nullptr);
  }
  virtual bool RegisterViewProxy(vtkSMProxy* proxy, const char* proxyname);

  virtual bool UnRegisterViewProxy(vtkSMProxy* proxy, bool unregister_representations = true);


  virtual bool RegisterRepresentationProxy(vtkSMProxy* proxy)
  {
    return this->RegisterRepresentationProxy(proxy, nullptr);
  }
  virtual bool RegisterRepresentationProxy(vtkSMProxy* proxy, const char* proxyname);

  virtual bool UnRegisterRepresentationProxy(vtkSMProxy* proxy);

  //---------------------------------------------------------------------------
  // *******  Methods for Transfer functions *********

  virtual bool RegisterColorTransferFunctionProxy(vtkSMProxy* proxy, const char* proxyname);
  virtual bool RegisterColorTransferFunctionProxy(vtkSMProxy* proxy)
  {
    return this->RegisterColorTransferFunctionProxy(proxy, nullptr);
  }

  virtual bool RegisterOpacityTransferFunction(vtkSMProxy* proxy, const char* proxyname);
  virtual bool RegisterOpacityTransferFunction(vtkSMProxy* proxy)
  {
    return this->RegisterOpacityTransferFunction(proxy, nullptr);
  }

  virtual bool RegisterTransferFunction2D(vtkSMProxy* proxy, const char* proxyname);
  virtual bool RegisterTransferFunction2D(vtkSMProxy* proxy)
  {
    return this->RegisterTransferFunction2D(proxy, nullptr);
  }

  virtual bool RegisterLightProxy(vtkSMProxy* proxy, vtkSMProxy* view, const char* proxyname);
  virtual bool RegisterLightProxy(vtkSMProxy* proxy, vtkSMProxy* view)
  {
    return this->RegisterLightProxy(proxy, view, nullptr);
  }

  virtual bool RegisterTextureProxy(vtkSMProxy* proxy, const char* filename);
  virtual bool RegisterTextureProxy(
    vtkSMProxy* proxy, const char* trivialProducerKeyName, const char* proxyname);

  //---------------------------------------------------------------------------
  // *******  Methods for Extractors  *********

  virtual bool RegisterExtractorProxy(vtkSMProxy* proxy, const char* proxyname);
  virtual bool RegisterExtractorProxy(vtkSMProxy* proxy)
  {
    return this->RegisterExtractorProxy(proxy, nullptr);
  }

  //---------------------------------------------------------------------------
  // *******  Methods for Animation   *********

  virtual vtkSMProxy* FindAnimationScene(vtkSMSession* session);

  virtual vtkSMProxy* GetAnimationScene(vtkSMSession* session);

  virtual vtkSMProxy* FindTimeAnimationTrack(vtkSMProxy* scene);

  virtual vtkSMProxy* GetTimeAnimationTrack(vtkSMProxy* scene);

  virtual bool RegisterAnimationProxy(vtkSMProxy* proxy);

  virtual bool UnRegisterAnimationProxy(vtkSMProxy* proxy);

  //---------------------------------------------------------------------------
  // *******  Methods for Settings   *********
  //
  virtual void UpdateSettingsProxies(vtkSMSession* session);

  //---------------------------------------------------------------------------
  // ****** Methods for cleanup/finalization/deleting ******
  //
  virtual bool UnRegisterProxy(vtkSMProxy* proxy);

  static std::string GetHelperProxyGroupName(vtkSMProxy*);

protected:
  vtkSMParaViewPipelineController();
  ~vtkSMParaViewPipelineController() override;

  vtkSMProxy* FindProxy(
    vtkSMSessionProxyManager* pxm, const char* reggroup, const char* xmlgroup, const char* xmltype);


  virtual bool CreateProxiesForProxyListDomains(vtkSMProxy* proxy);
  virtual void RegisterProxiesForProxyListDomains(vtkSMProxy* proxy);

  virtual bool SetupGlobalPropertiesLinks(vtkSMProxy* proxy);

  virtual bool CreateAnimationHelpers(vtkSMProxy* proxy);

  virtual bool UnRegisterDependencies(vtkSMProxy* proxy);

  vtkMTimeType GetInitializationTime(vtkSMProxy*);


  void ProcessInitializationHelper(vtkSMProxy*, vtkMTimeType initializationTimeStamp);

  void ProcessInitializationHelperRegistration(vtkSMProxy*);

  PARAVIEW_DEPRECATED_IN_5_12_0(
    "Material setup is now handled by the RenderView proxy on raytracing back-end update")
  virtual void DoMaterialSetup(vtkSMProxy* proxy);

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif