VTK  9.0.20210801
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkView Class Reference

The superclass for all views. More...

#include <vtkView.h>

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

Classes

class  ViewProgressEventCallData
 A ptr to an instance of ViewProgressEventCallData is provided in the call data when vtkCommand::ViewProgressEvent is fired. More...
 

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. More...
 
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...
 
- 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...
 
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...
 
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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 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 ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class Command
 
bool ReuseSingleRepresentation
 Meant for use by subclasses and vtkRepresentation subclasses. 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...
 
 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...
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

The superclass for all views.

vtkView is the superclass for views. A view is generally an area of an application's canvas devoted to displaying one or more VTK data objects. Associated representations (subclasses of vtkDataRepresentation) are responsible for converting the data into a displayable format. These representations are then added to the view.

For views which display only one data object at a time you may set a data object or pipeline connection directly on the view itself (e.g. vtkGraphLayoutView, vtkLandscapeView, vtkTreeMapView). The view will internally create a vtkDataRepresentation for the data.

A view has the concept of linked selection. If the same data is displayed in multiple views, their selections may be linked by setting the same vtkAnnotationLink on their representations (see vtkDataRepresentation).

Events:
vtkCommand::ViewProgressEvent
Examples:
vtkView (Examples)
Tests:
vtkView (Tests)

Definition at line 63 of file vtkView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 67 of file vtkView.h.

Constructor & Destructor Documentation

◆ vtkView()

vtkView::vtkView ( )
protected

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

◆ ~vtkView()

vtkView::~vtkView ( )
overrideprotected

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

Member Function Documentation

◆ New()

static vtkView* vtkView::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkQtView, vtkQtTreeView, vtkQtTableView, vtkQtRecordView, vtkQtListView, vtkQtAnnotationView, vtkTreeRingView, vtkTreeMapView, vtkTreeAreaView, vtkRenderView, vtkParallelCoordinatesView, vtkIcicleView, vtkHierarchicalGraphView, vtkGraphLayoutView, vtkRenderViewBase, and vtkContextView.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkView::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkView* vtkView::NewInstance ( ) const

◆ PrintSelf()

void vtkView::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 vtkQtView, vtkQtTreeView, vtkQtTableView, vtkQtRecordView, vtkQtListView, vtkQtAnnotationView, vtkTreeRingView, vtkTreeMapView, vtkTreeAreaView, vtkRenderView, vtkParallelCoordinatesView, vtkIcicleView, vtkHierarchicalGraphView, and vtkGraphLayoutView.

◆ AddRepresentation()

void vtkView::AddRepresentation ( vtkDataRepresentation rep)

Adds the representation to the view.

◆ SetRepresentation()

void vtkView::SetRepresentation ( vtkDataRepresentation rep)

Set the representation to the view.

◆ AddRepresentationFromInputConnection()

vtkDataRepresentation* vtkView::AddRepresentationFromInputConnection ( vtkAlgorithmOutput conn)

Convenience method which creates a simple representation with the connection and adds it to the view.

Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

◆ SetRepresentationFromInputConnection()

vtkDataRepresentation* vtkView::SetRepresentationFromInputConnection ( vtkAlgorithmOutput conn)

Convenience method which sets the representation with the connection and adds it to the view.

Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

◆ AddRepresentationFromInput()

vtkDataRepresentation* vtkView::AddRepresentationFromInput ( vtkDataObject input)

Convenience method which creates a simple representation with the specified input and adds it to the view.

NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

◆ SetRepresentationFromInput()

vtkDataRepresentation* vtkView::SetRepresentationFromInput ( vtkDataObject input)

Convenience method which sets the representation to the specified input and adds it to the view.

NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

◆ RemoveRepresentation() [1/2]

void vtkView::RemoveRepresentation ( vtkDataRepresentation rep)

Removes the representation from the view.

◆ RemoveRepresentation() [2/2]

void vtkView::RemoveRepresentation ( vtkAlgorithmOutput rep)

Removes any representation with this connection from the view.

◆ RemoveAllRepresentations()

void vtkView::RemoveAllRepresentations ( )

Removes all representations from the view.

◆ GetNumberOfRepresentations()

int vtkView::GetNumberOfRepresentations ( )

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

◆ GetRepresentation()

vtkDataRepresentation* vtkView::GetRepresentation ( int  index = 0)

The representation at a specified index.

◆ IsRepresentationPresent()

bool vtkView::IsRepresentationPresent ( vtkDataRepresentation rep)

Check to see if a representation is present in the view.

◆ Update()

virtual void vtkView::Update ( )
virtual

◆ ApplyViewTheme()

virtual void vtkView::ApplyViewTheme ( vtkViewTheme vtkNotUsedtheme)
inlinevirtual

Apply a theme to the view.

Definition at line 156 of file vtkView.h.

◆ GetObserver()

vtkCommand* vtkView::GetObserver ( )

Returns the observer that the subclasses can use to listen to additional events.

Additionally these subclasses should override ProcessEvents() to handle these events.

◆ RegisterProgress()

void vtkView::RegisterProgress ( vtkObject algorithm,
const char *  message = nullptr 
)

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

◆ UnRegisterProgress()

void vtkView::UnRegisterProgress ( vtkObject algorithm)

Unregister objects previously registered with RegisterProgress.

◆ ProcessEvents()

virtual void vtkView::ProcessEvents ( vtkObject caller,
unsigned long  eventId,
void *  callData 
)
protectedvirtual

Called to process events.

The superclass processes selection changed events from its representations. This may be overridden by subclasses to process additional events.

Reimplemented in vtkRenderView, vtkGraphLayoutView, and vtkParallelCoordinatesView.

◆ CreateDefaultRepresentation()

virtual vtkDataRepresentation* vtkView::CreateDefaultRepresentation ( vtkAlgorithmOutput conn)
protectedvirtual

Create a default vtkDataRepresentation for the given vtkAlgorithmOutput.

View subclasses may override this method to create custom representations. This method is called by Add/SetRepresentationFromInputConnection. NOTE, the caller must delete the returned vtkDataRepresentation.

Reimplemented in vtkTreeAreaView, vtkParallelCoordinatesView, vtkHierarchicalGraphView, and vtkGraphLayoutView.

◆ AddRepresentationInternal()

virtual void vtkView::AddRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep)
inlineprotectedvirtual

Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.

Override these methods to perform custom actions.

Definition at line 234 of file vtkView.h.

◆ RemoveRepresentationInternal()

virtual void vtkView::RemoveRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep)
inlineprotectedvirtual

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

Definition at line 235 of file vtkView.h.

◆ SetReuseSingleRepresentation()

virtual void vtkView::SetReuseSingleRepresentation ( bool  )
protectedvirtual

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

Default is off.

◆ GetReuseSingleRepresentation()

virtual bool vtkView::GetReuseSingleRepresentation ( )
protectedvirtual

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

◆ ReuseSingleRepresentationOn()

virtual void vtkView::ReuseSingleRepresentationOn ( )
protectedvirtual

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

◆ ReuseSingleRepresentationOff()

virtual void vtkView::ReuseSingleRepresentationOff ( )
protectedvirtual

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

Friends And Related Function Documentation

◆ Command

friend class Command
friend

Definition at line 256 of file vtkView.h.

Member Data Documentation

◆ ReuseSingleRepresentation

bool vtkView::ReuseSingleRepresentation
protected

Meant for use by subclasses and vtkRepresentation subclasses.

Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

Definition at line 245 of file vtkView.h.


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