vtkJSONRenderWindowExporter Class Reference

Exports a render window for vtk-js. More...

#include <vtkJSONRenderWindowExporter.h>

Inheritance diagram for vtkJSONRenderWindowExporter:

Collaboration diagram for vtkJSONRenderWindowExporter:

Public Types
typedef vtkExporter	Superclass
Public Types inherited from vtkExporter
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.
vtkJSONRenderWindowExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetSerializer (vtkVtkJSSceneGraphSerializer *)
	Specify the Serializer object.
virtual vtkVtkJSSceneGraphSerializer *	GetSerializer ()
	Specify the Serializer object.
virtual void	SetArchiver (vtkArchiver *)
	Specify the Archiver object.
virtual vtkArchiver *	GetArchiver ()
	Specify the Archiver object.
void	WriteData () override
	Write scene data.
virtual void	SetCompactOutput (bool)
	Write scene in compact form (default is true).
virtual bool	GetCompactOutput ()
	Write scene in compact form (default is true).
virtual void	CompactOutputOn ()
	Write scene in compact form (default is true).
virtual void	CompactOutputOff ()
	Write scene in compact form (default is true).
Public Member Functions inherited from vtkExporter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExporter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Write ()
	Write data to output.
void	Update ()
	Convenient alias for Write() method.
void	SetStartWrite (void(*f)(void *), void *arg)
	Specify a function to be called before data is written.
void	SetEndWrite (void(*f)(void *), void *arg)
	Specify a function to be called after data is written.
void	SetStartWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
void	SetEndWriteArgDelete (void(*f)(void *))
	Set the arg delete method.
vtkMTimeType	GetMTime () override
	Returns the MTime also considering the RenderWindow.
virtual void	SetRenderWindow (vtkRenderWindow *)
	Set/Get the rendering window that contains the scene to be written.
virtual vtkRenderWindow *	GetRenderWindow ()
	Set/Get the rendering window that contains the scene to be written.
virtual void	SetActiveRenderer (vtkRenderer *)
	Set/Get the renderer that contains actors to be written.
virtual vtkRenderer *	GetActiveRenderer ()
	Set/Get the renderer that contains actors to be written.
void	SetInput (vtkRenderWindow *renWin)
	These methods are provided for backward compatibility.
vtkRenderWindow *	GetInput ()
	These methods are provided for backward compatibility.
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 vtkJSONRenderWindowExporter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkJSONRenderWindowExporter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkExporter
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExporter *	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
	vtkJSONRenderWindowExporter ()
	~vtkJSONRenderWindowExporter () override
Protected Member Functions inherited from vtkExporter
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkExporter ()
	~vtkExporter () override
virtual void	WriteData ()=0
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 &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkExporter
vtkRenderWindow *	RenderWindow
vtkRenderer *	ActiveRenderer
void(*	StartWrite )(void *)
void(*	StartWriteArgDelete )(void *)
void *	StartWriteArg
void(*	EndWrite )(void *)
void(*	EndWriteArgDelete )(void *)
void *	EndWriteArg
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Exports a render window for vtk-js.

vtkJSONRenderWindowExporter constructs a scene graph from an input render window and generates an archive for vtk-js. The traversal of the scene graph topology is handled by graph elements constructed by vtkVtkJSViewNodeFactory, the translation from VTK to vtk-js scene elements (renderers, actors, mappers, etc.) is handled by vtkVtkJSSceneGraphSerializer, and the transcription of data is handled by vtkArchiver. The latter two classes are designed to be extensible via inheritance, and derived instances can be used to modify the vtk-js file format and output mode.

See also

vtkVtkJSSceneGraphSerializer vtkVtkJSViewNodeFactory

Definition at line 46 of file vtkJSONRenderWindowExporter.h.

Member Typedef Documentation

Superclass

typedef vtkExporter vtkJSONRenderWindowExporter::Superclass

Definition at line 50 of file vtkJSONRenderWindowExporter.h.

Constructor & Destructor Documentation

vtkJSONRenderWindowExporter()

vtkJSONRenderWindowExporter::vtkJSONRenderWindowExporter ( )

protected

~vtkJSONRenderWindowExporter()

vtkJSONRenderWindowExporter::~vtkJSONRenderWindowExporter ( )

overrideprotected

Member Function Documentation

New()

static vtkJSONRenderWindowExporter * vtkJSONRenderWindowExporter::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkJSONRenderWindowExporter::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 vtkExporter.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkJSONRenderWindowExporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkExporter.

NewInstance()

vtkJSONRenderWindowExporter * vtkJSONRenderWindowExporter::NewInstance

(

)

const

PrintSelf()

void vtkJSONRenderWindowExporter::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 vtkExporter.

SetSerializer()

virtual void vtkJSONRenderWindowExporter::SetSerializer ( vtkVtkJSSceneGraphSerializer *  )

virtual

Specify the Serializer object.

GetSerializer()

virtual vtkVtkJSSceneGraphSerializer * vtkJSONRenderWindowExporter::GetSerializer ( )

virtual

Specify the Serializer object.

SetArchiver()

virtual void vtkJSONRenderWindowExporter::SetArchiver ( vtkArchiver *  )

virtual

Specify the Archiver object.

GetArchiver()

virtual vtkArchiver * vtkJSONRenderWindowExporter::GetArchiver ( )

virtual

Specify the Archiver object.

WriteData()

void vtkJSONRenderWindowExporter::WriteData ( )

overridevirtual

Write scene data.

Implements vtkExporter.

SetCompactOutput()

virtual void vtkJSONRenderWindowExporter::SetCompactOutput ( bool  )

virtual

Write scene in compact form (default is true).

GetCompactOutput()

virtual bool vtkJSONRenderWindowExporter::GetCompactOutput ( )

virtual

Write scene in compact form (default is true).

CompactOutputOn()

virtual void vtkJSONRenderWindowExporter::CompactOutputOn ( )

virtual

Write scene in compact form (default is true).

CompactOutputOff()

virtual void vtkJSONRenderWindowExporter::CompactOutputOff ( )

virtual

Write scene in compact form (default is true).

---

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

• IO/Export/vtkJSONRenderWindowExporter.h