VTK  9.4.20250208
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkWasmSceneManager Class Reference

vtkWasmSceneManager provides additional functionality that relates to a vtkRenderWindow and user interaction. More...

#include <vtkWasmSceneManager.h>

Inheritance diagram for vtkWasmSceneManager:
[legend]
Collaboration diagram for vtkWasmSceneManager:
[legend]

Public Types

typedef vtkObjectManager Superclass
 
typedef void(* ObserverCallbackF) (vtkTypeUInt32, const char *)
 
- Public Types inherited from vtkObjectManager
typedef vtkObject Superclass
 
using RegistrarType = std::function< int(void *ser, void *deser, const char **error)>
 Loads user provided handlers.
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkWasmSceneManagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool Initialize () override
 Loads the default (de)serialization handlers and constructors for VTK classes.
 
bool SetSize (vtkTypeUInt32 identifier, int width, int height)
 Set the size of the vtkRenderWindow object at identifier to the supplied dimesions.
 
bool Render (vtkTypeUInt32 identifier)
 Render the vtkRenderWindow object at identifier.
 
bool ResetCamera (vtkTypeUInt32 identifier)
 Reset the active camera of the vtkRenderer object at identifier.
 
bool StartEventLoop (vtkTypeUInt32 identifier)
 Start event loop of the vtkRenderWindowInteractor object at identifier.
 
bool StopEventLoop (vtkTypeUInt32 identifier)
 Stop event loop of the vtkRenderWindowInteractor object at identifier.
 
unsigned long AddObserver (vtkTypeUInt32 identifier, std::string eventName, ObserverCallbackF callback)
 Observes eventName event emitted by an object registered at identifier and invokes callback with the identifier and eventName for every such emission.
 
bool RemoveObserver (vtkTypeUInt32 identifier, unsigned long tag)
 Stop observing the object at identifier.
 
- Public Member Functions inherited from vtkObjectManager
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkObjectManagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool InitializeExtensionModuleHandlers (const std::vector< RegistrarType > &registrars)
 
vtkTypeUInt32 RegisterObject (vtkSmartPointer< vtkObjectBase > objectBase)
 Adds object into an internal container and returns a unique identifier.
 
bool UnRegisterObject (vtkTypeUInt32 identifier)
 Removes an object and it's state.
 
bool RegisterState (const std::string &state)
 Adds state into an internal container and returns a unique identifier.
 
bool UnRegisterState (vtkTypeUInt32 identifier)
 Removes a state at id.
 
vtkTypeUInt32 GetId (vtkSmartPointer< vtkObjectBase > objectBase)
 Get the identifier for object.
 
std::string GetState (vtkTypeUInt32 id)
 Get state of the object at id.
 
vtkSmartPointer< vtkObjectBaseGetObjectAtId (vtkTypeUInt32 id)
 Get object at id.
 
std::vector< vtkTypeUInt32 > GetAllDependencies (vtkTypeUInt32 identifier)
 Returns a non-empty vector of identifiers of all objects that depend on an object with the given identifier.
 
std::vector< std::string > GetBlobHashes (const std::vector< vtkTypeUInt32 > &ids)
 Returns a non-empty vector of hash strings that correspond to blobs used by the registered objects at each identifier in ids.
 
vtkSmartPointer< vtkTypeUInt8Array > GetBlob (const std::string &hash) const
 Returns a blob stored at hash.
 
bool RegisterBlob (const std::string &hash, vtkSmartPointer< vtkTypeUInt8Array > blob)
 Specifies a blob for hash.
 
bool UnRegisterBlob (const std::string &hash)
 Removes a blob stored at hash.
 
void PruneUnusedBlobs ()
 Removes all blob(s) whose hash is not found in the state of any object registered directly or indirectly.
 
void UpdateObjectsFromStates ()
 Deserialize registered states into vtk objects.
 
void UpdateStatesFromObjects ()
 Serialize registered objects into vtk states.
 
void UpdateObjectFromState (const std::string &state)
 Deserialize the state into vtk object.
 
void UpdateStateFromObject (vtkTypeUInt32 identifier)
 Serialize object at identifier into the state.
 
void Clear ()
 Reset to initial state.
 
std::size_t GetTotalBlobMemoryUsage ()
 
std::size_t GetTotalVTKDataObjectMemoryUsage ()
 
void Export (const std::string &filename, int indentLevel=-1, char indentChar=' ')
 Writes state of all registered objects to filename.json The blobs are written into filename.blobs.json.
 
void Import (const std::string &stateFileName, const std::string &blobFileName)
 Reads state from state file and blobs from blob file.
 
virtual vtkSerializerGetSerializer ()
 
virtual vtkDeserializerGetDeserializer ()
 
bool InitializeDefaultHandlers ()
 Loads the default (de)serialization handlers and constructors for VTK classes.
 
