VTK  9.6.20260205
vtkStandaloneSession Class Reference

A standalone session for managing VTK objects in a WebAssembly environment. More...

#include <vtkStandaloneSession.h>

Public Member Functions

 vtkStandaloneSession ()
 
 ~vtkStandaloneSession ()
 
vtkTypeUInt32 Create (const std::string &className)
 Create an object of type className.
 
bool Destroy (vtkTypeUInt32 object)
 Destroy a VTKObject.
 
bool Set (vtkTypeUInt32 object, emscripten::val properties)
 Set properties of a VTKObject.
 
emscripten::val Get (vtkTypeUInt32 object)
 Get all properties of a VTKObject.
 
emscripten::val Invoke (vtkTypeUInt32 object, const std::string &methodName, emscripten::val args)
 Invoke a function methodName on object with args and return the result in a VTKJson.
 
unsigned long Observe (vtkTypeUInt32 object, const std::string &eventName, emscripten::val jsFunction)
 Add an observer to a VTKObject for a specific event.
 
bool UnObserve (vtkTypeUInt32 object, unsigned long tag)
 Remove an observer from a VTKObject.
 
std::size_t GetTotalBlobMemoryUsage ()
 Retrieves the total memory usage of all blobs.
 
std::size_t GetTotalVTKDataObjectMemoryUsage ()
 Retrieves the total memory usage of all VTK data objects.
 
std::string PrintObjectToString (vtkTypeUInt32 object)
 Prints information about a VTK object to a string.
 
void PrintSceneManagerInformation ()
 Prints information about the scene manager.
 
void SetDeserializerLogVerbosity (const std::string &verbosityLevel)
 Sets the verbosity level for the deserializer log.
 
void SetInvokerLogVerbosity (const std::string &verbosityLevel)
 Sets the verbosity level for the invoker log.
 
void SetObjectManagerLogVerbosity (const std::string &verbosityLevel)
 Sets the verbosity level for the object manager log.
 
void SetSerializerLogVerbosity (const std::string &verbosityLevel)
 Sets the verbosity level for the serializer log.
 

Public Attributes

vtkSession Session
 

Detailed Description

A standalone session for managing VTK objects in a WebAssembly environment.

This class provides an interface for creating, destroying, and interacting with VTK objects in a WebAssembly context. It allows setting and retrieving properties, invoking methods, and managing event observers for VTK objects.

This class is designed to work with Emscripten through JavaScript bindings.

Note
This class is part of the WebAssembly module internals and is not exported for general use.
See also
vtkRemoteSession

Definition at line 29 of file vtkStandaloneSession.h.

Constructor & Destructor Documentation

◆ vtkStandaloneSession()

vtkStandaloneSession::vtkStandaloneSession ( )

◆ ~vtkStandaloneSession()

vtkStandaloneSession::~vtkStandaloneSession ( )

Member Function Documentation

◆ Create()

vtkTypeUInt32 vtkStandaloneSession::Create ( const std::string & className)

Create an object of type className.

◆ Destroy()

bool vtkStandaloneSession::Destroy ( vtkTypeUInt32 object)

Destroy a VTKObject.

◆ Set()

bool vtkStandaloneSession::Set ( vtkTypeUInt32 object,
emscripten::val properties )

Set properties of a VTKObject.

◆ Get()

emscripten::val vtkStandaloneSession::Get ( vtkTypeUInt32 object)

Get all properties of a VTKObject.

◆ Invoke()

emscripten::val vtkStandaloneSession::Invoke ( vtkTypeUInt32 object,
const std::string & methodName,
emscripten::val args )

Invoke a function methodName on object with args and return the result in a VTKJson.

◆ Observe()

unsigned long vtkStandaloneSession::Observe ( vtkTypeUInt32 object,
const std::string & eventName,
emscripten::val jsFunction )

Add an observer to a VTKObject for a specific event.

◆ UnObserve()

bool vtkStandaloneSession::UnObserve ( vtkTypeUInt32 object,
unsigned long tag )

Remove an observer from a VTKObject.

◆ GetTotalBlobMemoryUsage()

std::size_t vtkStandaloneSession::GetTotalBlobMemoryUsage ( )

Retrieves the total memory usage of all blobs.

Returns
The total memory usage in bytes.

◆ GetTotalVTKDataObjectMemoryUsage()

std::size_t vtkStandaloneSession::GetTotalVTKDataObjectMemoryUsage ( )

Retrieves the total memory usage of all VTK data objects.

Returns
The total memory usage in bytes.

◆ PrintObjectToString()

std::string vtkStandaloneSession::PrintObjectToString ( vtkTypeUInt32 object)

Prints information about a VTK object to a string.

Parameters
objectThe identifier of the VTK object.
Returns
A string containing the result of vtkObject::Print() for the specified object.

◆ PrintSceneManagerInformation()

void vtkStandaloneSession::PrintSceneManagerInformation ( )

Prints information about the scene manager.

◆ SetDeserializerLogVerbosity()

void vtkStandaloneSession::SetDeserializerLogVerbosity ( const std::string & verbosityLevel)

Sets the verbosity level for the deserializer log.

Parameters
verbosityLevelThe desired verbosity level.

◆ SetInvokerLogVerbosity()

void vtkStandaloneSession::SetInvokerLogVerbosity ( const std::string & verbosityLevel)

Sets the verbosity level for the invoker log.

Parameters
verbosityLevelThe desired verbosity level.

◆ SetObjectManagerLogVerbosity()

void vtkStandaloneSession::SetObjectManagerLogVerbosity ( const std::string & verbosityLevel)

Sets the verbosity level for the object manager log.

Parameters
verbosityLevelThe desired verbosity level.

◆ SetSerializerLogVerbosity()

void vtkStandaloneSession::SetSerializerLogVerbosity ( const std::string & verbosityLevel)

Sets the verbosity level for the serializer log.

Parameters
verbosityLevelThe desired verbosity level.

Member Data Documentation

◆ Session

vtkSession vtkStandaloneSession::Session

Definition at line 120 of file vtkStandaloneSession.h.


The documentation for this class was generated from the following file: