OCCT知识笔记之OCAF框架详解

OCAF框架在OCCT项目中的构建与使用指南

Open CASCADE Application Framework (OCAF)是Open CASCADE Technology (OCCT)中用于管理CAD数据的核心框架，它提供了一种结构化方式来组织和管理复杂的CAD数据，如装配体、形状、属性(颜色、材料)和元数据等。本文将详细介绍如何在项目中构建和使用OCAF框架。

 1. OCAF核心概念与架构

OCAF基于三个核心概念构建：应用(Application)、文档(Document)和属性(Attribute)，采用树形结构组织数据。

1.1 核心组件

文档(TDocStd_Document): 所有数据的容器，表示一个层次化的树形结构，根节点是Main标签(TDF_Label)
标签(TDF_Label): 数据组织的基本单元，每个标签有唯一路径(如0:1:2)，支持层次结构
属性(TDF_Attribute): 存储实际数据，如几何形状(TNaming_NamedShape)、名称(TDataStd_Name)、数值(TDataStd_Integer)等

1.2 架构优势

OCAF提供了以下服务，简化CAD应用开发:

| 开发任务 | 不使用OCAF | 使用OCAF |
|--------------|-------------------|----------------|
| 创建几何 | 用户实现        | 用户实现 |
| 数据组织 | 用户实现        | 简化 |
| 文件存储 | 用户实现        | 提供 |
| 文档视图管理 | 用户实现 | 提供 |
| 应用基础设施 | 用户实现 | 提供 |
| 撤销与重做 | 用户实现     | 提供 |

2. OCAF项目构建步骤

2.1 环境配置

首先确保项目中包含必要的OCCT库，特别是TKCAF、TKLCAF和TKBin模块。

2.2 创建OCAF文档
#include <TDocStd_Application.hxx>
#include <TDocStd_Document.hxx>
#include <BinLDrivers.hxx>

Handle(TDocStd_Document) CreateOCAFDocument() {
    // 创建应用实例
    Handle(TDocStd_Application) app = new TDocStd_Application();
    
    // 注册二进制格式支持
    BinLDrivers::DefineFormat(app); 
    
    // 创建新文档
    Handle(TDocStd_Document) doc;
    app->NewDocument("BinXCAF", doc);
    
    return doc;
}
 

2.3 添加标签和属性
#include <TDataStd_Name.hxx>
#include <TDataStd_Integer.hxx>
#include <TNaming_NamedShape.hxx>
#include <TopoDS_Shape.hxx>

void AddLabelData(const Handle(TDocStd_Document)& doc) {
    // 获取根标签
    TDF_Label root = doc->Main(); 
    
    // 添加子标签
    TDF_Label comp1 = root.NewChild();
    TDF_Label shape1 = comp1.NewChild();
    
    // 添加名称属性
    comp1.AddAttribute(TDataStd_Name::Set(comp1, "Component1"));
    
    // 添加整数属性
    TDataStd_Integer::Set(comp1, 42);
    
    // 添加形状属性(假设已创建形状)
    TopoDS_Shape someShape; 
    TNaming_NamedShape::Set(shape1, someShape);
}
 

2.4 遍历标签结构
#include <TDF_ChildIterator.hxx>

void TraverseLabels(const TDF_Label& label, int depth = 0) {
    TCollection_AsciiString entry;
    label.Entry(entry);
    std::cout << std::string(depth * 2, ' ') << "Label: " << entry.ToCString() << std::endl;
    
    // 递归遍历子标签
    for (TDF_ChildIterator it(label); it.More(); it.Next()) {
        TraverseLabels(it.Value(), depth + 1);
    }
}
 

3. 数据持久化

OCAF支持多种格式的数据持久化，包括二进制(BinXCAF)和XML(XmlXCAF)格式。

3.1 保存文档
#include <BinLDrivers.hxx>
#include <BinLDriver.hxx>

void SaveDocument(const Handle(TDocStd_Document)& doc, const std::string& filename) {
    BinLDriver::Write(doc, filename.c_str());
}
 

3.2 加载文档
Handle(TDocStd_Document) LoadDocument(const std::string& filename) {
    Handle(TDocStd_Application) app = new TDocStd_Application();
    BinLDrivers::DefineFormat(app);
    Handle(TDocStd_Document) doc;
    app->Open(filename.c_str(), doc);
    return doc;
}
 

4. 高级功能实现

4.1 撤销/重做机制

OCAF内置了强大的撤销/重做功能，通过事务(Transaction)机制实现:
// 开始事务
doc->NewCommand();

// 执行修改操作
TDF_Label newLabel = root.NewChild();
newLabel.AddAttribute(TDataStd_Name::Set(newLabel, "NewComponent"));

// 提交事务
doc->CommitCommand();

// 撤销
doc->Undo();

// 重做
doc->Redo();
 

4.2 引用键模型(Reference-Key Model)

OCAF使用引用键模型维护数据标识，特别是在参数化建模中:

