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

helper class that make it easier to hook vtkRenderWindowInteractor and vtkSMViewProxy. More...

#include <vtkSMViewProxyInteractorHelper.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)
 
void SetViewProxy (vtkSMViewProxy *proxy)
 Set the view proxy. More...
 
vtkSMViewProxyGetViewProxy ()
 Set the view proxy. More...
 
void SetupInteractor (vtkRenderWindowInteractor *iren)
 Set the interactor to "help" the view with. More...
 
vtkRenderWindowInteractor * GetInteractor ()
 Set the interactor to "help" the view with. More...
 
void CleanupInteractor ()
 Set the interactor to "help" the view with. More...
 

Static Public Member Functions

static vtkSMViewProxyInteractorHelperNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMViewProxyInteractorHelperSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMViewProxyInteractorHelper ()
 
 ~vtkSMViewProxyInteractorHelper ()
 
void Execute (vtkObject *caller, unsigned long event, void *calldata)
 Handle event. More...
 
void Render ()
 Handle event. More...
 
void CleanupTimer ()
 Handle event. More...
 

Protected Attributes

vtkCommand * Observer
 
vtkWeakPointer< vtkSMViewProxyViewProxy
 
vtkWeakPointer< vtkRenderWindowInteractor > Interactor
 
int DelayedRenderTimerId
 
bool Interacting
 
bool Interacted
 

Detailed Description

helper class that make it easier to hook vtkRenderWindowInteractor and vtkSMViewProxy.

vtkSMViewProxyInteractorHelper is a helper class designed to make it easier to hook up vtkRenderWindowInteractor to call methods on a vtkSMViewProxy (or subclass). It's primarily designed to work with vtkSMRenderViewProxy (and subclasses), but it should work with other types of views too.

To use this helper, the view typically creates a instance for itself as register itself (using vtkSMViewProxyInteractorHelper::SetViewProxy) and then calls vtkSMViewProxyInteractorHelper::SetupInteractor(). This method will initialize the interactor (potentially changing some ivars on the interactor to avoid automatic rendering, using vtkRenderWindowInteractor::EnableRenderOff(), etc.) and setup event observer to monitor interaction.

vtkSMViewProxyInteractorHelper only using vtkSMViewProxy::StillRender() and vtkSMViewProxy::InteractiveRender() APIs directly. However several properties can be optionally present on the view proxy to dictate this class' behaviour. These are as follows:

Definition at line 58 of file vtkSMViewProxyInteractorHelper.h.

Member Typedef Documentation

◆ Superclass

Definition at line 62 of file vtkSMViewProxyInteractorHelper.h.

Constructor & Destructor Documentation

◆ vtkSMViewProxyInteractorHelper()

vtkSMViewProxyInteractorHelper::vtkSMViewProxyInteractorHelper ( )
protected

◆ ~vtkSMViewProxyInteractorHelper()

vtkSMViewProxyInteractorHelper::~vtkSMViewProxyInteractorHelper ( )
protected

Member Function Documentation

◆ New()

static vtkSMViewProxyInteractorHelper* vtkSMViewProxyInteractorHelper::New ( )
static

◆ GetClassName()

virtual const char* vtkSMViewProxyInteractorHelper::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetViewProxy()

void vtkSMViewProxyInteractorHelper::SetViewProxy ( vtkSMViewProxy proxy)

Set the view proxy.

This is a weak reference i.e. the view proxy's reference count will be unchanged by this call.

◆ GetViewProxy()

vtkSMViewProxy* vtkSMViewProxyInteractorHelper::GetViewProxy ( )

Set the view proxy.

This is a weak reference i.e. the view proxy's reference count will be unchanged by this call.

◆ SetupInteractor()

void vtkSMViewProxyInteractorHelper::SetupInteractor ( vtkRenderWindowInteractor *  iren)

Set the interactor to "help" the view with.

This is a weak reference i.e. the interactor's reference count will be unchanged by this call.

◆ GetInteractor()

vtkRenderWindowInteractor* vtkSMViewProxyInteractorHelper::GetInteractor ( )

Set the interactor to "help" the view with.

This is a weak reference i.e. the interactor's reference count will be unchanged by this call.

◆ CleanupInteractor()

void vtkSMViewProxyInteractorHelper::CleanupInteractor ( )
inline

Set the interactor to "help" the view with.

This is a weak reference i.e. the interactor's reference count will be unchanged by this call.

Definition at line 83 of file vtkSMViewProxyInteractorHelper.h.

◆ Execute()

void vtkSMViewProxyInteractorHelper::Execute ( vtkObject *  caller,
unsigned long  event,
void *  calldata 
)
protected

Handle event.

◆ Render()

void vtkSMViewProxyInteractorHelper::Render ( )
protected

Handle event.

◆ CleanupTimer()

void vtkSMViewProxyInteractorHelper::CleanupTimer ( )
protected

Handle event.

Member Data Documentation

◆ Observer

vtkCommand* vtkSMViewProxyInteractorHelper::Observer
protected

Definition at line 99 of file vtkSMViewProxyInteractorHelper.h.

◆ ViewProxy

vtkWeakPointer<vtkSMViewProxy> vtkSMViewProxyInteractorHelper::ViewProxy
protected

Definition at line 100 of file vtkSMViewProxyInteractorHelper.h.

◆ Interactor

vtkWeakPointer<vtkRenderWindowInteractor> vtkSMViewProxyInteractorHelper::Interactor
protected

Definition at line 101 of file vtkSMViewProxyInteractorHelper.h.

◆ DelayedRenderTimerId

int vtkSMViewProxyInteractorHelper::DelayedRenderTimerId
protected

Definition at line 102 of file vtkSMViewProxyInteractorHelper.h.

◆ Interacting

bool vtkSMViewProxyInteractorHelper::Interacting
protected

Definition at line 103 of file vtkSMViewProxyInteractorHelper.h.

◆ Interacted

bool vtkSMViewProxyInteractorHelper::Interacted
protected

Definition at line 104 of file vtkSMViewProxyInteractorHelper.h.


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