provides a view of the vtkContextScene. More...

#include <vtkContextView.h>

Inheritance diagram for vtkContextView:

Collaboration diagram for vtkContextView:

Public Types
typedef vtkRenderViewBase	Superclass

Public Types inherited from vtkRenderViewBase
typedef vtkView	Superclass

Public Types inherited from vtkView
typedef vtkObject	Superclass

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

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

vtkContextView *	NewInstance () const

virtual void	SetContext (vtkContext2D *context)
	Set the vtkContext2D for the view.

virtual vtkContext2D *	GetContext ()
	Get the vtkContext2D for the view.

virtual void	SetScene (vtkContextScene *scene)
	Set the scene object for the view.

virtual vtkContextScene *	GetScene ()
	Get the scene of the view.

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

vtkRenderViewBase *	NewInstance () const

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

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

virtual void	SetRenderer (vtkRenderer *ren)

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

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

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

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

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

virtual vtkRenderWindowInteractor *	GetInteractor ()
	The render window interactor.

virtual void	SetInteractor (vtkRenderWindowInteractor *)
	The render window interactor.

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

vtkView *	NewInstance () const

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

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

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

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

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

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

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

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

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

void	RemoveAllRepresentations ()
	Removes all representations from the view.

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

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

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

virtual void	Update ()
	Update the view.

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

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

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

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

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.

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

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

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkContextView *	SafeDownCast (vtkObjectBase *o)

static vtkContextView *	New ()

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.

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

	vtkContextView ()

	~vtkContextView () override

Protected Member Functions inherited from vtkRenderViewBase
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderViewBase ()

	~vtkRenderViewBase () override

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

Protected Member Functions inherited from vtkView
virtual vtkObjectBase *	NewInstanceInternal () const

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

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

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

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

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

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

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

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

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkContextScene >	Scene

vtkSmartPointer< vtkContext2D >	Context

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.

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

provides a view of the vtkContextScene.

This class is derived from vtkRenderViewBase and provides a view of a vtkContextScene, with a default interactor style, renderer etc. It is the simplest way to create a vtkRenderWindow and display a 2D scene inside of it.

By default the scene has a white background.