void SetObjectManagerLogVerbosity (vtkLogger::Verbosity verbosity)
 Set/Get the log verbosity of messages that are emitted when data is uploaded to GPU memory.
 
vtkLogger::Verbosity GetObjectManagerLogVerbosity ()
 Set/Get the log verbosity of messages that are emitted when data is uploaded to GPU memory.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkWasmSceneManagerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWasmSceneManagerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObjectManager
static vtkObjectManagerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkObjectManagerSafeDownCast (vtkObjectBase *o)
 
static vtkTypeUInt32 ROOT ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWasmSceneManager ()
 
 ~vtkWasmSceneManager () override
 
- Protected Member Functions inherited from vtkObjectManager
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkObjectManager ()
 
 ~vtkObjectManager () override
 
void PruneUnusedStates ()
 Removes all objects that are neither referenced by this manager or any other object.
 
void PruneUnusedObjects ()
 Removes all objects that are neither referenced by this manager or any other object.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectManager
static const char * OWNERSHIP_KEY ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObjectManager
vtkSmartPointer< vtkMarshalContextContext
 
vtkNew< vtkDeserializerDeserializer
 
vtkNew< vtkSerializerSerializer
 
vtkLogger::Verbosity ObjectManagerLogVerbosity = vtkLogger::VERBOSITY_INVALID
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

vtkWasmSceneManager provides additional functionality that relates to a vtkRenderWindow and user interaction.

vtkWasmSceneManager is a javascript wrapper of vtkSceneManager for managing VTK objects, specifically designed for webassembly (wasm). It extends functionality of vtkObjectManager for managing objects such as vtkRenderWindow, vtkRenderWindowInteractor and enables event-observers in webassembly visualization applications.

See also
vtkObjectManager

Definition at line 25 of file vtkWasmSceneManager.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkWasmSceneManager.h.

◆ ObserverCallbackF

typedef void(* vtkWasmSceneManager::ObserverCallbackF) (vtkTypeUInt32, const char *)

Definition at line 76 of file vtkWasmSceneManager.h.

Constructor & Destructor Documentation

◆ vtkWasmSceneManager()

vtkWasmSceneManager::vtkWasmSceneManager ( )
protected

◆ ~vtkWasmSceneManager()

vtkWasmSceneManager::~vtkWasmSceneManager ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWasmSceneManager * vtkWasmSceneManager::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkWasmSceneManager::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkWasmSceneManager::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectManager.

◆ SafeDownCast()

static vtkWasmSceneManager * vtkWasmSceneManager::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWasmSceneManager::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObjectManager.

◆ NewInstance()

vtkWasmSceneManager * vtkWasmSceneManager::NewInstance ( ) const

◆ PrintSelf()

void vtkWasmSceneManager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectManager.

◆ Initialize()

bool vtkWasmSceneManager::Initialize ( )
overridevirtual

Loads the default (de)serialization handlers and constructors for VTK classes.

Reimplemented from vtkObjectManager.

◆ SetSize()

bool vtkWasmSceneManager::SetSize ( vtkTypeUInt32  identifier,
int  width,
int  height 
)

Set the size of the vtkRenderWindow object at identifier to the supplied dimesions.

Returns true if the object at identifier is a vtkRenderWindow with a vtkRenderWindowInteractor attached to it, false otherwise.

◆ Render()

bool vtkWasmSceneManager::Render ( vtkTypeUInt32  identifier)

Render the vtkRenderWindow object at identifier.

Returns true if the object at identifier is a vtkRenderWindow false otherwise.

◆ ResetCamera()

bool vtkWasmSceneManager::ResetCamera ( vtkTypeUInt32  identifier)

Reset the active camera of the vtkRenderer object at identifier.

Returns true if the object at identifier is a vtkRenderer false otherwise.

◆ StartEventLoop()

bool vtkWasmSceneManager::StartEventLoop ( vtkTypeUInt32  identifier)

Start event loop of the vtkRenderWindowInteractor object at identifier.

Returns true if the object at identifier is a vtkRenderWindowInteractor false otherwise.

◆ StopEventLoop()

bool vtkWasmSceneManager::StopEventLoop ( vtkTypeUInt32  identifier)

Stop event loop of the vtkRenderWindowInteractor object at identifier.

Returns true if the object at identifier is a vtkRenderWindowInteractor false otherwise.

◆ AddObserver()

unsigned long vtkWasmSceneManager::AddObserver ( vtkTypeUInt32  identifier,
std::string  eventName,
ObserverCallbackF  callback 
)

Observes eventName event emitted by an object registered at identifier and invokes callback with the identifier and eventName for every such emission.

Returns the tag of an observer for eventName. You can use the tag in RemoveObserver to stop observing eventName event from the object at identifier

◆ RemoveObserver()

bool vtkWasmSceneManager::RemoveObserver ( vtkTypeUInt32  identifier,
unsigned long  tag 
)

Stop observing the object at identifier.

Returns true if an object exists at identifier, false otherwise.


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