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

#include <vtkSMViewProxyInteractorHelper.h>

Inheritance diagram for vtkSMViewProxyInteractorHelper:

Collaboration diagram for vtkSMViewProxyInteractorHelper:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override


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

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkSMViewProxyInteractorHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkSMViewProxyInteractorHelper *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMViewProxyInteractorHelper ()

	~vtkSMViewProxyInteractorHelper () override


void	Execute (vtkObject caller, unsigned long event, void calldata)
	Handle event. More...

void	Render ()
	Handle event. More...

void	CleanupTimer ()
	Handle event. More...

void	Resize ()
	Handle event. More...

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
vtkCommand *	Observer

vtkWeakPointer< vtkSMViewProxy >	ViewProxy

vtkWeakPointer< vtkRenderWindowInteractor >	Interactor

int	DelayedRenderTimerId

bool	Interacting

bool	Interacted

int	EndWindowResizeTimerId = -1

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

WindowResizeNonInteractiveRenderDelay :- when present provides time in seconds to delay the StillRender() call after the window has been resized, ie. the interactor fires a vtkCommand::WindowResizeEvent. If missing or equals 0, 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 51 of file vtkSMViewProxyInteractorHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSMViewProxyInteractorHelper::Superclass

Definition at line 55 of file vtkSMViewProxyInteractorHelper.h.

Constructor & Destructor Documentation

◆ vtkSMViewProxyInteractorHelper()

vtkSMViewProxyInteractorHelper::vtkSMViewProxyInteractorHelper ( )

protected

◆ ~vtkSMViewProxyInteractorHelper()

vtkSMViewProxyInteractorHelper::~vtkSMViewProxyInteractorHelper ( )

overrideprotected

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ 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 76 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.

◆ Resize()

void vtkSMViewProxyInteractorHelper::Resize ( )

protected

Handle event.

Member Data Documentation

◆ Observer

vtkCommand* vtkSMViewProxyInteractorHelper::Observer

protected

Definition at line 93 of file vtkSMViewProxyInteractorHelper.h.

◆ ViewProxy

vtkWeakPointer<vtkSMViewProxy> vtkSMViewProxyInteractorHelper::ViewProxy

protected

Definition at line 94 of file vtkSMViewProxyInteractorHelper.h.

◆ Interactor

vtkWeakPointer<vtkRenderWindowInteractor> vtkSMViewProxyInteractorHelper::Interactor

protected

Definition at line 95 of file vtkSMViewProxyInteractorHelper.h.

◆ DelayedRenderTimerId

int vtkSMViewProxyInteractorHelper::DelayedRenderTimerId

protected

Definition at line 96 of file vtkSMViewProxyInteractorHelper.h.

◆ Interacting

bool vtkSMViewProxyInteractorHelper::Interacting

protected

Definition at line 97 of file vtkSMViewProxyInteractorHelper.h.

◆ Interacted

bool vtkSMViewProxyInteractorHelper::Interacted

protected

Definition at line 98 of file vtkSMViewProxyInteractorHelper.h.

◆ EndWindowResizeTimerId

int vtkSMViewProxyInteractorHelper::EndWindowResizeTimerId = -1

protected

Definition at line 100 of file vtkSMViewProxyInteractorHelper.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMViewProxyInteractorHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMViewProxyInteractorHelper()

◆ ~vtkSMViewProxyInteractorHelper()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetViewProxy()

◆ GetViewProxy()

◆ SetupInteractor()

◆ GetInteractor()

◆ CleanupInteractor()

◆ Execute()

◆ Render()

◆ CleanupTimer()

◆ Resize()

Member Data Documentation

◆ Observer

◆ ViewProxy

◆ Interactor

◆ DelayedRenderTimerId

◆ Interacting

◆ Interacted

◆ EndWindowResizeTimerId