1. 几何形状作为Shape属性的值存储在标签上
2. 修改参数时，命名算法(Naming)维护拓扑元素的引用
3. 即使形状改变，属性仍附着在正确的拓扑元素上

4.3 工具类使用

OCAF提供了一系列工具类简化常见操作:

| 工具类                           | 功能                      |
|--------------------------------|--------------------------|
| XCAFDoc_ShapeTool   | 管理形状数据(TopoDS_Shape) |
| XCAFDoc_ColorTool     | 管理颜色属性 |
| XCAFDoc_LayerTool     | 管理图层信息 |
| XCAFDoc_MaterialTool | 管理材料属性 |

使用示例:
#include <XCAFDoc_ShapeTool.hxx>
#include <XCAFDoc_ColorTool.hxx>

// 获取形状工具
Handle(XCAFDoc_ShapeTool) shapeTool = XCAFDoc_DocumentTool::ShapeTool(doc->Main());

// 添加形状到文档
TDF_Label shapeLabel = shapeTool->AddShape(someShape);

// 获取颜色工具并设置颜色
Handle(XCAFDoc_ColorTool) colorTool = XCAFDoc_DocumentTool::ColorTool(doc->Main());
colorTool->SetColor(shapeLabel, Quantity_Color(1.0, 0.0, 0.0, Quantity_TOC_RGB), XCAFDoc_ColorGen);
 

5. 实际应用案例

5.1 CAD装配体管理
// 创建装配体结构
TDF_Label assemblyLabel = shapeTool->NewShape();
TDF_Label part1Label = shapeTool->AddComponent(assemblyLabel, part1Shape);
TDF_Label part2Label = shapeTool->AddComponent(assemblyLabel, part2Shape);

// 设置部件属性
part1Label.AddAttribute(TDataStd_Name::Set(part1Label, "Part1"));
part2Label.AddAttribute(TDataStd_Name::Set(part2Label, "Part2"));

// 设置装配体位置
gp_Trsf location;
location.SetTranslation(gp_Vec(10.0, 0.0, 0.0));
shapeTool->SetLocation(part2Label, location);
 

5.2 参数化建模
// 创建参数化圆柱体
Standard_Real radius = 5.0;
Standard_Real height = 10.0;

// 创建底部圆
TDF_Label bottomLabel = root.NewChild();
gp_Pnt bottomCenter(0, 0, 0);
Handle(TNaming_NamedShape)::Set(bottomLabel, BRepBuilderAPI_MakeVertex(bottomCenter));

// 创建顶部圆
TDF_Label topLabel = root.NewChild();
gp_Pnt topCenter(0, 0, height);
Handle(TNaming_NamedShape)::Set(topLabel, BRepBuilderAPI_MakeVertex(topCenter));

// 创建圆柱体侧面
TDF_Label cylinderLabel = root.NewChild();
TopoDS_Shape cylinder = BRepPrimAPI_MakeCylinder(radius, height);
Handle(TNaming_NamedShape)::Set(cylinderLabel, cylinder);

// 更新参数
void UpdateCylinder(TDF_Label cylinderLabel, Standard_Real newRadius, Standard_Real newHeight) {
    // 获取当前形状
    Handle(TNaming_NamedShape) namedShape;
    if (cylinderLabel.FindAttribute(TNaming_NamedShape::GetID(), namedShape)) {
        TopoDS_Shape newCylinder = BRepPrimAPI_MakeCylinder(newRadius, newHeight);
        TNaming_Builder builder(cylinderLabel);
        builder.Generated(newCylinder);
    }
}
 

6. 最佳实践与性能优化

1. 合理组织标签结构:
   - 使用有意义的层次结构(如装配体->部件->特征)
   - 为关键标签添加名称属性方便查找

2. 高效属性访问:
   // 避免频繁查找属性
   Handle(TDataStd_Name) nameAttr;
   if (label.FindAttribute(TDataStd_Name::GetID(), nameAttr)) {
       TCollection_ExtendedString name = nameAttr->Get();
       // 使用名称
   }
   

3. 事务管理:
   - 将相关操作分组到单个事务中
   - 避免在事务中包含用户交互

4. 自定义属性:
   - 尽量使用现有属性组合而非继承创建新属性
   - 必须创建新属性时实现复制和持久化方法

5. 二进制存储优化:
   - 对于大型模型，使用TKBin模块进行二进制存储
   - 考虑使用压缩选项减少文件大小

 7. 常见问题解决

1. 数据丢失问题:
   - 确保所有修改在事务中完成
   - 提交事务前检查错误

2. 性能瓶颈:
   - 避免深层嵌套标签结构
   - 对大模型使用延迟加载策略

3. 版本兼容性:
   - 使用标准属性提高兼容性
   - 为自定义属性提供版本转换机制

4. 多线程访问:
   - OCAF不是线程安全的
   - 使用锁机制或每个线程使用独立文档

OCAF框架为CAD应用开发提供了强大的基础设施，通过合理利用其层次化数据管理、事务机制和内置工具类，可以显著提高开发效率并确保数据一致性。掌握OCAF的核心概念和最佳实践是构建稳健CAD应用的关键。