[an error occurred while processing this directive]
Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

PreviewIdentifyTool Class Reference

Visually connect the image numbers with the image on the preview. More...

#include <PreviewIdentifyTool.h>

Inheritance diagram for PreviewIdentifyTool:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 PreviewIdentifyTool (PreviewToolHelper *helper, GLPreviewFrame *owner)
 ~PreviewIdentifyTool ()
void Activate ()
 Switch on a tool.
void ImagesUnderMouseChangedEvent ()
 Notify when the images directly underneath the mouse pointer have changed.
void AfterDrawImagesEvent ()
 Draw (using OpenGL) images above the others.
bool BeforeDrawImageEvent (unsigned int image)
 Draw what the tool requires just before a given image is drawn.
void ShowImageNumber (unsigned int image)
 Notification for when moving the mouse on an image button.
void StopShowingImages ()
 Notification for when moving the mouse off an image button.
void MouseButtonEvent (wxMouseEvent &e)
 Show control point editor if mouse is over two images.

Detailed Description

Visually connect the image numbers with the image on the preview.

There are two ways it does this:

  1. When the user moves the mouse pointer over a image button, the image is highlighted in the preview.
  2. When the user moves the mouse pointer over the preview, the image under the pointer are highlighted with matching colours over the buttons.

The highlighted images are drawn on top of the other images, with a coloured border. If the mouse is over exactly two images, a click opens the control point editor with those two images shown.


Constructor & Destructor Documentation

PreviewIdentifyTool::PreviewIdentifyTool PreviewToolHelper helper,
GLPreviewFrame owner
 

PreviewIdentifyTool::~PreviewIdentifyTool  ) 
 


Member Function Documentation

void PreviewIdentifyTool::Activate  )  [virtual]
 

Switch on a tool.

Inherited classes also register events they want to respond to with the PreviewToolHelper. As events are lost when the tool is deactivated without notification to the PreviewTool, things from the last activation can be cleaned up here too.

Implements PreviewTool.

void PreviewIdentifyTool::AfterDrawImagesEvent  )  [virtual]
 

Draw (using OpenGL) images above the others.

Reimplemented from PreviewTool.

bool PreviewIdentifyTool::BeforeDrawImageEvent unsigned int  image  )  [virtual]
 

Draw what the tool requires just before a given image is drawn.

This can be used to modify how the images are drawn, prevent drawing of the image, or change the order of the image drawing (with another event to draw the image when it is needed).

Returns:
false if the tool does not want the image drawn normally, or true when the image should be drawn normally.

Reimplemented from PreviewTool.

void PreviewIdentifyTool::ImagesUnderMouseChangedEvent  )  [virtual]
 

Notify when the images directly underneath the mouse pointer have changed.

It is monitored by the PreviewToolHelper.

Reimplemented from PreviewTool.

void PreviewIdentifyTool::MouseButtonEvent wxMouseEvent &  e  )  [virtual]
 

Show control point editor if mouse is over two images.

Reimplemented from PreviewTool.

void PreviewIdentifyTool::ShowImageNumber unsigned int  image  ) 
 

Notification for when moving the mouse on an image button.

Parameters:
image the image number of the image the mouse is on.

void PreviewIdentifyTool::StopShowingImages  ) 
 

Notification for when moving the mouse off an image button.


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

Generated on Mon Sep 20 01:01:35 2010 for Hugintrunk by doxygen 1.3.9.1