vtkPythonView.h

Go to the documentation of this file.

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

#include "vtkPVView.h"

#include "vtkImageData.h"                 // needed for member variable
#include "vtkRemotingViewsPythonModule.h" //needed for exports
#include "vtkSmartPointer.h"              //needed for member variables

class vtkImageData;
class vtkInformationRequestKey;
class vtkPythonRepresentation;
class vtkRenderer;
class vtkRenderWindow;
class vtkTexture;

class VTKREMOTINGVIEWSPYTHON_EXPORT vtkPythonView : public vtkPVView
{
public:
  static vtkPythonView* New();
  vtkTypeMacro(vtkPythonView, vtkPVView);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkInformationRequestKey* REQUEST_DELIVER_DATA_TO_CLIENT();

  void Update() override;

  virtual vtkRenderer* GetRenderer();

  // Sets the renderer for this view.
  virtual void SetRenderer(vtkRenderer* ren);


  vtkSetStringMacro(Script);
  vtkGetStringMacro(Script);


  vtkSetVector2Macro(Magnification, int);
  vtkGetVector2Macro(Magnification, int);

  int GetNumberOfVisibleDataObjects();

  vtkPythonRepresentation* GetVisibleRepresentation(int visibleObjectIndex);

  vtkDataObject* GetVisibleDataObjectForSetup(int visibleObjectIndex);

  vtkDataObject* GetVisibleDataObjectForRendering(int visibleObjectIndex);

  int GetNumberOfAttributeArrays(int visibleObjectIndex, int attributeType);

  const char* GetAttributeArrayName(int visibleObjectIndex, int attributeType, int arrayIndex);

  void SetAttributeArrayStatus(
    int visibleObjectIndex, int attributeType, const char* name, int status);

  int GetAttributeArrayStatus(int visibleObjectIndex, int attributeType, const char* name);

  void EnableAllAttributeArrays();

  void DisableAllAttributeArrays();

  void StillRender() override;

  void InteractiveRender() override;


  vtkSetObjectMacro(ImageData, vtkImageData);

protected:
  vtkPythonView();
  ~vtkPythonView() override;

  vtkSmartPointer<vtkTexture> RenderTexture;
  vtkSmartPointer<vtkRenderer> Renderer;

  // Needed to handle rendering at different magnifications
  int Magnification[2];

  bool IsLocalDataAvailable();

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

  class vtkInternals;
  vtkInternals* Internals;

  // The Python script
  char* Script;

  // The image data to be displayed in the view
  vtkImageData* ImageData;
};

#endif