defines ParaViewWeb application interface. More...

#include <vtkWebApplication.h>

Inheritance diagram for vtkWebApplication:

Collaboration diagram for vtkWebApplication:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 )

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)

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

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

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkWebApplication *	New ()

static int	IsTypeOf (const char *type)

static vtkWebApplication *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWebApplication ()

	~vtkWebApplication ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

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

unsigned long	LastStillRenderToStringMTime

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 }

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

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

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

static

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

virtual vtkObjectBase* vtkWebApplication::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkWebApplication* vtkWebApplication::NewInstance ( ) const

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.

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.

vtkObjectIdMap* vtkWebApplication::GetObjectIdMap ( )

Member Data Documentation

int vtkWebApplication::ImageEncoding

protected

Definition at line 107 of file vtkWebApplication.h.

int vtkWebApplication::ImageCompression

protected

Definition at line 108 of file vtkWebApplication.h.

unsigned long vtkWebApplication::LastStillRenderToStringMTime

protected

Definition at line 109 of file vtkWebApplication.h.

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

dox/Web/Core/vtkWebApplication.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation