vtkRemoteSession.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkRemoteSession_h
#define vtkRemoteSession_h
 
#include "vtkType.h"                     // for vtkTypeUInt32
#include "vtkWebAssemblySessionModule.h" // for no export macro
 
#include "vtkDeprecation.h" // for VTK_DEPRECATED_IN_9_5_0
 
#include <emscripten/val.h> // for emscripten::val
 
VTK_ABI_NAMESPACE_BEGIN
 
typedef struct vtkSessionImpl* vtkSession;
class VTKWEBASSEMBLYSESSION_EXPORT vtkRemoteSession
{
public:
  vtkRemoteSession();
 
  ~vtkRemoteSession();
 
  bool RegisterState(emscripten::val state);
 
  bool UnRegisterState(vtkTypeUInt32 object);
 
  VTK_DEPRECATED_IN_9_5_0("Use vtkRemoteSession::Get(vtkTypeUInt32 object) instead.")
  emscripten::val GetState(vtkTypeUInt32 object);
 
  void Set(vtkTypeUInt32 object, emscripten::val properties);
 
  emscripten::val Get(vtkTypeUInt32 object);
 
  void SkipProperty(const std::string& className, const std::string& propertyName);
 
  void UnSkipProperty(const std::string& className, const std::string& propertyName);
 
  bool RegisterBlob(const std::string& hash, emscripten::val jsArray);
 
  bool UnRegisterBlob(const std::string& hash);
 
  emscripten::val GetBlob(const std::string& hash);
 
  emscripten::val Invoke(vtkTypeUInt32 object, const std::string& methodName, emscripten::val args);
 
  emscripten::val GetAllDependencies(vtkTypeUInt32 object);
 
  void UpdateObjectFromState(emscripten::val state);
 
  void UpdateStateFromObject(vtkTypeUInt32 object);
 
  bool SetSize(vtkTypeUInt32 object, int width, int height);
 
  bool Render(vtkTypeUInt32 object);
 
  bool ResetCamera(vtkTypeUInt32 object);
 
  bool StartEventLoop(vtkTypeUInt32 object);
 
  bool StopEventLoop(vtkTypeUInt32 object);
 
  bool BindRenderWindow(vtkTypeUInt32 object, const std::string canvasSelector);
 
  unsigned long Observe(
    vtkTypeUInt32 object, const std::string& eventName, emscripten::val jsFunction);
 
  bool UnObserve(vtkTypeUInt32 object, unsigned long tag);
 
  void Export(const std::string& fileName);
 
  void Import(const std::string& stateFileName, const std::string& blobFileName);
 
  void UpdateObjectsFromStates();
 
  void UpdateStatesFromObjects();
 
  void PruneUnusedBlobs();
 
  void PruneUnusedObjects();
 
  void PruneUnusedStates();
 
  void Clear();
 
  std::size_t GetTotalBlobMemoryUsage();
 
  std::size_t GetTotalVTKDataObjectMemoryUsage();
 
  void PrintSceneManagerInformation();
 
  void SetDeserializerLogVerbosity(const std::string& verbosityLevel);
 
  void SetInvokerLogVerbosity(const std::string& verbosityLevel);
 
  void SetObjectManagerLogVerbosity(const std::string& verbosityLevel);
 
  void SetSerializerLogVerbosity(const std::string& verbosityLevel);
 
  vtkSession Session;
};
 
VTK_ABI_NAMESPACE_END
#endif