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 int	IsA (const char *type)
vtkWebApplication *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	GetHasImagesBeingProcessed (vtkRenderWindow *)
void	InvalidateCache (vtkRenderWindow *view)
const char *	GetWebGLSceneMetaData (vtkRenderWindow *view)
const char *	GetWebGLBinaryData (vtkRenderWindow view, const char id, int partIndex)
vtkObjectIdMap *	GetObjectIdMap ()

vtkUnsignedCharArray *	StillRender (vtkRenderWindow *view, int quality=100)
vtkUnsignedCharArray *	InteractiveRender (vtkRenderWindow *view, int quality=50)
const char *	StillRenderToString (vtkRenderWindow *view, unsigned long time=0, int quality=100)

bool	HandleInteractionEvent (vtkRenderWindow view, vtkWebInteractionEvent event)

virtual unsigned long	GetLastStillRenderToStringMTime ()
Static Public Member Functions
static vtkWebApplication *	New ()
static int	IsTypeOf (const char *type)
static vtkWebApplication *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkWebApplication ()
	~vtkWebApplication ()
Protected Attributes
int	ImageEncoding
int	ImageCompression
unsigned long	LastStillRenderToStringMTime
enum	{ ENCODING_NONE = 0, ENCODING_BASE64 = 1 }
virtual void	SetImageEncoding (int)
virtual int	GetImageEncoding ()
enum	{ COMPRESSION_NONE = 0, COMPRESSION_PNG = 1, COMPRESSION_JPEG = 2 }
virtual void	SetImageCompression (int)
virtual int	GetImageCompression ()

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.

Definition at line 34 of file vtkWebApplication.h.

Member Typedef Documentation

typedef vtkObject vtkWebApplication::Superclass

Reimplemented from vtkObject.

Definition at line 38 of file vtkWebApplication.h.

Member Enumeration Documentation

anonymous enum

Set the encoding to be used for rendered images.

Enumerator:

ENCODING_NONE
ENCODING_BASE64

Definition at line 43 of file vtkWebApplication.h.

anonymous enum

Set the compression to be used for rendered images.

Enumerator:

COMPRESSION_NONE
COMPRESSION_PNG
COMPRESSION_JPEG

Definition at line 54 of file vtkWebApplication.h.

Constructor & Destructor Documentation

vtkWebApplication::vtkWebApplication ( ) [protected]

vtkWebApplication::~vtkWebApplication ( ) [protected]

Member Function Documentation

static vtkWebApplication* vtkWebApplication::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkWebApplication::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

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

static vtkWebApplication* vtkWebApplication::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkWebApplication::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkWebApplication* vtkWebApplication::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkWebApplication::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

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.

virtual void vtkWebApplication::SetImageEncoding ( int ) [virtual]

Set the encoding to be used for rendered images.

virtual int vtkWebApplication::GetImageEncoding ( ) [virtual]

Set the encoding to be used for rendered images.

virtual void vtkWebApplication::SetImageCompression ( int ) [virtual]

Set the compression to be used for rendered images.

virtual int vtkWebApplication::GetImageCompression ( ) [virtual]

Set the compression to be used for rendered images.

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

Render a view and obtain the rendered image.

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

Render a view and obtain the rendered image.

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

Render a view and obtain the rendered image.

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.

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.

void vtkWebApplication::InvalidateCache ( vtkRenderWindow * view )

Invalidate view cache

virtual unsigned long vtkWebApplication::GetLastStillRenderToStringMTime ( ) [virtual]

Return the MTime of the last array exported by StillRenderToString.

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.