vtkPVWebApplication.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkPVClientWebModule.h" // needed for exports

class vtkUnsignedCharArray;
class vtkSMViewProxy;
class vtkWebInteractionEvent;

class VTKPVCLIENTWEB_EXPORT vtkPVWebApplication : public vtkObject
{
public:
  static vtkPVWebApplication* New();
  vtkTypeMacro(vtkPVWebApplication, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  enum
  {
    ENCODING_NONE = 0,
    ENCODING_BASE64 = 1
  };
  vtkSetClampMacro(ImageEncoding, int, ENCODING_NONE, ENCODING_BASE64);
  vtkGetMacro(ImageEncoding, int);


  enum
  {
    COMPRESSION_NONE = 0,
    COMPRESSION_PNG = 1,
    COMPRESSION_JPEG = 2
  };
  vtkSetClampMacro(ImageCompression, int, COMPRESSION_NONE, COMPRESSION_JPEG);
  vtkGetMacro(ImageCompression, int);


  vtkUnsignedCharArray* StillRender(vtkSMViewProxy* view, int quality = 100);
  vtkUnsignedCharArray* InteractiveRender(vtkSMViewProxy* view, int quality = 50);
  const char* StillRenderToString(vtkSMViewProxy* view, unsigned long time = 0, int quality = 100);
  vtkUnsignedCharArray* StillRenderToBuffer(
    vtkSMViewProxy* view, unsigned long time = 0, int quality = 100);

  bool GetHasImagesBeingProcessed(vtkSMViewProxy*);

  bool HandleInteractionEvent(vtkSMViewProxy* view, vtkWebInteractionEvent* event);

  void InvalidateCache(vtkSMViewProxy* view);


  vtkGetMacro(LastStillRenderToMTime, vtkMTimeType);

  const char* GetWebGLSceneMetaData(vtkSMViewProxy* view);

  const char* GetWebGLBinaryData(vtkSMViewProxy* view, const char* id, int partIndex);


  vtkGetVector2Macro(LastStillRenderImageSize, int);

protected:
  vtkPVWebApplication();
  ~vtkPVWebApplication() override;

  int ImageEncoding;
  int ImageCompression;
  vtkMTimeType LastStillRenderToMTime;
  int LastStillRenderImageSize[3];

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif