ParaView
Public Types | Public Member Functions | List of all members
pqDisplayPolicy Class Reference

Display policy defines the application specific policy for creating display proxies. More...

#include <pqDisplayPolicy.h>

Inherits QObject.

Public Types

enum  VisibilityState { Visible, Hidden, NotApplicable }
 

Public Member Functions

 pqDisplayPolicy (QObject *p)
 
virtual ~pqDisplayPolicy ()
 
virtual pqDataRepresentationsetRepresentationVisibility (pqOutputPort *opPort, pqView *view, bool visible) const
 Set the visibility of the source in the given view. More...
 
virtual QString getPreferredViewType (pqOutputPort *opPort, bool update_pipeline) const
 Returns the type for the view that is indicated as the preferred view for the given output port. More...
 
virtual bool getHideByDefault () const
 Apps can choose whether new filter outputs are hidden upon creation by overriding this method. More...
 
virtual VisibilityState getVisibility (pqView *view, pqOutputPort *port) const
 Returns the visibility state for port in the given view (view may be null for an empty view). More...
 

Detailed Description

Display policy defines the application specific policy for creating display proxies.

Given a pair of a proxy to be displayed and a view proxy in which to display, this class must tell the type of display to create, if any. Custom applications can subclass this to define their own policy. The pqApplicationCore maintains an instance of the policy used by the application. Custom applications should set their own policy instance on the global application core instance.

Definition at line 52 of file pqDisplayPolicy.h.

Member Enumeration Documentation

§ VisibilityState

Enumerator
Visible 
Hidden 
NotApplicable 

Definition at line 83 of file pqDisplayPolicy.h.

Constructor & Destructor Documentation

§ pqDisplayPolicy()

pqDisplayPolicy::pqDisplayPolicy ( QObject *  p)

§ ~pqDisplayPolicy()

virtual pqDisplayPolicy::~pqDisplayPolicy ( )
virtual

Member Function Documentation

§ setRepresentationVisibility()

virtual pqDataRepresentation* pqDisplayPolicy::setRepresentationVisibility ( pqOutputPort opPort,
pqView view,
bool  visible 
) const
virtual

Set the visibility of the source in the given view.

Current implementation creates a new display for the source, if possible, if none exists. If view is NULL, then a new view of "suitable" type will be created for the source. Since custom applications may not necessarily create new views, we provide this as part of display policy which can be easily overridden by creating a new subclass.

§ getPreferredViewType()

virtual QString pqDisplayPolicy::getPreferredViewType ( pqOutputPort opPort,
bool  update_pipeline 
) const
virtual

Returns the type for the view that is indicated as the preferred view for the given output port.

May return a null string if the no view type can be determined as the preferred view. If update_pipeline is set, then the pipeline will be update prior to fetching the data information from the port.

§ getHideByDefault()

virtual bool pqDisplayPolicy::getHideByDefault ( ) const
inlinevirtual

Apps can choose whether new filter outputs are hidden upon creation by overriding this method.

The default behavior is to create a representation such that it obeys to the Visibility from rendering.xml.

Definition at line 79 of file pqDisplayPolicy.h.

§ getVisibility()

virtual VisibilityState pqDisplayPolicy::getVisibility ( pqView view,
pqOutputPort port 
) const
virtual

Returns the visibility state for port in the given view (view may be null for an empty view).


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