#include <vtkScivisView.h>

Detailed Description

A ready-made rendering assembly for scientific visualization.

Every VTK rendering program builds the same thing by hand: a renderer, a render window, an interactor, an interactor style, a light, an orientation marker, and the wiring between them. vtkScivisView is that assembly, already built. A view you have just created draws something reasonable before you configure anything, and it stays consistent when you replace a piece of it: hand it a render window of your own and the renderers move across, while an interactor style you had installed survives the change.

Getting started:: Create representations, configure them, and add them to the view. Start() enters the interactive event loop.
vtkNew<vtkScivisView> view;

vtkNew<vtkSurfaceRepresentation> rep;

rep->SetInputConnection(source->GetOutputPort());

rep->SetColor(0.8, 0.2, 0.2);

view->AddRepresentation(rep);

view->ResetCamera();

view->Start();

vtkNew
Allocate and hold a VTK object.
Definition vtkNew.h:168

source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition vtkBoostGraphAdapter.h:984

What the view itself owns:

Whatever is true of the scene as a whole.

the background, and the render window and its title
how the scene is lit: a single headlight, or a five light kit
how the user interacts with it, and the orientation axes marker
what is selected in it
framing the camera, bringing every representation up to date, and drawing

: Whatever is true of one thing being drawn – its data, its geometry, its color – belongs to that representation instead. That line is worth remembering, because it is what says where any given piece of API lives.

Reaching further in:

The view is deliberately not a mirror of the objects underneath it. Where you need more than the scene-wide API above, ask it for the object that owns what you are after.

GetRenderer() for lights and props of your own
GetLightKit() for the light rig's intensity, warmth, angle and ratios
GetOrientationMarkerWidget() for the axes marker's viewport and marker
GetSelector() for how a screen region becomes a selection

A family of its own:: This is not a vtkView, and it shows only vtkScivisRepresentations. The information visualization views and representations are a separate family sharing no base class with this one: they drive their own render passes and labelling, and carry annotation links and themes that mean nothing here. Neither family can stand in for the other, and the type system says so rather than a downcast at run time.

See also: vtkScivisRepresentation vtkScivisDataRepresentation vtkScivisSelector vtkSurfaceRepresentation vtkVolumeRepresentation

Examples:: vtkScivisView (Examples)

Tests:: vtkScivisView (Tests)

Definition at line 91 of file vtkScivisView.h.

Inheritance diagram for vtkScivisView:

[legend]

Collaboration diagram for vtkScivisView:

[legend]

Public Types
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.
vtkScivisView *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	The view stores its configuration on the renderer, render window, light kit and orientation marker widget rather than in its own ivars, so the modified time reported here is the latest of this object's own and theirs.
vtkOrientationMarkerWidget *	GetOrientationMarkerWidget ()
	The orientation marker widget itself, for its viewport, its marker, and whether the user can move and resize it.
vtkLightKit *	GetLightKit ()
	The light kit itself, for its intensity, warmth, angle and ratio parameters.
vtkScivisSelector *	GetSelector ()
	Selection: how a screen region becomes a selection, whether points or cells come back, and what was picked last.
void	Start ()
virtual void	Render ()
	Bring every representation up to date and draw.
virtual void	ResetCamera ()
	Frame the camera on everything the representations are drawing.
virtual void	Update ()
	Bring every representation up to date without drawing.

void	AddRepresentation (vtkScivisRepresentation *rep)
	The representations this view shows.
void	SetRepresentation (vtkScivisRepresentation *rep)
	The representations this view shows.
void	RemoveRepresentation (vtkScivisRepresentation *rep)
	The representations this view shows.
void	RemoveAllRepresentations ()
	The representations this view shows.
int	GetNumberOfRepresentations ()
	The representations this view shows.
vtkScivisRepresentation *	GetRepresentation (int index=0)
	The representations this view shows.
bool	IsRepresentationPresent (vtkScivisRepresentation *rep)
	The representations this view shows.

vtkRenderer *	GetRenderer ()
	The renderer, render window and interactor this view draws with.
void	SetRenderer (vtkRenderer *renderer)
	The renderer, render window and interactor this view draws with.
vtkRenderWindow *	GetRenderWindow ()
	The renderer, render window and interactor this view draws with.
void	SetRenderWindow (vtkRenderWindow *window)
	The renderer, render window and interactor this view draws with.
vtkRenderWindowInteractor *	GetInteractor ()
	The renderer, render window and interactor this view draws with.
void	SetInteractor (vtkRenderWindowInteractor *interactor)
	The renderer, render window and interactor this view draws with.

