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

helper class to write animation geometry in a web archive. More...

#include <vtkSMAnimationSceneWebWriter.h>

Inheritance diagram for vtkSMAnimationSceneWebWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkSMAnimationSceneWebWriter:
Collaboration graph
[legend]

Public Types

typedef vtkSMAnimationSceneWriter Superclass
 
- Public Types inherited from vtkSMAnimationSceneWriter
typedef vtkSMSessionObject Superclass
 
- Public Types inherited from vtkSMSessionObject
typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkSMRenderViewProxyGetRenderView ()
 Get/Set the (render) View Module from which we are writing the geometry. More...
 
void SetRenderView (vtkSMRenderViewProxy *)
 
- Public Member Functions inherited from vtkSMAnimationSceneWriter
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetAnimationScene (vtkSMProxy *)
 Convenience method to set the proxy. More...
 
bool Save ()
 Begin the saving. More...
 
virtual void SetAnimationScene (vtkSMAnimationScene *)
 Get/Set the animation scene that this writer will write. More...
 
virtual vtkSMAnimationSceneGetAnimationScene ()
 Get/Set the animation scene that this writer will write. More...
 
virtual void SetFileName (const char *)
 Get/Set the filename. More...
 
virtual char * GetFileName ()
 Get/Set the filename. More...
 
virtual void SetStartFileCount (int)
 Get/Set the start file count. More...
 
virtual int GetStartFileCount ()
 Get/Set the start file count. More...
 
virtual void SetPlaybackTimeWindow (double, double)
 Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...
 
void SetPlaybackTimeWindow (double [2])
 Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...
 
virtual doubleGetPlaybackTimeWindow ()
 Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...
 
virtual void GetPlaybackTimeWindow (double &, double &)
 Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...
 
virtual void GetPlaybackTimeWindow (double [2])
 Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...
 
virtual void SetStride (int)
 Set/Get The stride which is used to extract the next frame. More...
 
virtual int GetStride ()
 Set/Get The stride which is used to extract the next frame. More...
 
- Public Member Functions inherited from vtkSMSessionObject
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMAnimationSceneWebWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMAnimationSceneWebWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMAnimationSceneWriter
static int IsTypeOf (const char *type)
 
static vtkSMAnimationSceneWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
static std::string CreatePrettyLabel (const std::string &name)
 Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMAnimationSceneWebWriter ()
 
 ~vtkSMAnimationSceneWebWriter () override
 
bool SaveInitialize (int startCount) override
 Called to initialize saving. More...
 
bool SaveFrame (double time) override
 Called to save a particular frame. More...
 
bool SaveFinalize () override
 Called to finalize saving. More...
 
- Protected Member Functions inherited from vtkSMAnimationSceneWriter
 vtkSMAnimationSceneWriter ()
 
 ~vtkSMAnimationSceneWriter () override
 
void ExecuteEvent (vtkObject *caller, unsigned long eventid, void *calldata)
 
- Protected Member Functions inherited from vtkSMSessionObject
 vtkSMSessionObject ()
 
 ~vtkSMSessionObject () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () 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

vtkSMRenderViewProxyRenderView = nullptr
 
- Protected Attributes inherited from vtkSMAnimationSceneWriter
unsigned long ObserverID
 
vtkSMAnimationSceneAnimationScene
 
bool Saving
 
bool SaveFailed
 
char * FileName
 
double PlaybackTimeWindow [2]
 
int StartFileCount
 
int Stride = 1
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 Identifies the session id to which this object is related. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper class to write animation geometry in a web archive.

vtkSMAnimationSceneWebWriter is a concrete implementation of vtkSMAnimationSceneWriter that can write the geometry as a web archive. This writer can only write the visible geometry in one view.

Definition at line 22 of file vtkSMAnimationSceneWebWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkSMAnimationSceneWebWriter.h.

Constructor & Destructor Documentation

◆ vtkSMAnimationSceneWebWriter()

vtkSMAnimationSceneWebWriter::vtkSMAnimationSceneWebWriter ( )
protected

◆ ~vtkSMAnimationSceneWebWriter()

vtkSMAnimationSceneWebWriter::~vtkSMAnimationSceneWebWriter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMAnimationSceneWebWriter* vtkSMAnimationSceneWebWriter::New ( )
static

◆ GetClassName()

virtual const char* vtkSMAnimationSceneWebWriter::GetClassName ( )
virtual

Reimplemented from vtkSMAnimationSceneWriter.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMAnimationSceneWriter.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMAnimationSceneWebWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetRenderView()

virtual vtkSMRenderViewProxy* vtkSMAnimationSceneWebWriter::GetRenderView ( )
virtual

Get/Set the (render) View Module from which we are writing the geometry.

◆ SetRenderView()

void vtkSMAnimationSceneWebWriter::SetRenderView ( vtkSMRenderViewProxy )

◆ SaveInitialize()

bool vtkSMAnimationSceneWebWriter::SaveInitialize ( int  startCount)
overrideprotectedvirtual

Called to initialize saving.

Implements vtkSMAnimationSceneWriter.

◆ SaveFrame()

bool vtkSMAnimationSceneWebWriter::SaveFrame ( double  time)
overrideprotectedvirtual

Called to save a particular frame.

Implements vtkSMAnimationSceneWriter.

◆ SaveFinalize()

bool vtkSMAnimationSceneWebWriter::SaveFinalize ( )
overrideprotectedvirtual

Called to finalize saving.

Implements vtkSMAnimationSceneWriter.

Member Data Documentation

◆ RenderView

vtkSMRenderViewProxy* vtkSMAnimationSceneWebWriter::RenderView = nullptr
protected

Definition at line 55 of file vtkSMAnimationSceneWebWriter.h.


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