目录
1.介绍
学习SpaceClaim二次开发的第一步就是阅读开发者文档。但由于都是英文,不易理解。因此,在学习过程中,进行总结并制作笔记,方便大家学习。
2.内容
SpaceClaim开发者文档一共10章节。本篇主要介绍前两个章节内容。
第一章 Introduction(介绍)
1.1 目的
本文档旨在概述SpaceClaim API及其基本概念。另一个有用的资源是“SpaceClaim_API.chm”帮助文件(这是下载SpaceClaim自带的文件),其中包含以下部分:
(1)入门。解释了如何编写外接程序,并添加到SpaceClaim。
(2)示例。它提供了用C#、F#、C++/CLI和Visual Basic. NET编写的加载项命令示例的下载链接。这些示例展示了如何使用API执行特定任务,例如遍历装配体结构、查询实体的拓扑和几何形状或创建注释。
(3)API 类库。是API中的类、结构、方法和属性的编程文档。
1.2 项目语言
本文档案例使用的语言主要为C#。
1.3 约定
粗体表示API中的类型或成员。
第二章 Overview(概述)
2.1 架构
通过API呈现的SpaceClaim架构的概念视图。
在此图中,每个框代表一个模块,其中每个模块利用位于其下方的其他模块。盒子的大小没有意义。
2.2 文档对象
特别重要的是doc对象与低级建模器和几何对象之间的区别。Doc对象,顾名思义,属于文档。它们是第一类对象,因为它们属于父子层次结构,并且它们提供名字对象(用于持久标识符)和更新状态(用于关联更新)。
许多文档对象都引用了建模器或几何体对象:
- 设计体、设计面和设计边是文档对象,它们引用相应的建模器对象:体、面或边。您可以在不创建设计主体的情况下创建建模器主体,但这意味着不会修改任何文档,窗口中也不会显示任何内容。如果要执行某些建模计算,这可能很有用。您可能会也可能不会在最后创建设计主体。
- 设计曲线是文档对象,它引用了修剪曲线,这是一个几何体对象。同样,您可以在不创建设计曲线的情况下创建曲线和修剪曲线,但设计曲线是显示在窗口中的曲线。(你可以创建图形显示基元,这些基元也引用几何对象,并且这些也显示在窗口中,尽管显示基元不是doc对象。)
- 基准平面是具有对平面(几何体对象)的引用的文档对象。同样,您可以创建平面和其他曲面,而无需创建基准平面。
通常,文档对象将比它引用的建模器或几何体对象具有更多的属性,例如名称、层、可见性或颜色。
2.3 文档结构
一个文档包含以下对象:
零件
文档总是至少包含一个零件,即其主要零件,这代表了设计。如果主要部分有内部组件(属于同一文档的其他部分的实例),则文档也将包含其他部分。内部组件也用于梁型材、中表面零件和金属板展开零件。零件的结构如下所述。
图纸
文档包含零张或多张图纸。下面描述图纸的结构。
图层
文档包含一个或多个图层。总有一个默认图层,如果删除另一个图层,其所有对象都将移动到默认图层。您无法删除默认图层。默认图层与活动图层不同,活动图层是指分配了新对象的图层。活动层是窗口的属性。
材料
文档包含零个或多个文档材料,这些材料是该文档中零件、设计体或梁使用的材料。
窗口
文档包含一个或多个窗口,但可能没有加载任何窗口。如果文档是显式打开的,则其窗口也会被加载和打开,但如果文档是隐式加载的,例如因为它是从另一个打开的文档引用的,则不会加载其窗口。
窗口显示一个场景,这是它显示的对象层次的根。窗口场景可以是属于同一文档的零件或图纸。该窗口还提供对交互上下文的访问,使您可以在特定的坐标空间中工作。交互上下文显示了该坐标空间中的当前选择。一个有用的交互上下文是活动上下文,即用户正在工作的上下文。
2.4 零件结构
组件
一个零件包含零个或多个组件。组件是另一个模板零件的实例。模板部分可能属于同一文档(内部组件),也可能属于另一个文档(外部组件)。
设计体
一个零件包含零个或多个设计体。设计体可以是开放的(表面体)或封闭的(实体)。设计体包含设计面和设计边。
设计曲线
一个零件包含零条或多条设计曲线。设计曲线具有三维几何图形,即使它们通常是在平面中绘制的。例如,如果复制并粘贴设计边,则会创建设计曲线,而这些曲线不需要位于平面中。设计曲线也可以属于基准面和图纸。
基准平面
一个零件包含零个或多个基准面。正如其名,基准面不仅可以作为施工平面,还可以包含位于平面内的设计曲线和文字注释,。当基准面移动时,其子平面也会移动。
坐标系
一个零件包含零个或多个坐标系。坐标系包含三个相互垂直的坐标轴。可以在用户界面中显示的世界坐标系不属于任何文档,也不通过API呈现。
金属板弯曲
如果一个零件是钣金零件,那么它包含零个或多个钣金弯曲,这些弯曲可能是圆柱形或圆锥形的。如果一个零件是钣金零件,那么它具有钣金方面,这是一个呈现钣金信息(包括弯曲)的伴随对象。
梁
零件包含零个或多个梁,这些梁具有修剪的曲线路径、平面横截面以及关于横截面相对于梁路径的位置和方向的信息。
点焊接头
一个零件包含零个或多个点焊接头。点焊接头有一组点焊,每个点焊在设计面上焊接两个或多个点。
图像
一个零件包含零个或多个图像。图像是一张图片或视频,可以放置在空间中或包裹在设计面上。图像也可以属于图纸。
2.5 图纸结构
工程视图
图纸包含零个或多个工程视图。工程视图在概念上类似于组件,因为它实例化了一个零件。对于工程视图,放置变换还包含视图比例。
设计曲线
图纸包含零条或多条位于图纸平面内的设计曲线。设计曲线也可以属于零件和基准面。
注释
图纸包含零个或多个文字注释。
图像
图纸包含零个或多个图像。图像是位于图纸上的图片或视频。图像也可以属于零件。