# FamilyAddinSample

**Repository Path**: glodon/familyaddinsample

## Basic Information

- **Project Name**: FamilyAddinSample
- **Description**: 该项目提供了一个简单的广联达构件设计软件插件的开发样例。
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 15
- **Forks**: 2
- **Created**: 2024-03-05
- **Last Updated**: 2025-07-29

## Categories & Tags

**Categories**: engineering

**Tags**: None

## README

# 插件样例

### 项目介绍
- 该项目提供一个简单的构件编辑器插件开发样例

- 该项目提供了创建简单长方体、球体功能

- 该项目使用了GCMP和构件编辑器的少量API

- 插件示意图
  ![Alt text](docs/diagrams.png)


### 项目架构
##### 文件夹结构示意如下所示：

```text
COMPONENTEDITOR_SDK 目录结构：
	COMPONENTEDITOR_SDK
		|----------include
		|----------lib
		|-----------|--------release
		|-----------|--------debug
        |----------bin

开源项目目录结构：
    FamilyAddinSample
        |----------config
        |-------------|-------ui  // ui配置文件
        |-------------|-------FamilyAddinSample.addin //插件配置文件
        |----------resource   	 //资源文件
  		|----------docs          //文档      
        |----------source  		 //源代码
        |----------LICENSE
        |----------CMakeLists.txt
        |----------README.md
```


### 编译与运行
#### 编译环境

- CMake 3.11 +
  
- Visual Studio 2015
  
- QT 5.6.3

- COMPONENTEDITOR_SDK

#### 安装基础依赖组件

- 安装Qt5.6.3,设置环境变量**QtDIR_x64**

	例如: `QtDIR_x64=C:\Qt\Qt5.6.3\5.6.3\msvc2015_x64`
    - 或者在cmake里指定路径


- 下载COMPONENTEDITOR_SDK.zip：https://static.goujianwu.com/201_project/package/paramodel/COMPONENTEDITOR_SDK.zip

- 解压COMPONENTEDITOR_SDK, 设置环境变量**COMPONENTEDITOR_SDK_DIR**

	例如:`COMPONENTEDITOR_SDK_DIR=d:\\COMPONENTEDITOR_SDK`


#### 编译步骤

- 使用CMake.exe生成项目文件，构建插件

```text
切换到cmake输出目录
cd /d D:\FamilyAddinSample\bin

指定源代码目录，打开生成的解决方案 FamilyAddinSample.sln
cmake ..\FamilyAddinSample -G "Visual Studio 14 2015 Win64"

打开生成的解决方案FamilyAddinSample.sln，若使用高版本的VS，则注意在打开时均选择无升级。
```

- 构建生成FamilyAddinSample.dll

#### 运行步骤

- 复制 FamilyAddinSample.dll 到 COMPONENTEDITOR_SDK/bin 目录

- 复制 config/FamilyAddinSample.addin 到 COMPONENTEDITOR_SDK/bin/ component_editor_plugin_config/FamilyAddinSample.addin

- 复制 config/ui/* 到 COMPONENTEDITOR_SDK/bin/addins/FamilyAddinSample/ui/* 

- 启动 AppComponentEditor.exe


### License
MIT