A view containing a renderer. More...

#include <vtkRenderView.h>

Inheritance diagram for vtkRenderView:

Collaboration diagram for vtkRenderView:

Public Types
enum	{ INTERACTION_MODE_2D, INTERACTION_MODE_3D, INTERACTION_MODE_UNKNOWN }

enum	{ SURFACE = 0, FRUSTUM = 1 }

enum	{ NO_OVERLAP, ALL }

enum	{ FREETYPE, QT }

typedef vtkRenderViewBase	Superclass

Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass

Public Types inherited from vtkView
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkRenderView *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	The render window interactor. More...

virtual void	SetInteractorStyle (vtkInteractorObserver *style)
	The interactor style associated with the render view. More...

virtual vtkInteractorObserver *	GetInteractorStyle ()
	Get the interactor style associated with the render view. More...

void	SetRenderWindow (vtkRenderWindow *win) override
	Set the render window for this view. More...

void	SetInteractionMode (int mode)

virtual int	GetInteractionMode ()

virtual void	SetInteractionModeTo2D ()
	Set the interaction mode for the view. More...

virtual void	SetInteractionModeTo3D ()

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

void	ApplyViewTheme (vtkViewTheme *theme) override
	Applies a view theme to this view. More...

virtual void	AddLabels (vtkAlgorithmOutput *conn)
	Add labels from an input connection with an associated text property. More...

virtual void	RemoveLabels (vtkAlgorithmOutput *conn)
	Remove labels from an input connection. More...


virtual void	SetTransform (vtkAbstractTransform *transform)
	Set the view's transform. More...

virtual vtkAbstractTransform *	GetTransform ()
	Set the view's transform. More...


virtual void	SetDisplayHoverText (bool b)
	Whether the view should display hover text. More...

virtual bool	GetDisplayHoverText ()
	Whether the view should display hover text. More...

virtual void	DisplayHoverTextOn ()
	Whether the view should display hover text. More...

virtual void	DisplayHoverTextOff ()
	Whether the view should display hover text. More...


virtual void	SetSelectionMode (int)
	Sets the selection mode for the render view. More...

virtual int	GetSelectionMode ()
	Sets the selection mode for the render view. More...

void	SetSelectionModeToSurface ()
	Sets the selection mode for the render view. More...

void	SetSelectionModeToFrustum ()
	Sets the selection mode for the render view. More...


virtual void	SetIconTexture (vtkTexture *texture)
	Set the icon sheet to use for rendering icons. More...

virtual vtkTexture *	GetIconTexture ()
	Set the icon sheet to use for rendering icons. More...


virtual void	SetIconSize (int, int)
	Set the size of each icon in the icon texture. More...

void	SetIconSize (int[2])
	Set the size of each icon in the icon texture. More...

virtual int *	GetIconSize ()
	Set the size of each icon in the icon texture. More...

virtual void	GetIconSize (int &, int &)
	Set the size of each icon in the icon texture. More...

virtual void	GetIconSize (int[2])
	Set the size of each icon in the icon texture. More...


virtual void	SetDisplaySize (int, int)
	Set the display size of the icon (which may be different from the icon size). More...

void	SetDisplaySize (int[2])
	Set the display size of the icon (which may be different from the icon size). More...

int *	GetDisplaySize ()
	Set the display size of the icon (which may be different from the icon size). More...

void	GetDisplaySize (int &dsx, int &dsy)
	Set the display size of the icon (which may be different from the icon size). More...


virtual void	SetLabelPlacementMode (int mode)
	Label placement mode. More...

virtual int	GetLabelPlacementMode ()
	Label placement mode. More...

virtual void	SetLabelPlacementModeToNoOverlap ()
	Label placement mode. More...

virtual void	SetLabelPlacementModeToAll ()
	Label placement mode. More...


virtual void	SetLabelRenderMode (int mode)
	Label render mode. More...

virtual int	GetLabelRenderMode ()
	Label render mode. More...

virtual void	SetLabelRenderModeToFreetype ()
	Label render mode. More...

virtual void	SetLabelRenderModeToQt ()
	Label render mode. More...


void	SetRenderOnMouseMove (bool b)
	Whether to render on every mouse move. More...

virtual bool	GetRenderOnMouseMove ()
	Whether to render on every mouse move. More...

virtual void	RenderOnMouseMoveOn ()
	Whether to render on every mouse move. More...

virtual void	RenderOnMouseMoveOff ()
	Whether to render on every mouse move. More...

Public Member Functions inherited from vtkRenderViewBase
vtkRenderViewBase *	NewInstance () const

virtual vtkRenderer *	GetRenderer ()
	Gets the renderer for this view. More...

virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderWindow *	GetRenderWindow ()
	Get a handle to the render window. More...

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

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

virtual vtkRenderWindowInteractor *	GetInteractor ()
	The render window interactor. More...

Public Member Functions inherited from vtkView
vtkView *	NewInstance () const

