#include <Tool.h>
Public Member Functions | |
| Tool (ToolHelper *helper) | |
| Construct keeping a pointer to a PreviewToolHelper. | |
| virtual | ~Tool () |
| virtual void | Activate ()=0 |
| Switch on a tool. | |
| virtual void | Deactivate () |
| Switch off a tool. | |
| virtual void | MouseMoveEvent (double x, double y, wxMouseEvent &e) |
| Notify when the mouse pointer has moved over the panorama preview. | |
| virtual void | MouseButtonEvent (wxMouseEvent &e) |
| Notify of a mouse button press on the panorama preview. | |
| virtual void | MouseWheelEvent (wxMouseEvent &e) |
| Notify of a mouse wheel event on the panorama preview. | |
| virtual void | ImagesUnderMouseChangedEvent () |
| Notify when the images directly underneath the mouse pointer have changed. | |
| virtual void | KeypressEvent (int keycode, int modifiers, bool pressed) |
| Notify of a Keypress event. | |
| virtual void | BeforeDrawImagesEvent () |
| Draw using OpenGL anything the tool requires underneath the images. | |
| virtual void | AfterDrawImagesEvent () |
| Draw (using OpenGL) images above the others. | |
| virtual void | ReallyAfterDrawImagesEvent () |
| Draw (using OpenGL) the overlays, e.g. crop highlights, guides. | |
| virtual bool | BeforeDrawImageEvent (unsigned int image) |
| Draw what the tool requires just before a given image is drawn. | |
| virtual void | AfterDrawImageEvent (unsigned int image) |
| Notification called just after the image was drawn normally. | |
| virtual void | MarkDirty () |
Protected Attributes | |
| ToolHelper * | helper |
| The PreviewToolHelper that uses the same preview window and panorama as the tool should. | |
Detailed Description
Constructor & Destructor Documentation
◆ Tool()
|
explicit |
Construct keeping a pointer to a PreviewToolHelper.
Child classes should use this to ensure helper is set.
Definition at line 29 of file Tool.cpp.
References helper, and threshold().
◆ ~Tool()
Member Function Documentation
◆ Activate()
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.
Implemented in DragTool, PanosphereOverviewCameraTool, PlaneOverviewCameraTool, PanosphereSphereTool, PreviewCameraTool, PreviewControlPointTool, PreviewCropTool, PreviewDifferenceTool, PreviewGuideTool, PreviewIdentifyTool, PreviewLayoutLinesTool, PreviewPanoMaskTool, PreviewProjectionGridTool, PanosphereOverviewProjectionGridTool, PanosphereOverviewOutlinesTool, PlaneOverviewOutlinesTool, PreviewColorPickerTool, and PreviewEditCPTool.
◆ AfterDrawImageEvent()
◆ AfterDrawImagesEvent()
Draw (using OpenGL) images above the others.
Reimplemented in PreviewControlPointTool, PreviewDifferenceTool, PreviewIdentifyTool, PreviewLayoutLinesTool, PreviewProjectionGridTool, and PlaneOverviewOutlinesTool.
◆ BeforeDrawImageEvent()
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 in PreviewDifferenceTool, PreviewIdentifyTool, and PreviewLayoutLinesTool.
◆ BeforeDrawImagesEvent()
Draw using OpenGL anything the tool requires underneath the images.
Reimplemented in PreviewDifferenceTool, PreviewLayoutLinesTool, PreviewPanoMaskTool, and PreviewProjectionGridTool.
◆ Deactivate()
Switch off a tool.
Deactivation of all notifications is done automatically, it is not needed in these function.
Reimplemented in PreviewColorPickerTool, and PreviewEditCPTool.
◆ ImagesUnderMouseChangedEvent()
Notify when the images directly underneath the mouse pointer have changed.
It is monitored by the PreviewToolHelper.
Reimplemented in PreviewDifferenceTool, and PreviewIdentifyTool.
◆ KeypressEvent()
Notify of a Keypress event.
Currently unused as the preview cannot get keyboard input focus.
Reimplemented in PanosphereOverviewCameraTool, and PlaneOverviewCameraTool.
◆ MarkDirty()
Reimplemented in PanosphereOverviewOutlinesTool, and PlaneOverviewOutlinesTool.
◆ MouseButtonEvent()
|
inlinevirtual |
Notify of a mouse button press on the panorama preview.
- Parameters
-
e The event created by wxWidgets.
Reimplemented in DragTool, PanosphereOverviewCameraTool, PlaneOverviewCameraTool, PreviewCameraTool, PreviewCropTool, PreviewIdentifyTool, PreviewLayoutLinesTool, PreviewColorPickerTool, and PreviewEditCPTool.
◆ MouseMoveEvent()
|
inlinevirtual |
Notify when the mouse pointer has moved over the panorama preview.
The coordinates are in the space of the panorama output at full size, with no output cropping.
- Parameters
-
x The horizontal position of the mouse pointer in panorama pixels. y The vertical position of the mouse pointer in panorama pixels. e The event created by wxWidgets.
Reimplemented in DragTool, PanosphereOverviewCameraTool, PlaneOverviewCameraTool, PreviewCameraTool, PreviewCropTool, PreviewIdentifyTool, PreviewLayoutLinesTool, and PreviewEditCPTool.
◆ MouseWheelEvent()
|
inlinevirtual |
Notify of a mouse wheel event on the panorama preview.
- Parameters
-
e The event created by wxWidgets.
Reimplemented in PanosphereOverviewCameraTool, PlaneOverviewCameraTool, and PreviewCameraTool.
◆ ReallyAfterDrawImagesEvent()
Draw (using OpenGL) the overlays, e.g. crop highlights, guides.
Reimplemented in PreviewDragTool, OverviewDragTool, PreviewCropTool, PreviewGuideTool, PreviewPanoMaskTool, PreviewEditCPTool, and DragTool.
Member Data Documentation
◆ helper
|
protected |
The PreviewToolHelper that uses the same preview window and panorama as the tool should.
Definition at line 109 of file Tool.h.
Referenced by DragTool::Activate(), PanosphereOverviewCameraTool::Activate(), PlaneOverviewCameraTool::Activate(), PanosphereSphereTool::Activate(), PreviewCameraTool::Activate(), PreviewControlPointTool::Activate(), PreviewCropTool::Activate(), PreviewDifferenceTool::Activate(), PreviewGuideTool::Activate(), PreviewIdentifyTool::Activate(), PreviewLayoutLinesTool::Activate(), PreviewPanoMaskTool::Activate(), PreviewProjectionGridTool::Activate(), PanosphereOverviewProjectionGridTool::Activate(), PanosphereOverviewOutlinesTool::Activate(), PlaneOverviewOutlinesTool::Activate(), PreviewColorPickerTool::Activate(), PreviewEditCPTool::Activate(), PreviewEditCPTool::AddLineCP(), PanosphereOverviewProjectionGridTool::AfterDrawImagesBackEvent(), PreviewControlPointTool::AfterDrawImagesEvent(), PreviewDifferenceTool::AfterDrawImagesEvent(), PreviewIdentifyTool::AfterDrawImagesEvent(), PreviewLayoutLinesTool::AfterDrawImagesEvent(), PreviewProjectionGridTool::AfterDrawImagesEvent(), PanosphereOverviewProjectionGridTool::AfterDrawImagesFrontEvent(), PreviewLayoutLinesTool::BeforeDrawImageEvent(), PanosphereSphereTool::BeforeDrawImagesBackEvent(), PreviewDifferenceTool::BeforeDrawImagesEvent(), PreviewLayoutLinesTool::BeforeDrawImagesEvent(), PreviewColorPickerTool::CalcCorrection(), PreviewColorPickerTool::CalcCorrectionForImage(), PanosphereOverviewCameraTool::ChangeFOV(), PreviewCameraTool::ChangeZoomLevel(), PanosphereOverviewCameraTool::ChangeZoomLevel(), PlaneOverviewCameraTool::ChangeZoomLevel(), PreviewProjectionGridTool::createMesh(), PreviewColorPickerTool::Deactivate(), PreviewEditCPTool::Deactivate(), PanosphereOverviewOutlinesTool::drawBackground(), PreviewLayoutLinesTool::drawIdentificationBorder(), PreviewEditCPTool::FindCPInRect(), PreviewIdentifyTool::ForceRedraw(), PreviewEditCPTool::GetSelectedROI(), PreviewDifferenceTool::ImagesUnderMouseChangedEvent(), PreviewIdentifyTool::ImagesUnderMouseChangedEvent(), PreviewControlPointTool::MakeTransforms(), DragTool::MouseButtonEvent(), PanosphereOverviewCameraTool::MouseButtonEvent(), PlaneOverviewCameraTool::MouseButtonEvent(), PreviewCameraTool::MouseButtonEvent(), PreviewCropTool::MouseButtonEvent(), PreviewIdentifyTool::MouseButtonEvent(), PreviewColorPickerTool::MouseButtonEvent(), PreviewEditCPTool::MouseButtonEvent(), DragTool::MouseMoveEvent(), PanosphereOverviewCameraTool::MouseMoveEvent(), PlaneOverviewCameraTool::MouseMoveEvent(), PreviewCameraTool::MouseMoveEvent(), PreviewCropTool::MouseMoveEvent(), PreviewLayoutLinesTool::MouseMoveEvent(), PreviewEditCPTool::MouseMoveEvent(), PanosphereOverviewCameraTool::MouseWheelEvent(), PreviewCameraTool::MouseWheelEvent(), PreviewControlPointTool::PreviewControlPointTool(), PreviewLayoutLinesTool::PreviewLayoutLinesTool(), PreviewDragTool::ReallyAfterDrawImagesEvent(), PreviewCropTool::ReallyAfterDrawImagesEvent(), PreviewGuideTool::ReallyAfterDrawImagesEvent(), PreviewPanoMaskTool::ReallyAfterDrawImagesEvent(), PreviewIdentifyTool::setConstantOn(), PreviewGuideTool::SetGuideStyle(), PreviewIdentifyTool::ShowImageNumber(), PreviewIdentifyTool::StopShowingImages(), PreviewIdentifyTool::StopUpdating(), Tool(), PreviewCameraTool::UpdateCenter(), PreviewLayoutLinesTool::updateImageCentres(), PreviewLayoutLinesTool::updateLineInformation(), PreviewIdentifyTool::UpdateWithNewImageSet(), and PreviewLayoutLinesTool::~PreviewLayoutLinesTool().
The documentation for this class was generated from the following files:
