ObjectArx 自定义实体

admin1

[code]1.arx文档中规定的必须重写的几个函数

//AcDbObject:
virtual Acad::ErrorStatus
dwgInFields(AcDbDwgFiler* filer);

virtual Acad::ErrorStatus
dwgOutFields(AcDbDwgFiler* filer) const;

virtual Acad::ErrorStatus
dxfInFields(AcDbDxfFiler* filer);

virtual Acad::ErrorStatus
dxfOutFields(AcDbDxfFiler* filer) const;
//AcDbEntity
virtual Adesk::Boolean      
subWorldDraw(
    AcGiWorldDraw* mode);

virtual Acad::ErrorStatus   
subGetGeomExtents(
    AcDbExtents& extents) const;

virtual Acad::ErrorStatus   
subTransformBy(
    const AcGeMatrix3d& xform);

virtual Acad::ErrorStatus   
subGetTransformedCopy(
    const AcGeMatrix3d& xform,
    AcDbEntity*& ent) const;

virtual Acad::ErrorStatus   
subGetGripPoints(
    AcGePoint3dArray& gripPoints,
    AcDbIntArray&  osnapModes,
    AcDbIntArray&  geomIds) const;

virtual Acad::ErrorStatus
subMoveGripPointsAt(
    const AcDbIntArray& indices,
    const AcGeVector3d& offset);
以上函数是文档中规定的必须重写的函数
2.实际工作中要求的必须重载
1）实际工作中必须重载的函数
virtual Adesk::Boolean      
subWorldDraw(
    AcGiWorldDraw* mode);
分析：从函数的名称我们就可以判断出，这个是自定义实体的外观，相信如果外观都不需要的情况在实际工作中应该是很少出现的
应用情形：
最典型的当属于Jig，只是为了实现动态效果的实体，并不需要自定义实体存档,说白了就是只起到一个临时实体的作用（为什么称作临时实体，只在Jig运行期间出现，Jig完成之后立即释放）,在这种情形下，其余文档中要求的重载都可不必实现
3.实例讲解
我们只写一个最简单的实例，来讲解一下自定义实体每一个被重写的函数的意义
自定义实体要实现的效果：
绘制一个圆，并且能够设置颜色
1).h
class CCustomColorCircle:public AcDbEntity
{
public:
   ACRX_DECLARE_MEMBERS(CCustomColorCircle);
   CCustomColorCircle(AcGePoint3d centerPt);
   ~CCustomColorCircle() ;
proctected:
  virtual Acad::ErrorStatus dwgInFields(AcDbDwgFiler* filer);
virtual Acad::ErrorStatus dwgOutFields(AcDbDwgFiler* filer) const;
  virtual Acad::ErrorStatus dxfInFields(AcDbDxfFiler* filer);

  virtual Acad::ErrorStatus dxfOutFields(AcDbDxfFiler* filer) const;
  virtual Adesk::Boolean      subWorldDraw(AcGiWorldDraw* mode);

  virtual Acad::ErrorStatus   subGetGeomExtents(AcDbExtents& extents) const;

  virtual Acad::ErrorStatus   subTransformBy(const AcGeMatrix3d& xform);

  virtual Acad::ErrorStatus   subGetTransformedCopy(const AcGeMatrix3d& xform,AcDbEntity*& ent) const;

  virtual Acad::ErrorStatus   subGetGripPoints(AcGePoint3dArray& gripPoints,AcDbIntArray&  osnapModes,AcDbIntArray&  geomIds) const;

  virtual Acad::ErrorStatus   subMoveGripPointsAt( const AcDbIntArray& indices,const AcGeVector3d& offset);
public:
  virtual Acad::ErrorStatus   setColorIndex(Adesk::UInt16 color, Adesk::Boolean doSubents=true);
private:
  //圆心
  AcGePoint3d m_CenterPoint ;
};
2)cpp
//首先是要加入的动态识别一些函数的实现
ACRX_DXF_DEFINE_MEMBERS(CCustomColorCircle, AcDbEntity, AcDb::kDHL_CURRENT,
    AcDb::kMReleaseCurrent, 0, CUSTOMCIRCLE, /*MSG0*/"TSZ");
