defines ParaViewWeb application interface. More...

#include <vtkWebApplication.h>

Inheritance diagram for vtkWebApplication:

Collaboration diagram for vtkWebApplication:

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

vtkWebApplication *	NewInstance () const

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

bool	GetHasImagesBeingProcessed (vtkRenderWindow *)
	StillRenderToString() need not necessary returns the most recently rendered image. More...

bool	HandleInteractionEvent (vtkRenderWindow view, vtkWebInteractionEvent event)
	Communicate mouse interaction to a view. More...

void	InvalidateCache (vtkRenderWindow *view)
	Invalidate view cache. More...

const char *	GetWebGLSceneMetaData (vtkRenderWindow *view)
	Return the Meta data description of the input scene in JSON format. More...

const char *	GetWebGLBinaryData (vtkRenderWindow view, const char id, int partIndex)
	Return the binary data given the part index and the webGL object piece id in the scene. More...

vtkObjectIdMap *	GetObjectIdMap ()


void	SetNumberOfEncoderThreads (vtkTypeUInt32)
	Set the number of worker threads to use for image encoding. More...

vtkTypeUInt32	GetNumberOfEncoderThreads ()
	Set the number of worker threads to use for image encoding. More...


vtkUnsignedCharArray *	StillRender (vtkRenderWindow *view, int quality=100)
	Render a view and obtain the rendered image. More...

vtkUnsignedCharArray *	InteractiveRender (vtkRenderWindow *view, int quality=50)
	Render a view and obtain the rendered image. More...

const char *	StillRenderToString (vtkRenderWindow *view, vtkMTimeType time=0, int quality=100)
	Render a view and obtain the rendered image. More...

vtkUnsignedCharArray *	StillRenderToBuffer (vtkRenderWindow *view, vtkMTimeType time=0, int quality=100)
	Render a view and obtain the rendered image. More...


virtual vtkMTimeType	GetLastStillRenderToMTime ()
	Return the MTime of the last array exported by StillRenderToString. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

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

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkWebApplication *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkWebApplication *	SafeDownCast (vtkObjectBase *o)

static std::string	GetObjectId (vtkObject *obj)
	Return a hexadecimal formatted string of the VTK object's memory address, useful for uniquely identifying the object when exporting data. More...

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWebApplication ()

	~vtkWebApplication () override

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

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ImageEncoding

int	ImageCompression

vtkMTimeType	LastStillRenderToMTime

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

enum	{ ENCODING_NONE = 0 , ENCODING_BASE64 = 1 }
	Set the encoding to be used for rendered images. More...

virtual void	SetImageEncoding (int)
	Set the encoding to be used for rendered images. More...

virtual int	GetImageEncoding ()
	Set the encoding to be used for rendered images. More...

enum	{ COMPRESSION_NONE = 0 , COMPRESSION_PNG = 1 , COMPRESSION_JPEG = 2 }
	Set the compression to be used for rendered images. More...

virtual void	SetImageCompression (int)
	Set the compression to be used for rendered images. More...

virtual int	GetImageCompression ()
	Set the compression to be used for rendered images. More...

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

defines ParaViewWeb application interface.

vtkWebApplication defines the core interface for a ParaViewWeb application. This exposes methods that make it easier to manage views and rendered images from views.

Tests:: vtkWebApplication (Tests)

Definition at line 28 of file vtkWebApplication.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWebApplication::Superclass

Definition at line 32 of file vtkWebApplication.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Set the encoding to be used for rendered images.

Enumerator
ENCODING_NONE
ENCODING_BASE64

Definition at line 39 of file vtkWebApplication.h.

◆ anonymous enum

anonymous enum

Set the compression to be used for rendered images.

Enumerator
COMPRESSION_NONE
COMPRESSION_PNG
COMPRESSION_JPEG

Definition at line 52 of file vtkWebApplication.h.

Constructor & Destructor Documentation

◆ vtkWebApplication()

vtkWebApplication::vtkWebApplication ( )

protected

◆ ~vtkWebApplication()

vtkWebApplication::~vtkWebApplication ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkWebApplication* vtkWebApplication::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkWebApplication::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 vtkWebApplication* vtkWebApplication::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWebApplication::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkWebApplication* vtkWebApplication::NewInstance ( ) const

◆ PrintSelf()

void vtkWebApplication::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.

◆ SetImageEncoding()

virtual void vtkWebApplication::SetImageEncoding ( int )

virtual

Set the encoding to be used for rendered images.

◆ GetImageEncoding()

virtual int vtkWebApplication::GetImageEncoding ( )

virtual

Set the encoding to be used for rendered images.

