ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVWebApplication Class Reference

defines ParaViewWeb application interface. More...

#include <vtkPVWebApplication.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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...
 
virtual vtkMTimeType GetLastStillRenderToStringMTime ()
 Return the MTime of the last array exported by StillRenderToString. 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...
 

Static Public Member Functions

static vtkPVWebApplicationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVWebApplicationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVWebApplication ()
 
 ~vtkPVWebApplication ()
 

Protected Attributes

int ImageEncoding
 
int ImageCompression
 
vtkMTimeType LastStillRenderToStringMTime
 
int LastStillRenderImageSize [3]
 
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 34 of file vtkPVWebApplication.h.

Member Typedef Documentation

§ Superclass

Definition at line 38 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 45 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 58 of file vtkPVWebApplication.h.

Constructor & Destructor Documentation

§ vtkPVWebApplication()

vtkPVWebApplication::vtkPVWebApplication ( )
protected

§ ~vtkPVWebApplication()

vtkPVWebApplication::~vtkPVWebApplication ( )
protected

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

§ SafeDownCast()

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

§ PrintSelf()

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

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

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

§ GetLastStillRenderToStringMTime()

virtual vtkMTimeType vtkPVWebApplication::GetLastStillRenderToStringMTime ( )
virtual

Return the MTime of the last array exported by StillRenderToString.

§ 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 126 of file vtkPVWebApplication.h.

§ ImageCompression

int vtkPVWebApplication::ImageCompression
protected

Definition at line 127 of file vtkPVWebApplication.h.

§ LastStillRenderToStringMTime

vtkMTimeType vtkPVWebApplication::LastStillRenderToStringMTime
protected

Definition at line 128 of file vtkPVWebApplication.h.

§ LastStillRenderImageSize

int vtkPVWebApplication::LastStillRenderImageSize[3]
protected

Definition at line 129 of file vtkPVWebApplication.h.


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