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

A base view containing a renderer. More...

#include <vtkRenderViewBase.h>

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

Public Types

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...
 
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 vtkRenderWindowInteractorGetInteractor ()
 The render window interactor. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 
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...
 
- 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=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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkRenderViewBaseNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderViewBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkView
static vtkViewNew ()
 
static vtkTypeBool 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 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 ()
 
 ~vtkView () override
 
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))
 
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 ()
 
virtual void ReuseSingleRepresentationOn ()
 
virtual void ReuseSingleRepresentationOff ()
 
- 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 ()
 
- 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< vtkRendererRenderer
 
vtkSmartPointer< vtkRenderWindowRenderWindow
 
- Protected Attributes inherited from vtkView
bool ReuseSingleRepresentation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A base view containing a renderer.

vtkRenderViewBase is a view which contains a vtkRenderer. You may add vtkActors directly to the renderer.

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

Definition at line 41 of file vtkRenderViewBase.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkRenderViewBase.h.

Constructor & Destructor Documentation

◆ vtkRenderViewBase()

vtkRenderViewBase::vtkRenderViewBase ( )
protected

◆ ~vtkRenderViewBase()

vtkRenderViewBase::~vtkRenderViewBase ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRenderViewBase* vtkRenderViewBase::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, vtkContextView, and vtkIcicleView.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderViewBase::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderViewBase* vtkRenderViewBase::NewInstance ( ) const

◆ PrintSelf()

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

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

◆ GetRenderer()

virtual vtkRenderer* vtkRenderViewBase::GetRenderer ( )
virtual

Gets the renderer for this view.

◆ SetRenderer()

virtual void vtkRenderViewBase::SetRenderer ( vtkRenderer ren)
virtual

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkRenderViewBase::GetRenderWindow ( )
virtual

Get a handle to the render window.

◆ SetRenderWindow()

virtual void vtkRenderViewBase::SetRenderWindow ( vtkRenderWindow win)
virtual

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 in vtkRenderView.

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkRenderViewBase::GetInteractor ( )
virtual

The render window interactor.

Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

◆ SetInteractor()

virtual void vtkRenderViewBase::SetInteractor ( vtkRenderWindowInteractor )
virtual

Reimplemented in vtkRenderView.

◆ Render()

virtual void vtkRenderViewBase::Render ( )
virtual

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

Reimplemented in vtkRenderView.

◆ ResetCamera()

virtual void vtkRenderViewBase::ResetCamera ( )
virtual

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

◆ ResetCameraClippingRange()

virtual void vtkRenderViewBase::ResetCameraClippingRange ( )
virtual

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

◆ PrepareForRendering()

virtual void vtkRenderViewBase::PrepareForRendering ( )
protectedvirtual

Called by the view when the renderer is about to render.

Reimplemented in vtkRenderView, and vtkParallelCoordinatesView.

Member Data Documentation

◆ Renderer

vtkSmartPointer<vtkRenderer> vtkRenderViewBase::Renderer
protected

Definition at line 105 of file vtkRenderViewBase.h.

◆ RenderWindow

vtkSmartPointer<vtkRenderWindow> vtkRenderViewBase::RenderWindow
protected

Definition at line 106 of file vtkRenderViewBase.h.


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