void	SetBackground (double r, double g, double b)
	Set/Get the background color of the renderer.
double *	GetBackground ()
	Set/Get the background color of the renderer.
void	SetBackground2 (double r, double g, double b)
	Set/Get the background color of the renderer.
double *	GetBackground2 ()
	Set/Get the background color of the renderer.
void	SetGradientBackground (bool val)
	Set/Get the background color of the renderer.
bool	GetGradientBackground ()
	Set/Get the background color of the renderer.

void	SetWindowSize (int w, int h)
	Set/Get the render window size and title.
int *	GetWindowSize ()
	Set/Get the render window size and title.
void	SetWindowTitle (const char *title)
	Set/Get the render window size and title.
const char *	GetWindowTitle ()
	Set/Get the render window size and title.

void	SetOrientationAxesVisibility (bool val)
	Show or hide the orientation axes marker in the lower-left corner of the render window.
bool	GetOrientationAxesVisibility ()
	Show or hide the orientation axes marker in the lower-left corner of the render window.

void	SetUseLightKit (bool val)
	Enable or disable the light kit: a five light rig – key, fill, headlight and two back lights – managed by vtkLightKit.
bool	GetUseLightKit ()
	Enable or disable the light kit: a five light rig – key, fill, headlight and two back lights – managed by vtkLightKit.

void	SetInteractorStyle (vtkInteractorObserver *style)
	Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.
vtkInteractorObserver *	GetInteractorStyle ()
	Install an interactor style of your own, for interaction the built-in modes do not cover – a 2D or terrain camera, or a vtkInteractorStyleManipulator configured with your own button bindings.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkScivisView *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkScivisView *	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScivisView ()
	~vtkScivisView () override
virtual void	PrepareForRendering ()
	Called before every render, once the representations are up to date.
vtkCommand *	GetObserver ()
	The observer this view listens through.
virtual void	ProcessEvents (vtkObject caller, unsigned long eventId, void callData)
	Called for every event the view is observing.

virtual void	AddRepresentationInternal (vtkScivisRepresentation *rep)
	Hooks for subclasses, called after a representation has been accepted or before one is dropped.
virtual void	RemoveRepresentationInternal (vtkScivisRepresentation *rep)
	Hooks for subclasses, called after a representation has been accepted or before one is dropped.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkRenderer >	Renderer
vtkSmartPointer< vtkRenderWindow >	RenderWindow
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	Command
enum	{ INTERACTION_MODE_3D = 0 , INTERACTION_MODE_SELECTION = 1 , INTERACTION_MODE_CUSTOM = 2 }
	Interaction mode constants. More...
void	SetInteractionMode (int mode)
	Interaction mode constants.
int	GetInteractionMode ()
	Interaction mode constants.
void	SetInteractionModeTo3D ()
	Interaction mode constants.
void	SetInteractionModeToSelection ()
	Interaction mode constants.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkScivisView::Superclass

Definition at line 95 of file vtkScivisView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Interaction mode constants.

INTERACTION_MODE_3D uses vtkInteractorStyleTrackballCamera (default). INTERACTION_MODE_SELECTION uses vtkInteractorStyleRubberBand3D for rubber-band selection. Mode switching is programmatic; applications typically expose it through a toolbar or keyboard shortcut. INTERACTION_MODE_CUSTOM reports that a style supplied through SetInteractorStyle() is installed; it cannot be selected directly.

The view owns one instance of each built-in style and switches between them, so any configuration applied to a style survives a mode change.

Enumerator
INTERACTION_MODE_3D
INTERACTION_MODE_SELECTION
INTERACTION_MODE_CUSTOM

Definition at line 216 of file vtkScivisView.h.

Constructor & Destructor Documentation

◆ vtkScivisView()

vtkScivisView::vtkScivisView ( )

protected

◆ ~vtkScivisView()

vtkScivisView::~vtkScivisView ( )

overrideprotected

Member Function Documentation

◆ New()

vtkScivisView * vtkScivisView::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkScivisView::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkScivisView::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 vtkObjectBase.

◆ SafeDownCast()

vtkScivisView * vtkScivisView::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkScivisView::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkScivisView * vtkScivisView::NewInstance ( ) const

◆ PrintSelf()

void vtkScivisView::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 vtkObject.

◆ GetMTime()

vtkMTimeType vtkScivisView::GetMTime ( )

overridevirtual

The view stores its configuration on the renderer, render window, light kit and orientation marker widget rather than in its own ivars, so the modified time reported here is the latest of this object's own and theirs.

Note that this makes the view report scene changes too, since adding or removing a representation modifies the renderer.

Reimplemented from vtkObject.