vtkRenderViewBase Class Reference

A base view containing a renderer. More...

#include <vtkRenderViewBase.h>

Inheritance diagram for vtkRenderViewBase:

Collaboration diagram for vtkRenderViewBase:

Public Types
typedef vtkView	Superclass
Public Types inherited from vtkView
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkRenderViewBase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkRenderer *	GetRenderer ()
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderWindow *	GetRenderWindow ()
virtual void	SetRenderWindow (vtkRenderWindow *win)
virtual void	Render ()
virtual void	ResetCamera ()
virtual void	ResetCameraClippingRange ()
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual void	SetInteractor (vtkRenderWindowInteractor *)
Public Member Functions inherited from vtkView
vtkView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddRepresentation (vtkDataRepresentation *rep)
void	SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
void	RemoveRepresentation (vtkDataRepresentation *rep)
void	RemoveRepresentation (vtkAlgorithmOutput *rep)
void	RemoveAllRepresentations ()
int	GetNumberOfRepresentations ()
vtkDataRepresentation *	GetRepresentation (int index=0)
bool	IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void	Update ()
virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommand *	GetObserver ()
void	RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void	UnRegisterProgress (vtkObject *algorithm)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkRenderViewBase *	New ()
static int	IsTypeOf (const char *type)
static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkView
static vtkView *	New ()
static int	IsTypeOf (const char *type)
static vtkView *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderViewBase ()
	~vtkRenderViewBase ()
virtual void	PrepareForRendering ()
Protected Member Functions inherited from vtkView
	vtkView ()
	~vtkView ()
virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual void	ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void	SetReuseSingleRepresentation (bool)
virtual bool	GetReuseSingleRepresentation ()
virtual void	ReuseSingleRepresentationOn ()
virtual void	ReuseSingleRepresentationOff ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

A base view containing a renderer.

vtkRenderViewBase is a view which contains a vtkRenderer. You may add vtkActors directly to the renderer.

This class is also the parent class for any more specialized view which uses a renderer.

In order to use the view with a QVTKWidget the following code is required to ensure the interactor and render window are initialized properly.

QVTKWidget *widget = new QVTKWidget;
vtkContextView *view = vtkContextView::New();
view->SetInteractor(widget->GetInteractor());
widget->SetRenderWindow(view->GetRenderWindow());

Definition at line 48 of file vtkRenderViewBase.h.

Member Typedef Documentation

typedef vtkView vtkRenderViewBase::Superclass

Definition at line 52 of file vtkRenderViewBase.h.

Constructor & Destructor Documentation

vtkRenderViewBase::vtkRenderViewBase ( )

protected

vtkRenderViewBase::~vtkRenderViewBase ( )

protected

Member Function Documentation

static vtkRenderViewBase* vtkRenderViewBase::New ( )

static

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

static

virtual int vtkRenderViewBase::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 vtkView.

Reimplemented in vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, vtkContextView, and vtkIcicleView.

static vtkRenderViewBase* vtkRenderViewBase::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkRenderViewBase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkView.

Reimplemented in vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, vtkContextView, and vtkIcicleView.

vtkRenderViewBase* vtkRenderViewBase::NewInstance

(

)

const

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

virtual

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.

Reimplemented in vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, and vtkIcicleView.

virtual vtkRenderer* vtkRenderViewBase::GetRenderer ( )

virtual

Gets the renderer for this view.

virtual void vtkRenderViewBase::SetRenderer ( vtkRenderer *  ren )

virtual

virtual vtkRenderWindow* vtkRenderViewBase::GetRenderWindow ( )

virtual

Get a handle to the render window.

virtual void vtkRenderViewBase::SetRenderWindow ( vtkRenderWindow *  win )

virtual

Set the render window for this view. Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

Reimplemented in vtkRenderView.

virtual vtkRenderWindowInteractor* vtkRenderViewBase::GetInteractor ( )

virtual

The render window interactor. Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

virtual void vtkRenderViewBase::SetInteractor ( vtkRenderWindowInteractor *  )

virtual

The render window interactor. Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

Reimplemented in vtkRenderView.

virtual void vtkRenderViewBase::Render ( )

virtual

Updates the representations, then calls Render() on the render window associated with this view.

Reimplemented in vtkRenderView, vtkGeoView, and vtkGeoView2D.

virtual void vtkRenderViewBase::ResetCamera ( )

virtual

Updates the representations, then calls ResetCamera() on the renderer associated with this view.

virtual void vtkRenderViewBase::ResetCameraClippingRange ( )

virtual

Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view.

virtual void vtkRenderViewBase::PrepareForRendering ( )

protectedvirtual

Called by the view when the renderer is about to render.

Reimplemented in vtkRenderView, vtkParallelCoordinatesView, vtkGeoView2D, and vtkGeoView.

Member Data Documentation

vtkSmartPointer<vtkRenderer> vtkRenderViewBase::Renderer

protected

Definition at line 96 of file vtkRenderViewBase.h.

vtkSmartPointer<vtkRenderWindow> vtkRenderViewBase::RenderWindow

protected

Definition at line 97 of file vtkRenderViewBase.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Views/Core/vtkRenderViewBase.h