VTK  9.3.1
vtkView.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
34#ifndef vtkView_h
35#define vtkView_h
36
37#include "vtkObject.h"
38#include "vtkViewsCoreModule.h" // For export macro
39
40VTK_ABI_NAMESPACE_BEGIN
42class vtkCommand;
43class vtkDataObject;
45class vtkSelection;
46class vtkViewTheme;
47
48class VTKVIEWSCORE_EXPORT vtkView : public vtkObject
49{
50public:
51 static vtkView* New();
52 vtkTypeMacro(vtkView, vtkObject);
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
59
64
74
84
93
102
107
112
117
122
127
132
136 virtual void Update();
137
141 virtual void ApplyViewTheme(vtkViewTheme* vtkNotUsed(theme)) {}
142
149
151
156 {
157 const char* Message;
158 double Progress;
160
161 public:
162 ViewProgressEventCallData(const char* msg, double progress)
163 {
164 this->Message = msg;
165 this->Progress = progress;
166 }
167 ~ViewProgressEventCallData() { this->Message = nullptr; }
168
172 const char* GetProgressMessage() const { return this->Message; }
173
177 double GetProgress() const { return this->Progress; }
178 };
179
189 void RegisterProgress(vtkObject* algorithm, const char* message = nullptr);
190
195
196protected:
198 ~vtkView() override;
199
205 virtual void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData);
206
214
219 virtual void AddRepresentationInternal(vtkDataRepresentation* vtkNotUsed(rep)) {}
220 virtual void RemoveRepresentationInternal(vtkDataRepresentation* vtkNotUsed(rep)) {}
221
223
227 vtkSetMacro(ReuseSingleRepresentation, bool);
228 vtkGetMacro(ReuseSingleRepresentation, bool);
229 vtkBooleanMacro(ReuseSingleRepresentation, bool);
232
233private:
234 vtkView(const vtkView&) = delete;
235 void operator=(const vtkView&) = delete;
236
237 class vtkImplementation;
238 vtkImplementation* Implementation;
239
240 class Command;
241 friend class Command;
242 Command* Observer;
243
244 class vtkInternal;
245 vtkInternal* Internal;
246};
247
248VTK_ABI_NAMESPACE_END
249#endif
Proxy object to connect input/output ports.
superclass for callback/observer methods
Definition vtkCommand.h:384
general representation of visualization data
The superclass for all representations.
a simple class to control print indentation
Definition vtkIndent.h:29
abstract base class for most VTK objects
Definition vtkObject.h:52
data object that represents a "selection" in VTK.
Sets theme colors for a graphical view.
A ptr to an instance of ViewProgressEventCallData is provided in the call data when vtkCommand::ViewP...
Definition vtkView.h:156
double GetProgress() const
Get the progress value in range [0.0, 1.0].
Definition vtkView.h:177
ViewProgressEventCallData(const char *msg, double progress)
Definition vtkView.h:162
const char * GetProgressMessage() const
Get the message.
Definition vtkView.h:172
The superclass for all views.
Definition vtkView.h:49
virtual void ApplyViewTheme(vtkViewTheme *vtkNotUsed(theme))
Apply a theme to the view.
Definition vtkView.h:141
vtkDataRepresentation * SetRepresentationFromInput(vtkDataObject *input)
Convenience method which sets the representation to the specified input 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 ...
void RemoveRepresentation(vtkAlgorithmOutput *rep)
Removes any representation with this connection from the view.
void UnRegisterProgress(vtkObject *algorithm)
Unregister objects previously registered with RegisterProgress.
virtual void Update()
Update the view.
vtkCommand * GetObserver()
Returns the observer that the subclasses can use to listen to additional events.
vtkDataRepresentation * AddRepresentationFromInputConnection(vtkAlgorithmOutput *conn)
Convenience method which creates a simple representation with the connection and adds it to the view.
virtual void AddRepresentationInternal(vtkDataRepresentation *vtkNotUsed(rep))
Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed.
Definition vtkView.h:219
virtual void ProcessEvents(vtkObject *caller, unsigned long eventId, void *callData)
Called to process events.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void RegisterProgress(vtkObject *algorithm, const char *message=nullptr)
Meant for use by subclasses and vtkRepresentation subclasses.
~vtkView() override
Meant for use by subclasses and vtkRepresentation subclasses.
int GetNumberOfRepresentations()
Returns the number of representations from first port(0) in this view.
void RemoveAllRepresentations()
Removes all representations from the view.
vtkDataRepresentation * GetRepresentation(int index=0)
The representation at a specified index.
vtkDataRepresentation * SetRepresentationFromInputConnection(vtkAlgorithmOutput *conn)
Convenience method which sets the representation with the connection and adds it to the view.
vtkView()
Meant for use by subclasses and vtkRepresentation subclasses.
virtual void RemoveRepresentationInternal(vtkDataRepresentation *vtkNotUsed(rep))
Meant for use by subclasses and vtkRepresentation subclasses.
Definition vtkView.h:220
void SetRepresentation(vtkDataRepresentation *rep)
Set the representation to the view.
void RemoveRepresentation(vtkDataRepresentation *rep)
Removes the representation from the view.
bool IsRepresentationPresent(vtkDataRepresentation *rep)
Check to see if a representation is present in the view.
void AddRepresentation(vtkDataRepresentation *rep)
Adds the representation to the view.
virtual vtkDataRepresentation * CreateDefaultRepresentation(vtkAlgorithmOutput *conn)
Create a default vtkDataRepresentation for the given vtkAlgorithmOutput.
bool ReuseSingleRepresentation
Meant for use by subclasses and vtkRepresentation subclasses.
Definition vtkView.h:230
static vtkView * New()