CloudCompare之插件式开发

今天药忘吃喽~ 2023-01-17 14:51 308阅读 0赞

因为看了这个学长的视频：[CloudCompare插件开发教程][CloudCompare]，突然对CloudCompare开发非常感兴趣，所以写篇笔记记录一下实现的过程。

### 文章目录 ###

*  一、实现步骤
 *  二、实现过程

# 一、实现步骤 #

> 实现CloudCompare二次开发的基础就是要事先编译过该软件的源码，这部分可以参照官网上的教程等等即可，如果已经编译过了，那么就可以进行下面的过程了。

> 实现步骤主要有以下几步：  
> （1）修改配置文件。  
> （2）利用CMake工具生成相应的VS项目，并在项目中添加我们自定义的代码进行编译以生成dll文件。  
> （3）最后， 将生成的dll文件拷贝到与可执行文件同一级的plugins目录下即完成整个过程。  
> 话不多说，让我们直奔正题。

# 二、实现过程 #

因为也是初学者，所以还是从最简单的官方实例开始吧\*~\*。

> 1、首先，我们要找到源代码中的例子。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70]

> 从官方的例子很容易看出，cc主要支持三种插件类型：GL插件、IO插件以及普通类型插件。其中，GL插件主要是用于自定义图形的绘制、渲染等，IO插件主要是用于自定义数据的输入输出，而普通类型的插件则主要是用于数据的处理等。既然如此，本着柿子当挑软的捏的原则，我就实现一个普通类型的插件\*^\*。

> 2、为了不破坏原始的例子，我们拷贝一份ExamplePlugin将名字修改为TestPlugin，并修改其中的配置文件，如images、CMakeLists.txt等。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 1]

具体内容：

> images目录

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 2]

> CMakeList.txt

cmake_minimum_required( VERSION 3.0 )
    
    # CloudCompare example for standard plugins
    
    # REPLACE ALL 'ExamplePlugin' OCCURENCES BY YOUR PLUGIN NAME
    # AND ADAPT THE CODE BELOW TO YOUR OWN NEEDS!
    
    # Add an option to CMake to control whether we build this plugin or not
    option( PLUGIN_TEST_STANDARD "Check to install example plugin" OFF )	#这是一个编译选项，在之后的编译过程中我们会再次看到，默认是关闭状态
    
    if ( PLUGIN_TEST_STANDARD )
    	# 定义项目名称
        project( TestPlugin )
        
        # load any subdirectories (see qAdditionalIO for an example)
        # add_subdirectory( LIB1 )
        
        include( ../../CMakePluginTpl.cmake )
        
        # set dependencies to necessary libraries (see qPCV for an example)
        # target_link_libraries( ${PROJECT_NAME} LIB1 )
        # include_directories( ${LIB1_INCLUDE_DIR} )
    endif()

> info.json

{
    	"type" : "Standard",
    	"name" : "Test (Standard Plugin)",
    	"icon" : ":/CC/plugin/TestPlugin/images/icon2.png",
    	"description": "This is a description of the marvelous Example plugin. It does nothing.",
    	"authors" : [
    		{
    			"name" : "Daniel Girardeau-Montaut",
    			"email" : "daniel.girardeau@gmail.com"
    		}
    	],
    	"maintainers" : [
    		{
    			"name" : "Andy Maloney",
    			"email" : "asmaloney@gmail.com"
    		},
    		{
    			"name" : "Example NoEmail"
    		}
    	],
    	"references" : [
    		{
    			"text" : "The unsuccessful self-treatment of a case of “writer's block”",
    			"url" : "https://www.ncbi.nlm.nih.gov/pmc/articles/PMC1311997/"
    		},
    		{
    			"text" : "Sword swallowing and its side effects",
    			"url" : "http://www.bmj.com/content/333/7582/1285"
    		},
    		{
    			"text" : "I thought of creating this wonderful plugin while I was hiking up ⛰ Mont Blanc"
    		}
    	]
    }

> 3、在配置和修改好之后，利用CMake工具即可生成相应的VS项目，在项目中添加我们自定义的代码进行编译生成dll文件。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 3]

> 如果你在配置之后没有出现上述的选项，那么你可能是没有将TestPlugin目录添加进去，只需添加下面这行代码就可以了。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 4]![在这里插入图片描述][20210502131421915.png]

add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/ExampleGLPlugin )
    add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/ExampleIOPlugin )
    add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/ExamplePlugin )
    add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/TestPlugin )

如果在添加这行代码之后仍没有，我们可以点击右上角的添加入口，然后再重新配置一下应该就可以了。

> 之后我们打开生成的项目添加我们的自定义的代码：

> TestPlugin.h

#ifndef EXAMPLE_PLUGIN_HEADER
    #define EXAMPLE_PLUGIN_HEADER
    
    //##########################################################################
    //# #
    //# CLOUDCOMPARE PLUGIN: ExamplePlugin #
    //# #
    //# This program is free software; you can redistribute it and/or modify #
    //# it under the terms of the GNU General Public License as published by #
    //# the Free Software Foundation; version 2 of the License. #
    //# #
    //# This program is distributed in the hope that it will be useful, #
    //# but WITHOUT ANY WARRANTY; without even the implied warranty of #
    //# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
    //# GNU General Public License for more details. #
    //# #
    //# COPYRIGHT: XXX #
    //# #
    //##########################################################################
    
    #include "ccStdPluginInterface.h"
    
    //! Example qCC plugin
    /** Replace 'ExamplePlugin' by your own plugin class name throughout and then check 'ExamplePlugin.cpp' for more directions. Each plugin requires an info.json file to provide information about itself - the name, authors, maintainers, icon, etc.. The one method you are required to implement is 'getActions'. This should return all actions (QAction objects) for the plugin. CloudCompare will automatically add these with their icons in the plugin toolbar and to the plugin menu. If your plugin returns several actions, CC will create a dedicated toolbar and a sub-menu for your plugin. You are responsible for connecting these actions to methods in your plugin. Use the ccStdPluginInterface::m_app variable for access to most of the CC components (database, 3D views, console, etc.) - see the ccMainAppInterface class in ccMainAppInterface.h. **/
    class TestPlugin : public QObject, public ccStdPluginInterface //继承插件接口
    { 
    	Q_OBJECT
    	Q_INTERFACES(ccStdPluginInterface)
    	
    	// Replace "Example" by your plugin name (IID should be unique - let's hope your plugin name is unique ;)
    	// The info.json file provides information about the plugin to the loading system and
    	// it is displayed in the plugin information dialog.
    	Q_PLUGIN_METADATA(IID "cccorp.cloudcompare.plugin.TestExample" FILE "info.json")
    	
    public:
    	explicit TestPlugin( QObject *parent = nullptr );
    	~TestPlugin() override = default;
    	
    	// inherited from ccStdPluginInterface，重载了下面两个函数
    	void onNewSelection( const ccHObject::Container &selectedEntities ) override;
    	QList<QAction *> getActions() override;
    	
    private:
    	/*** ADD YOUR CUSTOM ACTIONS HERE ***/
    	void doAction();		//这里是真正添加我们自定义内容的地方
    	
    	//! Default action
    	/** You can add as many actions as you want in a plugin. Each action will correspond to an icon in the dedicated toolbar and an entry in the plugin menu. **/
    	QAction* m_action;		//定义一个行为对象
    };
    
    #endif

> TestPlugin.cpp

