VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkContextView Class Reference

provides a view of the vtkContextScene. More...

#include <vtkContextView.h>

Inheritance diagram for vtkContextView:
[legend]
Collaboration diagram for vtkContextView:
[legend]

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. More...
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkContextViewNewInstance () const
 
virtual void SetContext (vtkContext2D *context)
 Set the vtkContext2D for the view. More...
 
virtual vtkContext2DGetContext ()
 Get the vtkContext2D for the view. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the scene object for the view. More...
 
virtual vtkContextSceneGetScene ()
 Get the scene of the view. More...
 
- Public Member Functions inherited from vtkRenderViewBase
vtkRenderViewBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRendererGetRenderer ()
 Gets the renderer for this view. More...
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderWindowGetRenderWindow ()
 Get a handle to the render window. More...
 
virtual void SetRenderWindow (vtkRenderWindow *win)
 Set the render window for this view. More...
 
virtual void Render ()
 Updates the representations, then calls Render() on the render window associated with this view. 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 vtkRenderWindowInteractorGetInteractor ()
 The render window interactor. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 The render window interactor. More...
 
- Public Member Functions inherited from vtkView
vtkViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddRepresentation (vtkDataRepresentation *rep)
 Adds the representation to the view. More...
 
void SetRepresentation (vtkDataRepresentation *rep)
 Set the representation to the view. More...
 
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which creates a simple representation with the connection and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
 Convenience method which sets the representation with the connection and adds it to the view. More...
 
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
 Convenience method which creates a simple representation with the specified input and adds it to the view. More...
 
vtkDataRepresentationSetRepresentationFromInput (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...
 
vtkDataRepresentationGetRepresentation (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...
 
vtkCommandGetObserver ()
 Returns the observer that the subclasses can use to listen to additional events. More...
 
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 int IsTypeOf (const char *type)
 
static vtkContextViewSafeDownCast (vtkObjectBase *o)
 
static vtkContextViewNew ()
 
- Static Public Member Functions inherited from vtkRenderViewBase
static vtkRenderViewBaseNew ()
 
static int IsTypeOf (const char *type)
 
static vtkRenderViewBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkViewSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkContextView ()
 
 ~vtkContextView () override
 
- Protected Member Functions inherited from vtkRenderViewBase
 vtkRenderViewBase ()
 
 ~vtkRenderViewBase () override
 
virtual void PrepareForRendering ()
 Called by the view when the renderer is about to render. More...
 
- 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 void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Called to process events. More...
 
virtual vtkDataRepresentationCreateDefaultRepresentation (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=NULL)
 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

vtkSmartPointer< vtkContextSceneScene
 
vtkSmartPointer< vtkContext2DContext
 
- Protected Attributes inherited from vtkRenderViewBase
vtkSmartPointer< vtkRendererRenderer
 
vtkSmartPointer< vtkRenderWindowRenderWindow
 
- 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

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.

Examples:
vtkContextView (Examples)
Tests:
vtkContextView (Tests)

Definition at line 44 of file vtkContextView.h.

Member Typedef Documentation

Definition at line 48 of file vtkContextView.h.

Constructor & Destructor Documentation

vtkContextView::vtkContextView ( )
protected
vtkContextView::~vtkContextView ( )
overrideprotected

Member Function Documentation

void vtkContextView::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.

static int vtkContextView::IsTypeOf ( const char *  type)
static
virtual int vtkContextView::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.

static vtkContextView* vtkContextView::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkContextView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderViewBase.

vtkContextView* vtkContextView::NewInstance ( ) const
static vtkContextView* vtkContextView::New ( )
static
virtual void vtkContextView::SetContext ( vtkContext2D context)
virtual

Set the vtkContext2D for the view.

virtual vtkContext2D* vtkContextView::GetContext ( )
virtual

Get the vtkContext2D for the view.

virtual void vtkContextView::SetScene ( vtkContextScene scene)
virtual

Set the scene object for the view.

virtual vtkContextScene* vtkContextView::GetScene ( )
virtual

Get the scene of the view.

Member Data Documentation

vtkSmartPointer<vtkContextScene> vtkContextView::Scene
protected

Definition at line 76 of file vtkContextView.h.

vtkSmartPointer<vtkContext2D> vtkContextView::Context
protected

Definition at line 77 of file vtkContextView.h.


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