PanelDisplay.h

Classes

PanelDisplay -- A class which creates and manages "panelled" displays. (full description)

class PanelDisplay : public MultiWCHolder, public DisplayOptions

Types

enum FillOrder

LEFT_TOP
left to right, then top to bottom

Interface

Public Members

PanelDisplay(PixelCanvas* pixelcanvas, const Int nx = 3, const Int ny = 2, const Float xOrigin = 0.0, const Float yOrigin = 0.0, const Float xSize = 1.0, const Float ySize = 1.0, const Float dx = 0.0, const Float dy = 0.0, const PanelDisplay::FillOrder order = LEFT_TOP)

virtual ~PanelDisplay()

virtual void setDefaultOptions()

virtual Bool setOptions(const Record& rec, Record& updatedOptions)

virtual Record getOptions() const

virtual void setAttributes(AttributeBuffer& at)

virtual void getAttributeValue(const String& name, Int& newValue) const

virtual void getGeometry(Int& nx, Int& ny, Float& xOrigin, Float& yOrigin, Float& xSize, Float& ySize, Float& dx, Float& dy, PanelDisplay::FillOrder& order) const

virtual void getGeometry(RecordInterface& rec) const

virtual void setGeometry(const Int nx, const Int ny, const Float xOrigin, const Float yOrigin, const Float xSize, const Float ySize, const Float dx, const Float dy, const PanelDisplay::FillOrder order)

virtual void setGeometry(const RecordInterface& rec)

virtual WorldCanvasHolder* wcHolder(WorldCanvas* wc) const

virtual PixelCanvas* pixelCanvas()

virtual void addTool(const String& key, MultiWCTool* value)

virtual void removeTool(const String& key)

virtual void setToolKey(const String& toolname, const Display::KeySym& keysym)

virtual Bool hasTools()

virtual void updateTools(Bool remove = True, Bool add = True)

virtual void disableTools()

virtual void enableTools()

virtual ListIter<WorldCanvas* >* wcs()

virtual Bool isCSmaster(const DisplayData *dd) const

Private Members

void unSetupGeometry()

Description

Review Status

Date Reviewed:: yyyy/mm/dd

Prerequisite

Etymology

The PanelDisplay class provides a display consisting of a number of panels.

Synopsis

This class uses the MultiWCHolder class to provide a regular set of panels for display multi-view DisplayDatas.

Example

Motivation

Member Description

enum FillOrder

PanelDisplay(PixelCanvas* pixelcanvas, const Int nx = 3, const Int ny = 2, const Float xOrigin = 0.0, const Float yOrigin = 0.0, const Float xSize = 1.0, const Float ySize = 1.0, const Float dx = 0.0, const Float dy = 0.0, const PanelDisplay::FillOrder order = LEFT_TOP)

Constructor taking: a pointer to the PixelCanvas on which to lay the panels, the number of panels in the x and y directions, the extent of the PixelCanvas to cover with panels, and the fractional spacing between the panels.

virtual ~PanelDisplay()

Destructor.