VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWebApplication Class Reference

defines ParaViewWeb application interface. More...

#include <vtkWebApplication.h>

Inheritance diagram for vtkWebApplication:
[legend]
Collaboration diagram for vtkWebApplication:
[legend]

Public Types

enum  { ENCODING_NONE =0, ENCODING_BASE64 =1 }
 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...
 
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...
 
vtkWebApplicationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetImageEncoding (int)
 
virtual int GetImageEncoding ()
 
virtual void SetImageCompression (int)
 
virtual int GetImageCompression ()
 
void SetNumberOfEncoderThreads (vtkTypeUInt32)
 Set the number of worker threads to use for image encoding. More...
 
vtkTypeUInt32 GetNumberOfEncoderThreads ()
 
vtkUnsignedCharArrayStillRender (vtkRenderWindow *view, int quality=100)
 Render a view and obtain the rendered image. More...
 
vtkUnsignedCharArrayInteractiveRender (vtkRenderWindow *view, int quality=50)
 
const char * StillRenderToString (vtkRenderWindow *view, vtkMTimeType time=0, int quality=100)
 
vtkUnsignedCharArrayStillRenderToBuffer (vtkRenderWindow *view, vtkMTimeType time=0, int quality=100)
 
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...
 
virtual vtkMTimeType GetLastStillRenderToMTime ()
 Return the MTime of the last array exported by StillRenderToString. 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...
 
vtkObjectIdMapGetObjectIdMap ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkWebApplicationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebApplicationSafeDownCast (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 vtkObjectNew ()
 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 39 of file vtkWebApplication.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 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 50 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 63 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

◆ GetImageEncoding()

virtual int vtkWebApplication::GetImageEncoding ( )
virtual

◆ SetImageCompression()

virtual void vtkWebApplication::SetImageCompression ( int  )
virtual

◆ GetImageCompression()

virtual int vtkWebApplication::GetImageCompression ( )
virtual

◆ 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 ( )

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

◆ StillRenderToString()

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

◆ StillRenderToBuffer()

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

◆ 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 146 of file vtkWebApplication.h.

◆ ImageCompression

int vtkWebApplication::ImageCompression
protected

Definition at line 147 of file vtkWebApplication.h.

◆ LastStillRenderToMTime

vtkMTimeType vtkWebApplication::LastStillRenderToMTime
protected

Definition at line 148 of file vtkWebApplication.h.


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