The superclass for all views. More...

#include <vtkView.h>

Inheritance diagram for vtkView:

Collaboration diagram for vtkView:

Classes
class	ViewProgressEventCallData

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

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

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

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 &)

Friends
class	Command

bool	ReuseSingleRepresentation

virtual void	SetReuseSingleRepresentation (bool)

virtual bool	GetReuseSingleRepresentation ()

virtual void	ReuseSingleRepresentationOn ()

virtual void	ReuseSingleRepresentationOff ()

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

The superclass for all views.

vtkView is the superclass for views. A view is generally an area of an application's canvas devoted to displaying one or more VTK data objects. Associated representations (subclasses of vtkDataRepresentation) are responsible for converting the data into a displayable format. These representations are then added to the view.

For views which display only one data object at a time you may set a data object or pipeline connection directly on the view itself (e.g. vtkGraphLayoutView, vtkLandscapeView, vtkTreeMapView). The view will internally create a vtkDataRepresentation for the data.

A view has the concept of linked selection. If the same data is displayed in multiple views, their selections may be linked by setting the same vtkAnnotationLink on their representations (see vtkDataRepresentation).

Events:: vtkCommand::ViewProgressEvent

Examples:: vtkView (Examples)

Tests:: vtkView (Tests)

Definition at line 62 of file vtkView.h.

Member Typedef Documentation

typedef vtkObject vtkView::Superclass

Definition at line 66 of file vtkView.h.

Constructor & Destructor Documentation

vtkView::vtkView ( )

protected

vtkView::~vtkView ( )

protected

Member Function Documentation

static vtkView* vtkView::New ( )

static

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

static

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

Reimplemented in vtkGeoView, vtkQtTreeView, vtkRenderView, vtkQtTableView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkQtListView, vtkTreeRingView, vtkQtRichTextView, vtkRenderViewBase, vtkQtAnnotationView, vtkQtRecordView, vtkTreeMapView, vtkContextView, vtkIcicleView, and vtkQtView.

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

static

virtual vtkObjectBase* vtkView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkGeoView, vtkQtTreeView, vtkRenderView, vtkQtTableView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkQtListView, vtkTreeRingView, vtkQtRichTextView, vtkRenderViewBase, vtkQtAnnotationView, vtkQtRecordView, vtkTreeMapView, vtkContextView, vtkIcicleView, and vtkQtView.

vtkView* vtkView::NewInstance ( ) const

void vtkView::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, vtkQtTreeView, vtkRenderView, vtkQtTableView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkQtListView, vtkTreeRingView, vtkQtAnnotationView, vtkQtRecordView, vtkTreeMapView, vtkIcicleView, and vtkQtView.

void vtkView::AddRepresentation ( vtkDataRepresentation * rep )

Adds the representation to the view.

void vtkView::SetRepresentation ( vtkDataRepresentation * rep )

Set the representation to the view.

vtkDataRepresentation* vtkView::AddRepresentationFromInputConnection ( vtkAlgorithmOutput * conn )

Convenience method which creates a simple representation with the connection and adds it to the view. Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::SetRepresentationFromInputConnection ( vtkAlgorithmOutput * conn )

Convenience method which sets the representation with the connection and adds it to the view. Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::AddRepresentationFromInput ( vtkDataObject * input )

Convenience method which creates a simple representation with the specified input and adds it to the view. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::SetRepresentationFromInput ( vtkDataObject * input )

Convenience method which sets the representation to the specified input and adds it to the view. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

void vtkView::RemoveRepresentation ( vtkDataRepresentation * rep )

Removes the representation from the view.

void vtkView::RemoveRepresentation ( vtkAlgorithmOutput * rep )

Removes any representation with this connection from the view.

void vtkView::RemoveAllRepresentations ( )

Removes all representations from the view.

int vtkView::GetNumberOfRepresentations ( )

Returns the number of representations from first port(0) in this view.

vtkDataRepresentation* vtkView::GetRepresentation ( int index = 0 )

The representation at a specified index.

bool vtkView::IsRepresentationPresent ( vtkDataRepresentation * rep )

Check to see if a representation is present in the view.

virtual void vtkView::Update ( )

virtual

Update the view.

Reimplemented in vtkQtTableView, vtkQtTreeView, vtkQtListView, vtkQtRichTextView, vtkQtRecordView, and vtkQtAnnotationView.

virtual void vtkView::ApplyViewTheme ( vtkViewTheme * vtkNotUsedtheme )

inlinevirtual

Apply a theme to the view.

Definition at line 125 of file vtkView.h.

vtkCommand* vtkView::GetObserver ( )

Returns the observer that the subclasses can use to listen to additional events. Additionally these subclasses should override ProcessEvents() to handle these events.

void vtkView::RegisterProgress	(	vtkObject *	algorithm,
		const char *	message = `NULL`
	)

Meant for use by subclasses and vtkRepresentation subclasses. Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

void vtkView::UnRegisterProgress ( vtkObject * algorithm )

Unregister objects previously registered with RegisterProgress.

virtual void vtkView::ProcessEvents	(	vtkObject *	caller,
		unsigned long	eventId,
		void *	callData
	)

protectedvirtual

Called to process events. The superclass processes selection changed events from its representations. This may be overridden by subclasses to process additional events.

Reimplemented in vtkGraphLayoutView, vtkRenderView, and vtkParallelCoordinatesView.

virtual vtkDataRepresentation* vtkView::CreateDefaultRepresentation ( vtkAlgorithmOutput * conn )

protectedvirtual

Create a default vtkDataRepresentation for the given vtkAlgorithmOutput. View subclasses may override this method to create custom representations. This method is called by Add/SetRepresentationFromInputConnection. NOTE, the caller must delete the returned vtkDataRepresentation.

Reimplemented in vtkGraphLayoutView, vtkTreeAreaView, vtkParallelCoordinatesView, and vtkHierarchicalGraphView.

virtual void vtkView::AddRepresentationInternal ( vtkDataRepresentation * vtkNotUsedrep )

inlineprotectedvirtual

Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. Override these methods to perform custom actions.

Definition at line 203 of file vtkView.h.

virtual void vtkView::RemoveRepresentationInternal ( vtkDataRepresentation * vtkNotUsedrep )

inlineprotectedvirtual

Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. Override these methods to perform custom actions.

Definition at line 204 of file vtkView.h.

virtual void vtkView::SetReuseSingleRepresentation ( bool )

protectedvirtual

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual bool vtkView::GetReuseSingleRepresentation ( )

protectedvirtual

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual void vtkView::ReuseSingleRepresentationOn ( )

protectedvirtual

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual void vtkView::ReuseSingleRepresentationOff ( )

protectedvirtual

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

Friends And Related Function Documentation

friend class Command

friend

Definition at line 223 of file vtkView.h.

Member Data Documentation

bool vtkView::ReuseSingleRepresentation

protected

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

Definition at line 212 of file vtkView.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/vtkView.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation