Converts elements of a VTK scene graph into vtk-js elements. More...

#include <vtkVtkJSSceneGraphSerializer.h>

Inheritance diagram for vtkVtkJSSceneGraphSerializer:

Collaboration diagram for vtkVtkJSSceneGraphSerializer:

Public Types
typedef vtkObject	Superclass

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.

vtkVtkJSSceneGraphSerializer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.


void	Reset ()
	Empty the contents of the scene and the reset the unique id generator.


const Json::Value &	GetRoot () const
	Access the Json description of the constructed scene.


vtkIdType	GetNumberOfDataObjects () const
	Access the data objects referenced in the constructed scene.

Json::ArrayIndex	GetDataObjectId (vtkIdType) const
	Access the data objects referenced in the constructed scene.

vtkDataObject *	GetDataObject (vtkIdType) const
	Access the data objects referenced in the constructed scene.


vtkIdType	GetNumberOfDataArrays () const
	Access the data arrays referenced in the constructed scene.

std::string	GetDataArrayId (vtkIdType) const
	Access the data arrays referenced in the constructed scene.

vtkDataArray *	GetDataArray (vtkIdType) const
	Access the data arrays referenced in the constructed scene.


virtual void	Add (vtkViewNode , vtkActor )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkCompositePolyDataMapper )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkCompositePolyDataMapper2 )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkGlyph3DMapper )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkMapper )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkRenderer )
	Add a scene graph node and its corresponding renderable to the scene.

virtual void	Add (vtkViewNode , vtkRenderWindow )
	Add a scene graph node and its corresponding renderable to the scene.

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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.

vtkCommand *	GetCommand (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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

virtual 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.

Static Public Member Functions
static vtkVtkJSSceneGraphSerializer *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkVtkJSSceneGraphSerializer *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 (int 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 int	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkVtkJSSceneGraphSerializer ()

	~vtkVtkJSSceneGraphSerializer () override


virtual Json::Value	ToJson (vtkDataArray *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkAlgorithm , vtkDataObject )
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkActor *, bool newPropertyId=false)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, Json::ArrayIndex, vtkGlyph3DMapper *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkCamera *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkAlgorithm , vtkImageData )
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkLight *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkLookupTable *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, Json::ArrayIndex, vtkMapper *, bool newLUTId=false)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkRenderer *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkAlgorithm , vtkPolyData )
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkProperty *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkTexture *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (Json::Value &, vtkTransform *)
	Translate from a VTK renderable to a vtk-js renderable.

virtual Json::Value	ToJson (vtkRenderWindow *)
	Translate from a VTK renderable to a vtk-js renderable.


Json::ArrayIndex	UniqueId (void *ptr=nullptr)
	Associate a unique id with a given 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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
Internal *	Internals

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Converts elements of a VTK scene graph into vtk-js elements.

vtkVtkJSSceneGraphSerializer accepts nodes and their renderables from a scene graph and a) composes the elements' data and topology into a Json data structure and b) correlates unique identifiers for data objects in the Json data structure to the data objects themselves. It is designed to operate with vtkVtkJSViewNodeFactory, which handles the logic for scene graph traversal.

When constructing the Json description for a single scene graph node and its renderable, the Add(node, renderable) step processes the renderable into its corresponding vtk-js form. For many renderables this is a no-op, but current restrictions in vtk-js (such as the lack of support for composite mappers and the requirement for data conversion to vtkPolyData) require a nontrival conversion step for certain renderable types. The subsequent ToJson(renderable) is a straightforward conversion of the renderable's data members into a vtk-js Json format.

See also: vtkVtkJSViewNodeFactory

Definition at line 68 of file vtkVtkJSSceneGraphSerializer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkVtkJSSceneGraphSerializer::Superclass

Definition at line 72 of file vtkVtkJSSceneGraphSerializer.h.

Constructor & Destructor Documentation

◆ vtkVtkJSSceneGraphSerializer()

vtkVtkJSSceneGraphSerializer::vtkVtkJSSceneGraphSerializer ( )

protected

◆ ~vtkVtkJSSceneGraphSerializer()

vtkVtkJSSceneGraphSerializer::~vtkVtkJSSceneGraphSerializer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkVtkJSSceneGraphSerializer * vtkVtkJSSceneGraphSerializer::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkVtkJSSceneGraphSerializer::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVtkJSSceneGraphSerializer::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkVtkJSSceneGraphSerializer * vtkVtkJSSceneGraphSerializer::NewInstance ( ) const

◆ PrintSelf()

void vtkVtkJSSceneGraphSerializer::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 vtkObject.

◆ Reset()

void vtkVtkJSSceneGraphSerializer::Reset ( )

Empty the contents of the scene and the reset the unique id generator.

◆ GetRoot()

const Json::Value & vtkVtkJSSceneGraphSerializer::GetRoot ( ) const

Access the Json description of the constructed scene.

The returned object is valid for the lifetime of this class.

◆ GetNumberOfDataObjects()

vtkIdType vtkVtkJSSceneGraphSerializer::GetNumberOfDataObjects ( ) const

Access the data objects referenced in the constructed scene.

◆ GetDataObjectId()

Json::ArrayIndex vtkVtkJSSceneGraphSerializer::GetDataObjectId ( vtkIdType ) const

Access the data objects referenced in the constructed scene.

◆ GetDataObject()

vtkDataObject * vtkVtkJSSceneGraphSerializer::GetDataObject ( vtkIdType ) const

Access the data objects referenced in the constructed scene.

◆ GetNumberOfDataArrays()

vtkIdType vtkVtkJSSceneGraphSerializer::GetNumberOfDataArrays ( ) const

Access the data arrays referenced in the constructed scene.

◆ GetDataArrayId()

std::string vtkVtkJSSceneGraphSerializer::GetDataArrayId ( vtkIdType ) const

Access the data arrays referenced in the constructed scene.

◆ GetDataArray()

vtkDataArray * vtkVtkJSSceneGraphSerializer::GetDataArray ( vtkIdType ) const

Access the data arrays referenced in the constructed scene.

◆ Add() [1/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkActor *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [2/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkCompositePolyDataMapper *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [3/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkCompositePolyDataMapper2 *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [4/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkGlyph3DMapper *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [5/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkMapper *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [6/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkRenderer *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.

◆ Add() [7/7]

virtual void vtkVtkJSSceneGraphSerializer::Add	(	vtkViewNode *	,
		vtkRenderWindow *
	)

virtual

Add a scene graph node and its corresponding renderable to the scene.