//##########################################################################
    //# #
    //# CLOUDCOMPARE PLUGIN: ExamplePlugin #
    //# #
    //# This program is free software; you can redistribute it and/or modify #
    //# it under the terms of the GNU General Public License as published by #
    //# the Free Software Foundation; version 2 of the License. #
    //# #
    //# This program is distributed in the hope that it will be useful, #
    //# but WITHOUT ANY WARRANTY; without even the implied warranty of #
    //# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
    //# GNU General Public License for more details. #
    //# #
    //# COPYRIGHT: XXX #
    //# #
    //##########################################################################
    
    // First:
    // Replace all occurrences of 'ExamplePlugin' by your own plugin class name in this file.
    // This includes the resource path to info.json in the constructor.
    
    // Second:
    // Open ExamplePlugin.qrc, change the "prefix" and the icon filename for your plugin.
    // Change the name of the file to <yourPluginName>.qrc
    
    // Third:
    // Open the info.json file and fill in the information about the plugin.
    // "type" should be one of: "Standard", "GL", or "I/O" (required)
    // "name" is the name of the plugin (required)
    // "icon" is the Qt resource path to the plugin's icon (from the .qrc file)
    // "description" is used as a tootip if the plugin has actions and is displayed in the plugin dialog
    // "authors", "maintainers", and "references" show up in the plugin dialog as well
    
    #include <QtGui>
    #include <QMessageBox>
    
    #include"TestPlugin.h"
    
    // Default constructor:
    // - pass the Qt resource path to the info.json file (from <yourPluginName>.qrc file) 
    // - constructor should mainly be used to initialize actions and other members
    TestPlugin::TestPlugin( QObject *parent )
    	: QObject( parent )
    	, ccStdPluginInterface( ":/CC/plugin/TestPlugin/info.json" )
    	, m_action( nullptr )
    { 
    }
    
    // This method should enable or disable your plugin actions
    // depending on the currently selected entities ('selectedEntities').
    void TestPlugin::onNewSelection( const ccHObject::Container &selectedEntities )
    { 
    	if ( m_action == nullptr )
    	{ 
    		return;
    	}
    	
    	// If you need to check for a specific type of object, you can use the methods
    	// in ccHObjectCaster.h or loop and check the objects' classIDs like this:
    	//
    	// for ( ccHObject *object : selectedEntities )
    	// { 
    	// if ( object->getClassID() == CC_TYPES::VIEWPORT_2D_OBJECT )
    	// { 
    	// // ... do something with the viewports
    	// }
    	// }
    	
    	// For example - only enable our action if something is selected.
    	//m_action->setEnabled( !selectedEntities.empty() );
    }
    
    // This method returns all the 'actions' your plugin can perform.
    // getActions() will be called only once, when plugin is loaded.
    QList<QAction *> TestPlugin::getActions()
    { 
    	// default action (if it has not been already created, this is the moment to do it)
    	if ( !m_action )
    	{ 
    		m_app->dispToConsole("Initialization TestPlugin", ccMainAppInterface::STD_CONSOLE_MESSAGE);
    		// Here we use the default plugin name, description, and icon,
    		// but each action should have its own.
    		m_action = new QAction( getName(), this );
    		m_action->setToolTip( getDescription() );
    		m_action->setIcon( getIcon() );
    		m_action->setEnabled(true);		//启用按钮
    		
    		// Connect appropriate signal
    		connect( m_action, &QAction::triggered, this, &TestPlugin::doAction );
    	}
    
    	return {  m_action };
    }
    
    // This is an example of an action's method called when the corresponding action
    // is triggered (i.e. the corresponding icon or menu entry is clicked in CC's
    // main interface). You can access most of CC's components (database,
    // 3D views, console, etc.) via the 'm_app' variable (see the ccMainAppInterface
    // class in ccMainAppInterface.h).
    void TestPlugin::doAction()
    { 	
    	if ( m_app == nullptr )
    	{ 
    		// m_app should have already been initialized by CC when plugin is loaded
    		Q_ASSERT( false );
    		
    		return;
    	}
    
    	/*** HERE STARTS THE ACTION ***/
    
    	// Put your code here
    	// --> you may want to start by asking for parameters (with a custom dialog, etc.)
    
    	// This is how you can output messages
    	//添加一些简单的代码进行测试
    	QString dlgTitle = "Message Box";
    	QString strInfo = "The file has opened!";
    	QMessageBox::information(nullptr, dlgTitle, strInfo, QMessageBox::Ok, QMessageBox::NoButton);
    
    	/*** HERE ENDS THE ACTION ***/
    }

> 修改一下按钮的图片：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 5]

> 最后，我们就可以生成一个自定义的动态链接库，如下所示：

![在这里插入图片描述][20210502150034464.png]

> 4、 将生成的dll文件拷贝到与可执行文件同一级的plugins目录下即完成整个过程。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 6]

> 注：加载dll文件的路径可以点击CloudCompare中的【help】——【about plugins】进行查看，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 7]

运行效果：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 8]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 9]

> 参考资料：[CloudCompare插件开发教程][CloudCompare]

[CloudCompare]: https://www.bilibili.com/video/BV1mC4y1a7FG
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70]: /images/20221021/f92dffc3e71b4635b775597f7953f6f8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 1]: /images/20221021/61c63b9533f544579f012cb942f66900.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 2]: /images/20221021/7967cb8c4ee54606ab2dae497253557a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 3]: /images/20221021/d7fcc002c919416e831dbdfe88c7c9a7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210502131312511.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ==,size_16,color_FFFFFF,t_70
[20210502131421915.png]: /images/20221021/8c542420f57c494bbb772b49a176922d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 5]: /images/20221021/6fc39f5023d248a19a6e8344c96f2caa.png
[20210502150034464.png]: /images/20221021/4a01434aa4f24a6cbe08233045fbe344.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 6]: /images/20221021/f665ba711f744d4e8976acfd2b526ac4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 7]: /images/20221021/89bdb099e6ba481f80eafb2b5cde3136.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 8]: /images/20221021/045397cc60ba415a8015d60793830c5e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2RheXVoYWl0YW5nMQ_size_16_color_FFFFFF_t_70 9]: /images/20221021/f44b59f928c84eafaf9a32429f50de44.png