orthanc-stone: Framework/Scene2DViewport/MeasureTool.h annotate

annotate Framework/Scene2DViewport/MeasureTool.h @ 774:66ac7a2d1e3a

A few renames and cleanups + moved GUI constants to controller + start work on hit tests for measure tools and mouse hover.

author	Benjamin Golinvaux <bgo@osimis.io>
date	Fri, 24 May 2019 15:59:51 +0200
parents	Framework/Scene2DViewport/MeasureTools.h@92c400a09f1b
children	e42b491f1fb2

rev	line source
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	1 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	2 * Stone of Orthanc
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	4 * Department, University Hospital of Liege, Belgium
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	6 *
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	7 * This program is free software: you can redistribute it and/or
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	8 * modify it under the terms of the GNU Affero General Public License
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	9 * as published by the Free Software Foundation, either version 3 of
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	10 * the License, or (at your option) any later version.
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	11 *
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	12 * This program is distributed in the hope that it will be useful, but
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	13 * WITHOUT ANY WARRANTY; without even the implied warranty of
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	15 * Affero General Public License for more details.
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	16 *
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	17 * You should have received a copy of the GNU Affero General Public License
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	19 **/
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	20
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	21 #pragma once
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	22
736 c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	23 #include "../Scene2D/PolylineSceneLayer.h"
c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	24 #include "../Scene2D/Scene2D.h"
c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	25 #include "../Scene2D/ScenePoint2D.h"
c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	26 #include "../Scene2D/TextSceneLayer.h"
c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	27 #include "../Scene2DViewport/PointerTypes.h"
c0fcb2757b0a enforce relative includes Sebastien Jodogne <s.jodogne@gmail.com> parents: 722 diff changeset	28 #include "../Scene2DViewport/ViewportController.h"
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	29
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	30 #include <boost/shared_ptr.hpp>
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	31 #include <boost/weak_ptr.hpp>
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	32
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	33 #include <vector>
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	34 #include <cmath>
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	35
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	36 namespace OrthancStone
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	37 {
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	38 class MeasureTool : public IObserver
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	39 {
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	40 public:
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	41 virtual ~MeasureTool();
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	42
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	43 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	44 Enabled tools are rendered in the scene.
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	45 */
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	46 void Enable();
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	47
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	48 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	49 Disabled tools are not rendered in the scene. This is useful to be able
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	50 to use them as their own memento in command stacks (when a measure tool
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	51 creation command has been undone, the measure remains alive in the
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	52 command object but is disabled so that it can be redone later on easily)
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	53 */
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	54 void Disable();
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	55
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	56 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	57 This method is called when the scene transform changes. It allows to
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	58 recompute the visual elements whose content depend upon the scene transform
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	59 */
700 059e1fd05fd6 Introduced the ViewportController that sits between the application and the Benjamin Golinvaux <bgo@osimis.io> parents: 698 diff changeset	60 void OnSceneTransformChanged(
059e1fd05fd6 Introduced the ViewportController that sits between the application and the Benjamin Golinvaux <bgo@osimis.io> parents: 698 diff changeset	61 const ViewportController::SceneTransformChanged& message);
774 66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	62
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	63 /**
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	64 This function must be implemented by the measuring tool to return whether
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	65 a given point in scene coords is close to the measuring tool.
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	66
774 66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	67 This is used for mouse hover highlighting.
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	68
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	69 It is assumed that if the pointer position leads to this function returning
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	70 true, then a click at that position will return a tracker to edit the
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	71 measuring tool
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	72 */
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	73 virtual bool HitTest(ScenePoint2D p) const = 0;
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	74 protected:
700 059e1fd05fd6 Introduced the ViewportController that sits between the application and the Benjamin Golinvaux <bgo@osimis.io> parents: 698 diff changeset	75 MeasureTool(MessageBroker& broker, ViewportControllerWPtr controllerW);
722 28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	76
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	77 /**
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	78 The measuring tool may exist in a standalone fashion, without any available
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	79 scene (because the controller is dead or dying). This call allows to check
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	80 before accessing the scene.
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	81 */
28b9e3a54200 Undo mechanism implemented (not connected to UI yet). Undo stack and measuring Benjamin Golinvaux <bgo@osimis.io> parents: 700 diff changeset	82 bool IsSceneAlive() const;
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	83
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	84 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	85 This is the meat of the tool: this method must [create (if needed) and]
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	86 update the layers and their data according to the measure tool kind and
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	87 current state. This is repeatedly called during user interaction
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	88 */
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	89 virtual void RefreshScene() = 0;
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	90
774 66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	91 ViewportControllerConstPtr GetController() const;
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	92 ViewportControllerPtr GetController();
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	93
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	94 Scene2DConstPtr GetScene() const;
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	95 Scene2DPtr GetScene();
66ac7a2d1e3a A few renames and cleanups + moved GUI constants to controller + start work on Benjamin Golinvaux <bgo@osimis.io> parents: 754 diff changeset	96
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	97 /**
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	98 enabled_ is not accessible by subclasses because there is a state machine
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	99 that we do not wanna mess with
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	100 */
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	101 bool IsEnabled() const;
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	102
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	103 private:
700 059e1fd05fd6 Introduced the ViewportController that sits between the application and the Benjamin Golinvaux <bgo@osimis.io> parents: 698 diff changeset	104 ViewportControllerWPtr controllerW_;
698 8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	105 bool enabled_;
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	106 };
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	107 }
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	108
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	109 extern void TrackerSample_SetInfoDisplayMessage(
8b6adfb62a2f Code is broken -- stashing ongoing work in a branch Benjamin Golinvaux <bgo@osimis.io> parents: diff changeset	110 std::string key, std::string value);

Mercurial > hg > orthanc-stone

annotate Framework/Scene2DViewport/MeasureTool.h @ 774:66ac7a2d1e3a