defines ParaViewWeb application interface. More...

#include <vtkPVWebApplication.h>

Inheritance diagram for vtkPVWebApplication:

Collaboration diagram for vtkPVWebApplication:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

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

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

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


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

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

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

vtkUnsignedCharArray *	StillRenderToBuffer (vtkSMViewProxy *view, unsigned long 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, StillRenderToBuffer. More...


virtual int *	GetLastStillRenderImageSize ()
	Return the size of the last image exported. More...

virtual void	GetLastStillRenderImageSize (int &, int &)
	Return the size of the last image exported. More...

virtual void	GetLastStillRenderImageSize (int [2])
	Return the size of the last image exported. More...

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	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)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVWebApplication *	New ()

static int	IsTypeOf (const char *type)

static vtkPVWebApplication *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVWebApplication ()

	~vtkPVWebApplication () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	ImageEncoding

int	ImageCompression

vtkMTimeType	LastStillRenderToMTime

int	LastStillRenderImageSize [3]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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...

Detailed Description

defines ParaViewWeb application interface.

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

Definition at line 22 of file vtkPVWebApplication.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVWebApplication::Superclass

Definition at line 26 of file vtkPVWebApplication.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 33 of file vtkPVWebApplication.h.

◆ anonymous enum

anonymous enum

Set the compression to be used for rendered images.

Enumerator
COMPRESSION_NONE
COMPRESSION_PNG
COMPRESSION_JPEG

Definition at line 46 of file vtkPVWebApplication.h.

Constructor & Destructor Documentation

◆ vtkPVWebApplication()

vtkPVWebApplication::vtkPVWebApplication ( )

protected

◆ ~vtkPVWebApplication()

vtkPVWebApplication::~vtkPVWebApplication ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVWebApplication* vtkPVWebApplication::New ( )

static

◆ GetClassName()

virtual const char* vtkPVWebApplication::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkPVWebApplication::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVWebApplication::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkPVWebApplication* vtkPVWebApplication::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkPVWebApplication::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ SetImageEncoding()

virtual void vtkPVWebApplication::SetImageEncoding ( int )

virtual

Set the encoding to be used for rendered images.

◆ GetImageEncoding()

virtual int vtkPVWebApplication::GetImageEncoding ( )

virtual

Set the encoding to be used for rendered images.

◆ SetImageCompression()

virtual void vtkPVWebApplication::SetImageCompression ( int )

virtual

Set the compression to be used for rendered images.

◆ GetImageCompression()

virtual int vtkPVWebApplication::GetImageCompression ( )

virtual

Set the compression to be used for rendered images.

◆ StillRender()

vtkUnsignedCharArray* vtkPVWebApplication::StillRender	(	vtkSMViewProxy *	view,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ InteractiveRender()

vtkUnsignedCharArray* vtkPVWebApplication::InteractiveRender	(	vtkSMViewProxy *	view,
		int	quality = `50`
	)

Render a view and obtain the rendered image.

◆ StillRenderToString()

const char* vtkPVWebApplication::StillRenderToString	(	vtkSMViewProxy *	view,
		unsigned long	time = `0`,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ StillRenderToBuffer()

vtkUnsignedCharArray* vtkPVWebApplication::StillRenderToBuffer	(	vtkSMViewProxy *	view,
		unsigned long	time = `0`,
		int	quality = `100`
	)

Render a view and obtain the rendered image.

◆ GetHasImagesBeingProcessed()

bool vtkPVWebApplication::GetHasImagesBeingProcessed ( vtkSMViewProxy * )

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 vtkPVWebApplication::HandleInteractionEvent	(	vtkSMViewProxy *	view,
		vtkWebInteractionEvent *	event
	)

Communicate mouse interaction to a view.

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

◆ InvalidateCache()

void vtkPVWebApplication::InvalidateCache ( vtkSMViewProxy * view )

Invalidate view cache.

◆ GetLastStillRenderToMTime()

virtual vtkMTimeType vtkPVWebApplication::GetLastStillRenderToMTime ( )

virtual

Return the MTime of the last array exported by StillRenderToString, StillRenderToBuffer.

◆ GetWebGLSceneMetaData()

const char* vtkPVWebApplication::GetWebGLSceneMetaData ( vtkSMViewProxy * 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* vtkPVWebApplication::GetWebGLBinaryData	(	vtkSMViewProxy *	view,
		const char *	id,
		int	partIndex
	)

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

◆ GetLastStillRenderImageSize() [1/3]

virtual int* vtkPVWebApplication::GetLastStillRenderImageSize ( )

virtual

Return the size of the last image exported.

◆ GetLastStillRenderImageSize() [2/3]

virtual void vtkPVWebApplication::GetLastStillRenderImageSize	(	int &	,
		int &
	)

virtual

Return the size of the last image exported.

◆ GetLastStillRenderImageSize() [3/3]

virtual void vtkPVWebApplication::GetLastStillRenderImageSize ( int [2] )

virtual

Return the size of the last image exported.

Member Data Documentation

◆ ImageEncoding

int vtkPVWebApplication::ImageEncoding

protected

Definition at line 116 of file vtkPVWebApplication.h.

◆ ImageCompression

int vtkPVWebApplication::ImageCompression

protected

Definition at line 117 of file vtkPVWebApplication.h.

◆ LastStillRenderToMTime

vtkMTimeType vtkPVWebApplication::LastStillRenderToMTime

protected

Definition at line 118 of file vtkPVWebApplication.h.

◆ LastStillRenderImageSize

int vtkPVWebApplication::LastStillRenderImageSize[3]

protected

Definition at line 119 of file vtkPVWebApplication.h.

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

/builds/gitlab-kitware-sciviz-ci/Clients/Web/vtkPVWebApplication.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkPVWebApplication()

◆ ~vtkPVWebApplication()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetImageEncoding()

◆ GetImageEncoding()

◆ SetImageCompression()

◆ GetImageCompression()

◆ StillRender()

◆ InteractiveRender()

◆ StillRenderToString()

◆ StillRenderToBuffer()

◆ GetHasImagesBeingProcessed()

◆ HandleInteractionEvent()

◆ InvalidateCache()

◆ GetLastStillRenderToMTime()

◆ GetWebGLSceneMetaData()

◆ GetWebGLBinaryData()

◆ GetLastStillRenderImageSize() [1/3]

◆ GetLastStillRenderImageSize() [2/3]

◆ GetLastStillRenderImageSize() [3/3]

Member Data Documentation

◆ ImageEncoding

◆ ImageCompression

◆ LastStillRenderToMTime

◆ LastStillRenderImageSize