vtkWebApplication.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkWebApplication.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkWebApplication_h
#define vtkWebApplication_h
 
#include "vtkObject.h"
#include "vtkWebCoreModule.h" // needed for exports
#include <string>             // needed for std::string
 
class vtkObjectIdMap;
class vtkRenderWindow;
class vtkUnsignedCharArray;
class vtkWebInteractionEvent;
 
class VTKWEBCORE_EXPORT vtkWebApplication : public vtkObject
{
public:
  static vtkWebApplication* New();
  vtkTypeMacro(vtkWebApplication, 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);
 
 
  void SetNumberOfEncoderThreads(vtkTypeUInt32);
  vtkTypeUInt32 GetNumberOfEncoderThreads();
 
 
  vtkUnsignedCharArray* StillRender(vtkRenderWindow* view, int quality = 100);
  vtkUnsignedCharArray* InteractiveRender(vtkRenderWindow* view, int quality = 50);
  const char* StillRenderToString(vtkRenderWindow* view, vtkMTimeType time = 0, int quality = 100);
  vtkUnsignedCharArray* StillRenderToBuffer(
    vtkRenderWindow* view, vtkMTimeType time = 0, int quality = 100);
 
  bool GetHasImagesBeingProcessed(vtkRenderWindow*);
 
  bool HandleInteractionEvent(vtkRenderWindow* view, vtkWebInteractionEvent* event);
 
  void InvalidateCache(vtkRenderWindow* view);
 
 
  vtkGetMacro(LastStillRenderToMTime, vtkMTimeType);
 
  const char* GetWebGLSceneMetaData(vtkRenderWindow* view);
 
  const char* GetWebGLBinaryData(vtkRenderWindow* view, const char* id, int partIndex);
 
  vtkObjectIdMap* GetObjectIdMap();
 
  static std::string GetObjectId(vtkObject* obj);
 
protected:
  vtkWebApplication();
  ~vtkWebApplication() override;
 
  int ImageEncoding;
  int ImageCompression;
  vtkMTimeType LastStillRenderToMTime;
 
private:
  vtkWebApplication(const vtkWebApplication&) = delete;
  void operator=(const vtkWebApplication&) = delete;
 
  class vtkInternals;
  vtkInternals* Internals;
};
 
#endif