void	AddRepresentation (vtkDataRepresentation *rep)
	Adds the representation to the view. More...

void	SetRepresentation (vtkDataRepresentation *rep)
	Set the representation to the view. More...

vtkDataRepresentation *	AddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which creates a simple representation with the connection and adds it to the view. More...

vtkDataRepresentation *	SetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
	Convenience method which sets the representation with the connection and adds it to the view. More...

vtkDataRepresentation *	AddRepresentationFromInput (vtkDataObject *input)
	Convenience method which creates a simple representation with the specified input and adds it to the view. More...

vtkDataRepresentation *	SetRepresentationFromInput (vtkDataObject *input)
	Convenience method which sets the representation to the specified input and adds it to the view. More...

void	RemoveRepresentation (vtkDataRepresentation *rep)
	Removes the representation from the view. More...

void	RemoveRepresentation (vtkAlgorithmOutput *rep)
	Removes any representation with this connection from the view. More...

void	RemoveAllRepresentations ()
	Removes all representations from the view. More...

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

vtkDataRepresentation *	GetRepresentation (int index=0)
	The representation at a specified index. More...

bool	IsRepresentationPresent (vtkDataRepresentation *rep)
	Check to see if a representation is present in the view. More...

virtual void	Update ()
	Update the view. More...

virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
	Apply a theme to the view. More...

vtkCommand *	GetObserver ()
	Returns the observer that the subclasses can use to listen to additional events. More...

void	RegisterProgress (vtkObject algorithm, const char message=nullptr)
	Meant for use by subclasses and vtkRepresentation subclasses. More...

void	UnRegisterProgress (vtkObject *algorithm)
	Unregister objects previously registered with RegisterProgress. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkRenderView *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderView *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderViewBase *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkView *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderView ()

	~vtkRenderView () override

void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData) override
	Called to process events. More...

virtual void	GenerateSelection (void callData, vtkSelection selection)
	Generates the selection based on the view event and the selection mode. More...

void	PrepareForRendering () override
	Called by the view when the renderer is about to render. More...

virtual void	UpdateHoverText ()
	Called in PrepareForRendering to update the hover text. More...

virtual void	UpdateHoverWidgetState ()
	Enable or disable hovering based on DisplayHoverText ivar and interaction state. More...

void	UpdatePickRender ()
	Update the pick render for queries for drag selections or hover ballooons. More...

Protected Member Functions inherited from vtkRenderViewBase
	vtkRenderViewBase ()

	~vtkRenderViewBase () override

Protected Member Functions inherited from vtkView
	vtkView ()
	Meant for use by subclasses and vtkRepresentation subclasses. More...

	~vtkView () override
	Meant for use by subclasses and vtkRepresentation subclasses. More...

virtual vtkDataRepresentation *	CreateDefaultRepresentation (vtkAlgorithmOutput *conn)
	Create a default vtkDataRepresentation for the given vtkAlgorithmOutput. More...

virtual void	AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. More...

virtual void	RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
	Meant for use by subclasses and vtkRepresentation subclasses. More...

virtual void	SetReuseSingleRepresentation (bool)
	True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. More...

virtual bool	GetReuseSingleRepresentation ()
	Meant for use by subclasses and vtkRepresentation subclasses. More...

virtual void	ReuseSingleRepresentationOn ()
	Meant for use by subclasses and vtkRepresentation subclasses. More...

virtual void	ReuseSingleRepresentationOff ()
	Meant for use by subclasses and vtkRepresentation subclasses. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

int	LabelRenderMode

bool	DisplayHoverText

bool	Interacting

bool	InHoverTextRender

bool	InPickRender

bool	PickRenderNeedsUpdate

vtkAbstractTransform *	Transform

vtkTexture *	IconTexture

int	IconSize [2]

int	DisplaySize [2]

int	InteractionMode

bool	RenderOnMouseMove

vtkSmartPointer< vtkRenderer >	LabelRenderer

vtkSmartPointer< vtkBalloonRepresentation >	Balloon

vtkSmartPointer< vtkLabelPlacementMapper >	LabelPlacementMapper

vtkSmartPointer< vtkTexturedActor2D >	LabelActor

vtkSmartPointer< vtkHoverWidget >	HoverWidget

vtkSmartPointer< vtkHardwareSelector >	Selector

Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRenderer >	Renderer

vtkSmartPointer< vtkRenderWindow >	RenderWindow

Protected Attributes inherited from vtkView
bool	ReuseSingleRepresentation
	Meant for use by subclasses and vtkRepresentation subclasses. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A view containing a renderer.

vtkRenderView is a view which contains a vtkRenderer. You may add vtkActors directly to the renderer, or add certain vtkDataRepresentation subclasses to the renderer. The render view supports drag selection with the mouse to select cells.

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

Tests:: vtkRenderView (Tests)

Definition at line 61 of file vtkRenderView.h.

