ParaView
|
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... | |
vtkSMViewProxy * | GetViewProxy () |
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 vtkSMViewProxyInteractorHelper * | New () |
static int | IsTypeOf (const char *type) |
static vtkSMViewProxyInteractorHelper * | SafeDownCast (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< vtkSMViewProxy > | ViewProxy |
vtkWeakPointer< vtkRenderWindowInteractor > | Interactor |
int | DelayedRenderTimerId |
bool | Interacting |
bool | Interacted |
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:
NonInteractiveRenderDelay
:- when present provides time in seconds to delay the StillRender() call after user interaction has ended i.e. vtkRenderWindowInteractor fires the vtkCommand::EndInteractionEvent. If missing, or less than 0.01, the view will immediately render.EnableRenderOnInteraction
:- when present provides a flag whether the interactor should trigger the render calls (either StillRender or InteractiveRender) as a consequence of interaction. If missing, we treat EnableRender as ON. Definition at line 58 of file vtkSMViewProxyInteractorHelper.h.
typedef vtkObject vtkSMViewProxyInteractorHelper::Superclass |
Definition at line 62 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
|
protected |
|
static |
|
virtual |
|
static |
|
virtual |
|
static |
void vtkSMViewProxyInteractorHelper::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
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.
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.
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.
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.
|
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.
|
protected |
Handle event.
|
protected |
Handle event.
|
protected |
Handle event.
|
protected |
Definition at line 99 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
Definition at line 100 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
Definition at line 101 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
Definition at line 102 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
Definition at line 103 of file vtkSMViewProxyInteractorHelper.h.
|
protected |
Definition at line 104 of file vtkSMViewProxyInteractorHelper.h.