A base view containing a renderer. More...
#include <vtkRenderViewBase.h>
Inheritance diagram for vtkRenderViewBase:
Collaboration diagram for vtkRenderViewBase:
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... | |
| vtkRenderViewBase * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| 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 | 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 vtkRenderWindowInteractor * | GetInteractor () |
| The render window interactor. More... | |
| virtual void | SetInteractor (vtkRenderWindowInteractor *) |
| The render window interactor. More... | |
| Public Member Functions inherited from vtkView | |
| vtkView * | NewInstance () 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... | |
| 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 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 |
| 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 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 | |
| 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 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
| typedef vtkView vtkRenderViewBase::Superclass |
Definition at line 45 of file vtkRenderViewBase.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
static |
|
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 vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, vtkContextView, and vtkIcicleView.
|
static |
|
protectedvirtual |
Reimplemented from vtkView.
Reimplemented in vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, vtkContextView, and vtkIcicleView.
| vtkRenderViewBase* vtkRenderViewBase::NewInstance | ( | ) | const |
|
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 vtkGeoView, vtkRenderView, vtkGraphLayoutView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, vtkGeoView2D, vtkTreeAreaView, vtkTreeRingView, vtkTreeMapView, and vtkIcicleView.
|
virtual |
Gets the renderer for this view.
|
virtual |
|
virtual |
Get a handle to the render window.
|
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.
|
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.
|
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.
Reimplemented in vtkRenderView.
|
virtual |
Updates the representations, then calls Render() on the render window associated with this view.
Reimplemented in vtkGeoView, vtkRenderView, and vtkGeoView2D.
|
virtual |
Updates the representations, then calls ResetCamera() on the renderer associated with this view.
|
virtual |
Updates the representations, then calls ResetCameraClippingRange() on the renderer associated with this view.
|
protectedvirtual |
Called by the view when the renderer is about to render.
Reimplemented in vtkRenderView, vtkParallelCoordinatesView, vtkGeoView2D, and vtkGeoView.
Member Data Documentation
|
protected |
Definition at line 105 of file vtkRenderViewBase.h.
|
protected |
Definition at line 106 of file vtkRenderViewBase.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Views/Core/vtkRenderViewBase.h
