Summary Panels

From ParaQ Wiki
Revision as of 15:05, 1 September 2011 by Kyle.lutz (talk | contribs)
Jump to navigationJump to search

Overview

Summary Panels are a new feature for ParaView 4.0. These new panels will be a part of the object inspector and show a subset of filter/representation properties to the user.

Motivation

The main motivation for adding summary panels is to reduce the amount of unnecessary information presented to the user during normal ParaView operation.

See Summit_May_24,_2011 for more information about the motivations for ParaView 4.0 features.

Screen Shots

Sphere-summary-panel.png Wavelet-contour-summary.png Surface-lic-summary.png Plot-summary.png

Panel from XML Hints

Panels may be auto-generated from XML hints. In order to mark a property to be included in the summary panel add the <ShowInSummaryPanel/> hint to its hints in the XML.

<DoubleVectorProperty
         name="Center"
         command="SetCenter"
         number_of_elements="3"
         animateable="1"
         default_values="0.0 0.0 0.0" >
  <DoubleRangeDomain name="range"/>
  <Documentation>
    This property specifies the center of the box.
  </Documentation>
  <Hints>
    <ShowInSummaryPanel/>
  </Hints>
</DoubleVectorProperty>

Custom Panels

Plugins that add filters and representations may create their own custom summary panels. They can do this by creating their own widgets which can then be inserted into the summary panel by using the ADD_PARAVIEW_SUMMARY_DISPLAY_PANEL() cmake function.

Here is an example from the SurfaceLIC plugin:

ADD_PARAVIEW_SUMMARY_DISPLAY_PANEL(
    IFACES
    IFACE_SRCS
    "representations, GeometryRepresentation, Surface LIC;"
    pqSurfaceLICSummaryDisplayPanel
)