ParaView
pqDisplayPolicy.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqDisplayPolicy.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 #ifndef pqDisplayPolicy_h
33 #define pqDisplayPolicy_h
34 
35 #include "pqCoreModule.h" // Needed for PQCORE_EXPORT macro
36 #include <QObject>
37 
39 class pqOutputPort;
40 class pqPipelineSource;
41 class pqView;
42 class vtkSMProxy;
43 
54 class PQCORE_EXPORT pqDisplayPolicy : public QObject
55 {
56  Q_OBJECT
57  typedef QObject Superclass;
58 
59 public:
60  pqDisplayPolicy(QObject* p);
61  virtual ~pqDisplayPolicy();
62 
71  virtual pqDataRepresentation* setRepresentationVisibility(
72  pqOutputPort* opPort, pqView* view, bool visible) const;
73 
81  virtual QString getPreferredViewType(pqOutputPort* opPort, bool update_pipeline) const;
82 
88  virtual bool getHideByDefault() const { return false; }
89 
91  {
94  NotApplicable
95  };
96 
101  virtual VisibilityState getVisibility(pqView* view, pqOutputPort* port) const;
102 
103 private:
104  Q_DISABLE_COPY(pqDisplayPolicy)
105 };
106 
107 #endif
pqDataRepresentation is the superclass for a display for a pqPipelineSource i.e.
pqOutputPort is a server manager model item for an output port of any pqPipelineSource item...
Definition: pqOutputPort.h:57
Display policy defines the application specific policy for creating display proxies.
This is a PQ abstraction of a generic view module.
Definition: pqView.h:56
virtual bool getHideByDefault() const
Apps can choose whether new filter outputs are hidden upon creation by overriding this method...
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:152
PQ representation for a vtkSMProxy that can be involved in a pipeline.