Member Typedef Documentation

typedef vtkRenderViewBase vtkRenderView::Superclass

Definition at line 65 of file vtkRenderView.h.

Member Enumeration Documentation

anonymous enum

Enumerator
INTERACTION_MODE_2D
INTERACTION_MODE_3D
INTERACTION_MODE_UNKNOWN

Definition at line 92 of file vtkRenderView.h.

anonymous enum

Enumerator
SURFACE
FRUSTUM

Definition at line 141 of file vtkRenderView.h.

anonymous enum

Enumerator
NO_OVERLAP
ALL

Definition at line 198 of file vtkRenderView.h.

anonymous enum

Enumerator
FREETYPE
QT

Definition at line 220 of file vtkRenderView.h.

Constructor & Destructor Documentation

vtkRenderView::vtkRenderView ( )

protected

vtkRenderView::~vtkRenderView ( )

overrideprotected

Member Function Documentation

static vtkRenderView* vtkRenderView::New ( )

static

static vtkTypeBool vtkRenderView::IsTypeOf ( const char * type )

static

virtual vtkTypeBool vtkRenderView::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 vtkRenderViewBase.

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

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

static

virtual vtkObjectBase* vtkRenderView::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderViewBase.

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

vtkRenderView* vtkRenderView::NewInstance ( ) const

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

overridevirtual

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

Reimplemented in vtkTreeAreaView, vtkTreeRingView, and vtkTreeMapView.

void vtkRenderView::SetInteractor ( vtkRenderWindowInteractor * interactor )

overridevirtual

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

virtual void vtkRenderView::SetInteractorStyle ( vtkInteractorObserver * style )

virtual

The interactor style associated with the render view.

virtual vtkInteractorObserver* vtkRenderView::GetInteractorStyle ( )

virtual

Get the interactor style associated with the render view.

void vtkRenderView::SetRenderWindow ( vtkRenderWindow * win )

overridevirtual

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

void vtkRenderView::SetInteractionMode ( int mode )

virtual int vtkRenderView::GetInteractionMode ( )

virtual

virtual void vtkRenderView::SetInteractionModeTo2D ( )

inlinevirtual

Set the interaction mode for the view.

Choices are: vtkRenderView::INTERACTION_MODE_2D - 2D interactor vtkRenderView::INTERACTION_MODE_3D - 3D interactor

Definition at line 107 of file vtkRenderView.h.

virtual void vtkRenderView::SetInteractionModeTo3D ( )

inlinevirtual

Definition at line 109 of file vtkRenderView.h.

void vtkRenderView::Render ( )

overridevirtual

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

Reimplemented from vtkRenderViewBase.

void vtkRenderView::ApplyViewTheme ( vtkViewTheme * theme )

override

Applies a view theme to this view.

virtual void vtkRenderView::SetTransform ( vtkAbstractTransform * transform )

virtual

Set the view's transform.

All vtkRenderedRepresentations added to this view should use this transform.

virtual vtkAbstractTransform* vtkRenderView::GetTransform ( )

virtual

Set the view's transform.

All vtkRenderedRepresentations added to this view should use this transform.

Reimplemented in vtkGeoView2D.

virtual void vtkRenderView::SetDisplayHoverText ( bool b )

virtual

Whether the view should display hover text.

virtual bool vtkRenderView::GetDisplayHoverText ( )

virtual

Whether the view should display hover text.

virtual void vtkRenderView::DisplayHoverTextOn ( )

virtual

Whether the view should display hover text.

virtual void vtkRenderView::DisplayHoverTextOff ( )

virtual

Whether the view should display hover text.

virtual void vtkRenderView::SetSelectionMode ( int )

virtual

Sets the selection mode for the render view.

SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

virtual int vtkRenderView::GetSelectionMode ( )

virtual

Sets the selection mode for the render view.

SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

void vtkRenderView::SetSelectionModeToSurface ( )

inline

Sets the selection mode for the render view.

SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

Definition at line 156 of file vtkRenderView.h.

void vtkRenderView::SetSelectionModeToFrustum ( )

inline

Sets the selection mode for the render view.

SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

Definition at line 157 of file vtkRenderView.h.

virtual void vtkRenderView::AddLabels ( vtkAlgorithmOutput * conn )

virtual

Add labels from an input connection with an associated text property.

The output must be a vtkLabelHierarchy (normally the output of vtkPointSetToLabelHierarchy).

virtual void vtkRenderView::RemoveLabels ( vtkAlgorithmOutput * conn )

virtual

Remove labels from an input connection.

virtual void vtkRenderView::SetIconTexture ( vtkTexture * texture )

virtual

Set the icon sheet to use for rendering icons.

virtual vtkTexture* vtkRenderView::GetIconTexture ( )

virtual

Set the icon sheet to use for rendering icons.

virtual void vtkRenderView::SetIconSize	(	int	,
		int
	)

virtual