ccTool.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <ecvDisplayTools.h>
#include <ecvHObject.h>
#include <ecvMainAppInterface.h>
#include <ecvPointCloud.h>
 
/*
Template class that defining the basic functionality of qCompass "tools".
*/
class ccTool {
public:
    virtual ~ccTool() {}
 
    void initializeTool(ecvMainAppInterface* app) {
        m_app = app;  // store copy of app
        m_window = ecvDisplayTools::GetCurrentScreen();
    }
 
    // called when the tool is set to active (for initialization)
    virtual void toolActivated() {}
 
    // called when the tool is set to disactive (for cleanup)
    virtual void toolDisactivated() {}
 
    // called when a point in a point cloud gets picked while this tool is
    // active
    virtual void pointPicked(ccHObject* insertPoint,
                             unsigned itemIdx,
                             ccHObject* pickedObject,
                             const CCVector3& P) {}
 
    // called when a point in a point cloud gets picked while this tool is
    // active
    virtual void pointPicked(ccHObject* insertPoint,
                             unsigned itemIdx,
                             ccPointCloud* cloud,
                             const CCVector3& P) {}
 
    // called when the selection is changed while this tool is active
    virtual void onNewSelection(const ccHObject::Container& selectedEntities) {}
 
    // called when "Return" or "Space" is pressed, or the "Accept Button" is
    // clicked
    virtual void accept() {}
 
    // called when the "Escape" is pressed, or the "Cancel" button is clicked
    virtual void cancel() {}
 
    // if this returns true, the undo button is enabled in the gui
    virtual bool canUndo() { return false; }
 
    // called when the undo button is clicked
    virtual void undo() {}
 
protected:
    ccTool() : m_app(nullptr), m_window(nullptr) {}
 
    // link to the main plugin interface
    ecvMainAppInterface* m_app;
 
    // link to the active openGLWindow
    QWidget* m_window;
};