1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*****************************************************************************
*
* Copyright (c) 2000 - 2017, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is part of VisIt. For details, see https://visit.llnl.gov/. The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the disclaimer (as noted below) in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the LLNS/LLNL nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL LAWRENCE LIVERMORE NATIONAL SECURITY,
* LLC, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/
// ************************************************************************* //
// OperatorPluginInfo.h //
// ************************************************************************* //
#ifndef OPERATOR_PLUGIN_INFO_H
#define OPERATOR_PLUGIN_INFO_H
#include <plugin_exports.h>
#include <plugin_vartypes.h>
#include <plugin_entry_point.h>
#include <stdio.h>
// Forward declarations.
class AttributeSubject;
class QvisNotepadArea;
class QvisPostableWindowObserver;
class QvisWizard;
class QWidget;
class QString;
class avtPlotMetaData;
class avtPluginFilter;
class avtDatabaseMetaData;
class ViewerPlot;
class ExpressionList;
#include <vector>
#include <string>
// ****************************************************************************
// Class: *OperatorPluginInfo
//
// Purpose:
// Four classes that provide all the information about an operator plugin.
// The information is broken up into four classes relevant to the gui, the
// viewer, the engine, or all three.
//
// Programmer: Jeremy Meredith
// Creation: July 25, 2001
//
// Modifications:
// Jeremy Meredith, Fri Sep 28 13:31:21 PDT 2001
// Added Common info. Made the specific ones inherit from the generic ones.
//
// Brad Whitlock, Thu Jul 26 12:52:12 PDT 2001
// Added scripting plugins.
//
// Brad Whitlock, Mon May 6 14:18:15 PST 2002
// I added the SetDefaults method for scripting plugins.
//
// Brad Whitlock, Wed Mar 12 14:14:57 PST 2003
// I added the XPMIconData method for GUI and Viewer plugins.
//
// Brad Whitlock, Thu Apr 10 13:14:52 PST 2003
// I added Removeable, Moveable, and AllowsSubsequentOperators.
//
// Kathleen Bonnell, Thu Sep 11 10:18:54 PDT 2003
// I added a bool argument to InitializeOperatorAtts.
//
// Jeremy Meredith, Wed Nov 5 10:28:29 PST 2003
// Added ability to disable plugins by default.
//
// Brad Whitlock, Tue Dec 14 09:44:04 PDT 2004
// Added support for operator wizards.
//
// Hank Childs, Tue Mar 22 16:06:15 PST 2005
// Made destructor virtual.
//
// Brad Whitlock, Thu Jan 5 14:40:42 PST 2006
// I removed explicit support for logging from the scripting plugins.
//
// Brad Whitlock, Tue Apr 25 16:46:49 PST 2006
// Added new methods to the operator plugin that allow it to control
// the types of variables that the GUI puts in the variable list.
//
// Jeremy Meredith, Mon Feb 18 17:44:40 EST 2008
// Added way for operators to create new variables. The expression
// definition is intended for intialization; the filter should override
// the actual values of the variable.
//
// Brad Whitlock, Fri Apr 25 10:11:20 PDT 2008
// Made GetMenuName in the GUI info return QString so we can
// internationalize plot names. Added const to strings returned from
// GeneralOperatorPluginInfo.
//
// Brad Whitlock, Thu Feb 4 16:04:19 PST 2010
// I added a GetCategoryName method.
//
// Rob Sisneros, Sun Aug 29 20:13:10 CDT 2010
// Add infrastructure for operators to create variables.
//
// Hank Childs, Tue Aug 31 10:20:08 PDT 2010
// Remove unused method GetCreateVariables.
//
// Hank Childs, Thu Dec 30 12:15:39 PST 2010
// Add the ability to create expressions based on scalars, vectors, or
// tensors.
//
// Brad Whitlock, Wed Sep 17 12:22:21 PDT 2014
// Added common base class for viewer/engine plugins.
//
// Burlen Loring, Thu Oct 8 14:31:15 PDT 2015
// clean up a few compiler warnings
//
// ****************************************************************************
class PLUGIN_API GeneralOperatorPluginInfo
{
public:
virtual ~GeneralOperatorPluginInfo() {;};
virtual const char *GetName() const = 0;
virtual const char *GetVersion() const = 0;
virtual const char *GetID() const = 0;
virtual bool EnabledByDefault() const { return true; }
virtual const char *GetCategoryName() const { return ""; }
};
class PLUGIN_API CommonOperatorPluginInfo : public virtual GeneralOperatorPluginInfo
{
public:
virtual AttributeSubject *AllocAttributes() = 0;
virtual void CopyAttributes(AttributeSubject *to,
AttributeSubject *from) = 0;
virtual ExpressionList *GetCreatedExpressions(const avtDatabaseMetaData *) {return NULL;}
virtual bool GetUserSelectable() const { return true; }
virtual int GetVariableTypes() const { return 0; }
virtual int GetVariableMask() const { return ~0; }
};
class PLUGIN_API GUIOperatorPluginInfo : public virtual CommonOperatorPluginInfo
{
public:
virtual QString *GetMenuName() const = 0;
virtual QvisPostableWindowObserver *CreatePluginWindow(int type,
AttributeSubject *attr, const QString &caption, const QString &shortName,
QvisNotepadArea *notepad) = 0;
virtual QvisWizard *CreatePluginWizard(AttributeSubject *,
QWidget *, const char * = 0)
{
return 0;
}
virtual const char **XPMIconData() const { return 0; }
};
class PLUGIN_API ViewerEngineOperatorPluginInfo : public virtual CommonOperatorPluginInfo
{
public:
virtual AttributeSubject *GetClientAtts() = 0;
virtual AttributeSubject *GetDefaultAtts() = 0;
virtual void SetClientAtts(AttributeSubject *atts) = 0;
virtual void GetClientAtts(AttributeSubject *atts) = 0;
virtual void GetClientAtts(AttributeSubject *atts,
const bool, const bool)
{ GetClientAtts(atts); };
virtual void InitializeOperatorAtts(AttributeSubject *atts,
const avtPlotMetaData &plot,
const bool fromDefault) = 0;
virtual void UpdateOperatorAtts(AttributeSubject *atts,
const avtPlotMetaData &plot) = 0;
virtual std::string GetOperatorVarDescription(AttributeSubject *,
const avtPlotMetaData &)
{ return std::string(); }
virtual const char *GetMenuName() const = 0;
virtual bool Removeable() const { return true; }
virtual bool Moveable() const { return true; }
virtual bool AllowsSubsequentOperators() const { return true; }
};
class PLUGIN_API ViewerOperatorPluginInfo : public virtual ViewerEngineOperatorPluginInfo
{
public:
virtual const char **XPMIconData() const { return 0; }
};
class PLUGIN_API EngineOperatorPluginInfo : public virtual ViewerEngineOperatorPluginInfo
{
public:
virtual avtPluginFilter *AllocAvtPluginFilter() = 0;
};
class PLUGIN_API ScriptingOperatorPluginInfo : public virtual CommonOperatorPluginInfo
{
public:
virtual void InitializePlugin(AttributeSubject *subj, void *data) = 0;
virtual void *GetMethodTable(int *nMethods) = 0;
virtual char *GetLogString() = 0;
virtual bool TypesMatch(void *) { return false; }
virtual void SetDefaults(const AttributeSubject *) = 0;
};
#endif
|
