Imagine::Viewer Class Reference

#include <Viewer.h>

Inheritance diagram for Imagine::Viewer:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual boost::shared_ptr<
Evue_Connection > 
openConnection ()=0
boost::shared_ptr< Evue_Connection > connection ()
void closeConnection ()
virtual void setVirtualRoam (bool)=0
virtual void setStatusBar (bool)=0

Protected Member Functions

 Viewer (Imp *)
 allows for sub-classes to specify their own implementations
Imp const * imp () const
 return reference to internal state object
Imp * imp ()

Detailed Description

Wrapper around ERDAS Imagine Toolkit Viewer

Note:
Viewer keeps internal states for a connection and display handle. The side effects of openConnection(), selectExistingViewer(), and createViewer() are to update these internal states to reflect the new connection and display handles. These are accessed, respectively, via the connection() and displayHandle() members.


Member Function Documentation

void Imagine::Viewer::closeConnection  ) 
 

close a viewer connection

Imagine::ErrorReportException Problem closing a viewer connection

boost::shared_ptr<Evue_Connection> Imagine::Viewer::connection  ) 
 

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

virtual boost::shared_ptr<Evue_Connection> Imagine::Viewer::openConnection  )  [pure virtual]
 

open a connection to a running viewer

Returns:
A shared pointer to the connection.
Remarks:
XXX Or session manager? I'm not sure which. I think this just opens the pipe to the session manager and otherwise prepares for communication with a viewer through the session manager.

Imagine::ErrorReportException Unable to open a connection to a viewer

Implemented in Imagine::ClientViewer, and Imagine::EmbeddedViewer.

virtual void Imagine::Viewer::setStatusBar bool   )  [pure virtual]
 

Set whether viewer's status bar is visible or not

Implemented in Imagine::ClientViewer, and Imagine::EmbeddedViewer.

virtual void Imagine::Viewer::setVirtualRoam bool   )  [pure 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

Implemented in Imagine::ClientViewer, and Imagine::EmbeddedViewer.


The documentation for this class was generated from the following file:
Generated on Wed Mar 7 16:49:36 2007 for ImagineObjects by  doxygen 1.4.6