MAKE_ACDBOPENOBJECT_FUNCTION(CCustomColorCircle) ;
/*
在源文件中我们来分析每个函数的实现，以及它们在什么情况下被调用
*/
/*
这里定义一个版本号，随着版本的提升，数据也可能发生变化，有可能增加，有可能减少，所以针对不同的版本
必须用不同的方式进行处理（序列化与反序列化也是必须的）
*/
#define VERSION 1
//我们知道针对非自定义实体，不是每一种类型的实体，对其设置setColorIndex都能起作用，同理如果你想让你的自定义实体能够通过setColorIndex设置颜色，必须重写这个函数
virtual Acad::ErrorStatus   CCustomColorCircle::setColorIndex(Adesk::UInt16 color, Adesk::Boolean doSubents=true)
{
     return AcDbEntity::setColorIndex( color , doSubents ) ;
}
/*
用途：这个函数就是你自定义实体的几何表现，说白了你要让你自定义的实体以何种面目示人
当调用如下函数时会被调用：所有调用更新绘制的时候
不实现会发生什么:（不实现无任何意义）
*/
virtual Adesk::Boolean      CCustomColorCircle::subWorldDraw(AcGiWorldDraw* mode)
{
     //因为能够通过setColorIndex设置颜色，在这里设置一下
     int colorIndex = this->colorIndex ;
     mode->subEntityTraits().setColor( colorIndex ) ;
     //接下来绘制圆，这里为了简单（偷懒）我们对圆的半径设置一个固定的值
     double dCircleRadius = 200.0 ;
     mode->geometry().circle( m_CenterPoint , dCircleRadius , AcGeVector3d::kZAxis ) ;
     return Adesk::kTrue ;
}
/*
用途：获得一个实体的范围（一个极大点  一个极小点）
当调用如下函数时会被调用：CCustomColorCircle.getGeomExtents
不实现会发生什么:得到的范围无意义（得到的极大点 和极小点的坐标都是没有意义的浮点数）
*/
virtual Acad::ErrorStatus   CCustomColorCircle::subGetGeomExtents(AcDbExtents& extents) const
{
     extents.addPoint( m_CenterPoint + sqrt(2)*200.0*AcGeVector3d(1,1,0) ) ;
     extents.addPoint( m_CenterPoint - sqrt(2)*200.0*AcGeVector3d(1,1,0) ) ;
     return Acad::eOk ;
}
/*
用途：dwgIn：利用图纸初始化数据成员（反序列化）  dwgOut：将当前数据成员写入图纸(序列化)
深入分析：想象一种情况，你建立了一个自定义实体添加到模型空间中，然后保存图纸->关闭图纸,然后再次打开图纸，这时你利用ID打开自定义实体，这时数据成员应该如何初始化？
如果你想通了，就能够明白为什么要这么做，其实就是序列化与反序列化，因为dwg是一个存储在硬盘上的文件
这也就意味着，每一个数据成员都需要需要序列化与反序列化（这是保证你的自定义实体能够使用的基本条件）
在什么时候被调用（不一定每一次都发生）：dwgin：save  saveas  wblock insert copy purge
                                 dwgOut：wblock save saveas acdbEntGet
*/
virtual Acad::ErrorStatus CCustomColorCircle::dwgInFields(AcDbDwgFiler* filer)
{
assertWriteEnabled() ;
if ( AcDbEntity::dwgInFields ( filer ) != Acad::eOk )
{
return filer->filerStatus() ;
}
int version ;
filer->readItem(&version);
filer->readItem( &m_CenterPoint ) ;
return filer->filerStatus() ;
}
virtual Acad::ErrorStatus CCustomColorCircle::dwgOutFields(AcDbDwgFiler* filer) const
{
assertReadEnabled() ;
if ( AcDbEntity::dwgOutFields ( filer ) != Acad::eOk )
{
return filer->filerStatus() ;
}
filer->writeItem( VERSION ) ;
filer->writeItem( m_CenterPoint ) ;
return filer->filerStatus() ;
}
/*
dxfin 和dxfOut的意义按着我的理解是为了和dwg保持一致
并且dxf格式也是dwg自始至终都存的东西，并且在构建选择集的时候也很有用
*/
virtual Acad::ErrorStatus CCustomColorCircle::dxfInFields(AcDbDxfFiler* filer)
{
assertWriteEnabled();
if( AcDbEntity::dxfInFields(filer) != Acad::eOk ||
filer->atSubclassData( _T("CCustomColorCircle") ) )
{
return filer->filerStatus() ;
}
//读取版本
     resbuf rb ;
     filer->readItem( &rb ) ;
     int iVersion = rb.resval.rint ;
     //读取圆心
  filer->readItem(&rb) ;
  m_CenterPoint = AcGePoint3d( rb.resval.rpoint[0] , rb.resval.rpoint[1] ,
rb.resval.rpoint[2] ) ;

}
virtual Acad::ErrorStatus CCustomColorCircle::dxfOutFields(AcDbDxfFiler* filer) const
{
     assertReadEnabled();
     Acad::ErrorStatus es ;
     if ( ( es = AcDbEntity::dxfOutFields(filer))
          != Acad::eOk )
     {
          return es ;
     }
    filer->wirteItem( AcDb::kDxfSubClass , _T("CCustomColorCircle") ) ;
    filer->writeInt16( AcDb::kDxfInt16 , VERSION ) ;
    filer->writePoint3d( AcDb::kDxfXCoord , m_CenterPoint ) ;
    return filer->filerStatus() ;
}
/*
用途：选中一下cad提供的实体，例如直线，你会看到三个点（起点 中点  和 终点），选中一个圆，你会看到一个圆心，选择圆弧，会看到三个点（圆弧起点 圆弧中点  圆弧圆心），并且通过拖动这些点能够实现简单的
编辑功能
不实现会发生什么：你选中你添加到空间中的实体，你会发现不会有特征点显示出来，也就无法通过用户交互的方式编辑这个实体（当然可以通过程序实现）
注意：在这里我们多添加几个点到gripPoints中（这个有助于我们分析subMoveGripPointsAt函数）
*/
virtual Acad::ErrorStatus   CCustomColorCircle::subGetGripPoints(AcGePoint3dArray& gripPoints,AcDbIntArray&  osnapModes,AcDbIntArray&  geomIds) const
{
     /*这里添加三个点 添加三个点的顺序很重要
     向gripPoints中填充点，这些点在实体被选中后，会显示出来
     */
     gripPoints.append( m_CenterPoint ) ;
     gripPoints.append( m_CenterPoint + 20 * AcGeVector3d::kXAxis ) ;
     gripPoints.append( m_CenterPoint - 20 * AcGeVector3d::kXAxis ) ;
}
/*
用途：subGetGripPoints只让可以被编辑的点被显示出来，但是真正发挥作用的却是subMoveGripPointsAt
这个函数决定了 当用户拖拽特征点的时候，实体应该如何变化
如果不实现会怎么样：不实现，你就只能看看，无法实现任意的编译功能
*/
virtual Acad::ErrorStatus   CCustomColorCircle::subMoveGripPointsAt( const AcDbIntArray& indices,const AcGeVector3d& offset)
{
     /*
     indices：用户选择的特征点的索引（和你在subGetGripPoints的填充顺序是一致的,从0开始）
     offset（拖拽产生的向量）
     */
     //在这里我们这其实只是一个圆，所以简单调用矩阵变换函数
     if ( indices.length() == 0 || offset.length() == 0 )
          return Acad::eOk ;
#ifdef _DEBUG
     //输出当前用户拖拽点的索引
     acutPrintf( _T("\n%d") , inDices)
#endif
     return transformBy( AcGeMatrix3d::translation(offset) ) ;//这个函数又会调用subTransformby
}
在dll的入口加入如下两行代码：
     CCustomColorCircle::rxInit() ;
acrxBuildClassHierarchy() ;
总结：
1）适用情况：
     通常情况下，并不建议使用自定义实体，但是有一种情况除外，作为jig的entity实体使用时，这时适用自定义实体再合适不过，而且只需
实现一个函数subWorldDraw（）,其余情况（说白了就是实体需要存在dwg文档中时），这里的原则是能不用就不用
2）如何学习：
     我这里也只做了一个基本的介绍，还有很多可以重写的函数，并且能够实现非常强大的功能，那么我们如和才能找到我们需要实现哪一个函数，
这里也有一个技巧，我们发现重载的基本上都会加上一个sub，比如我们对于cad已经提供的实体调用trans，那么在自定义实体中重载的就是sub，
当然这只符合一些编辑功能的重写，其余的要做到两点，最好将你想实现的效果，在cad提供的实体中通过，然后通过编程实现效果
3）给出代码的问题：
     我这是在外网机器上一行一行敲的，难免出现问题
4）进阶：
     在ObjectArx中提供了一个例子 samples/entity/polysamp,这个例子非常好
5）千万不要忘了
CCustomColorCircle::rxInit() ;
acrxBuildClassHierarchy() ;[/code]