Imagine::EmbeddedViewer Class Reference

#include <Viewer.h>

Inheritance diagram for Imagine::EmbeddedViewer:

[legend]Collaboration diagram for Imagine::EmbeddedViewer:

[legend]List of all members.

Public Member Functions
boost::shared_ptr< Evue_Connection >	openConnection ()
ViewWindow &	createViewerOnPart (Eeml_Part viewer_part, Eeml_Part frame_part)
ViewWindow &	viewWindow ()
void	setVirtualRoam (bool)
void	setStatusBar (bool)
ViewLayer &	openImageLayer (std::string const &data_filename)
ViewLayer &	openVectorLayer (std::string const &data_filename)
boost::shared_ptr< Evue_Connection >	connection ()
void	closeConnection ()
Protected Member Functions
Imp const *	imp () const
	return reference to internal state object
Imp *	imp ()

---

Detailed Description

Viewer intended to be embedded in an application. There is no communication via pipes with the Session Manager to a separate Viewer application.

Note:

... at least as far as I know.

---

Member Function Documentation

void Imagine::Viewer::closeConnection (   )  [inherited]

close a viewer connection Imagine::ErrorReportException Problem closing a viewer connection

boost::shared_ptr<Evue_Connection> Imagine::Viewer::connection (   )  [inherited]

return the current viewer connection Note: boost::shared<Evue_Connection> because we make use of a deleter function that automatically insures that the connection is released when the last referring shared pointer is destroyed. Returns: the current viewer connection, or 0 if there currently isn't one

ViewWindow& Imagine::EmbeddedViewer::createViewerOnPart (  Eeml_Part  viewer_part, Eeml_Part  frame_part )

returns the top view window to a viewer created on the given part Parameters: viewer_part  pointer to EML part that viewer is to be stuck to frame_part  encompassing frame for viewer_part Imagine::ErrorReportException Unable to create a new viewer Returns: a pointer to the new ViewWindow; note that this is different from returning a Evue_DisplayHandle. The latter was used as an ODT to hide Edis_ViewWindow; since we don't need to hide it, we can just go ahead and directly use it.

boost::shared_ptr<Evue_Connection> Imagine::EmbeddedViewer::openConnection (   )  [virtual]

open a connection for an embedded viewer Returns: A shared pointer to the connection. Note: What differentiates this from the ClientViewer::openConnection() is that this doesn't set up the pipe for the SessionManager for which viewer messages are passed. However, it probably does set up local viewer data structures; moreover they're probably set up in such a way as to say "Hey! We're talking to a Viewer in the same address space!" Imagine::ErrorReportException Unable to open a connection to a viewer Implements Imagine::Viewer.

ViewLayer& Imagine::EmbeddedViewer::openImageLayer (  std::string const &  data_filename  )

Open an image layer on the viewer Parameters: data_filename  refers to the file containing spatial data

ViewLayer& Imagine::EmbeddedViewer::openVectorLayer (  std::string const &  data_filename  )

Open a vector layer on the viewer Parameters: data_filename  refers to the file containing spatial data

void Imagine::EmbeddedViewer::setStatusBar (  bool   )  [virtual]

Set whether viewer's status bar is visible or not Implements Imagine::Viewer.

void Imagine::EmbeddedViewer::setVirtualRoam (  bool   )  [virtual]

toggles on/off virtual roam feature Remarks: No idea what this is; as usual, poorly documented. >:o Precondition: viewer and its display is set up Imagine::ErrorReportException Unable to set virtual roam Implements Imagine::Viewer.

ViewWindow& Imagine::EmbeddedViewer::viewWindow (   )

returns the associated ViewWindow

---

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

• Viewer.h

---