◆ SetImageCompression()

virtual void vtkWebApplication::SetImageCompression ( int )

virtual

Set the compression to be used for rendered images.

◆ GetImageCompression()

virtual int vtkWebApplication::GetImageCompression ( )

virtual

Set the compression to be used for rendered images.

◆ SetNumberOfEncoderThreads()

void vtkWebApplication::SetNumberOfEncoderThreads ( vtkTypeUInt32 )

Set the number of worker threads to use for image encoding.

Calling this method with a number greater than 32 or less than zero will have no effect.

◆ GetNumberOfEncoderThreads()

vtkTypeUInt32 vtkWebApplication::GetNumberOfEncoderThreads ( )

Set the number of worker threads to use for image encoding.

Calling this method with a number greater than 32 or less than zero will have no effect.

◆ StillRender()

vtkUnsignedCharArray* vtkWebApplication::StillRender	(	vtkRenderWindow *	view,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ InteractiveRender()

vtkUnsignedCharArray* vtkWebApplication::InteractiveRender	(	vtkRenderWindow *	view,
		int	quality = `50`
	)

Render a view and obtain the rendered image.

◆ StillRenderToString()

const char* vtkWebApplication::StillRenderToString	(	vtkRenderWindow *	view,
		vtkMTimeType	time = `0`,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ StillRenderToBuffer()

vtkUnsignedCharArray* vtkWebApplication::StillRenderToBuffer	(	vtkRenderWindow *	view,
		vtkMTimeType	time = `0`,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ GetHasImagesBeingProcessed()

bool vtkWebApplication::GetHasImagesBeingProcessed ( vtkRenderWindow * )

StillRenderToString() need not necessary returns the most recently rendered image.

Use this method to get whether there are any pending images being processed concurrently.

◆ HandleInteractionEvent()

bool vtkWebApplication::HandleInteractionEvent	(	vtkRenderWindow *	view,
		vtkWebInteractionEvent *	event
	)

Communicate mouse interaction to a view.

Returns true if the interaction changed the view state, otherwise returns false.

◆ InvalidateCache()

void vtkWebApplication::InvalidateCache ( vtkRenderWindow * view )

Invalidate view cache.

◆ GetLastStillRenderToMTime()

virtual vtkMTimeType vtkWebApplication::GetLastStillRenderToMTime ( )

virtual

Return the MTime of the last array exported by StillRenderToString.

◆ GetWebGLSceneMetaData()

const char* vtkWebApplication::GetWebGLSceneMetaData ( vtkRenderWindow * view )

Return the Meta data description of the input scene in JSON format.

This is using the vtkWebGLExporter to parse the scene. NOTE: This should be called before getting the webGL binary data.

◆ GetWebGLBinaryData()

const char* vtkWebApplication::GetWebGLBinaryData	(	vtkRenderWindow *	view,
		const char *	id,
		int	partIndex
	)

Return the binary data given the part index and the webGL object piece id in the scene.

◆ GetObjectIdMap()

vtkObjectIdMap* vtkWebApplication::GetObjectIdMap ( )

◆ GetObjectId()

static std::string vtkWebApplication::GetObjectId ( vtkObject * obj )

static

Return a hexadecimal formatted string of the VTK object's memory address, useful for uniquely identifying the object when exporting data.

e.g. 0x8f05a90

Member Data Documentation

◆ ImageEncoding

int vtkWebApplication::ImageEncoding

protected

Definition at line 134 of file vtkWebApplication.h.

◆ ImageCompression

int vtkWebApplication::ImageCompression

protected

Definition at line 135 of file vtkWebApplication.h.

◆ LastStillRenderToMTime

vtkMTimeType vtkWebApplication::LastStillRenderToMTime

protected

Definition at line 136 of file vtkWebApplication.h.

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

Web/Core/vtkWebApplication.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkWebApplication()

◆ ~vtkWebApplication()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetImageEncoding()

◆ GetImageEncoding()

◆ SetImageCompression()

◆ GetImageCompression()

◆ SetNumberOfEncoderThreads()

◆ GetNumberOfEncoderThreads()

◆ StillRender()

◆ InteractiveRender()

◆ StillRenderToString()

◆ StillRenderToBuffer()

◆ GetHasImagesBeingProcessed()

◆ HandleInteractionEvent()

◆ InvalidateCache()

◆ GetLastStillRenderToMTime()

◆ GetWebGLSceneMetaData()

◆ GetWebGLBinaryData()

◆ GetObjectIdMap()

◆ GetObjectId()

Member Data Documentation

◆ ImageEncoding

◆ ImageCompression

◆ LastStillRenderToMTime