DbBlockReference.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _OD_BLOCK_REFERENCE_
#define _OD_BLOCK_REFERENCE_
 
#include "TD_PackPush.h"
 
#include "DbEntity.h"
#include "DbDatabase.h"
#include "Ge/GeMatrix3d.h"
#include "DbObjectIterator.h"
#include "DwgDeclareMembers.h"
#include "DbBlockTableRecord.h"
#include "DbAttribute.h"
 
class OdGeScale3d;
class OdDbSequenceEnd;
class OdDbBlockReferenceImpl;

typedef OdSmartPtr<OdDbSequenceEnd> OdDbSequenceEndPtr;
 
//DOM-IGNORE-BEGIN
// Implementation detail
class OdDbAttributeCollectionView
{
  OdDbObjectIteratorPtr m_pIterator;
public:
  struct Iterator : OdDbStepIteratorWrap<OdDbObjectIterator>
  {
    using value_type = OdDbAttributePtr;
    using reference = OdDbAttributePtr;
    Iterator(const OdDbObjectIteratorPtr& i) : OdDbStepIteratorWrap<OdDbObjectIterator>(i) {}
    reference operator*() const { return OdDbAttributePtr(m_pIterator->entity()); }
  };
  OdDbAttributeCollectionView(const OdDbObjectIteratorPtr& i) : m_pIterator(i) {}
  Iterator begin() const { return Iterator(m_pIterator); }
  Iterator end() const { return Iterator(OdDbObjectIteratorPtr()); }
};
//DOM-IGNORE-END
 

class TOOLKIT_EXPORT OdDbBlockReference : public OdDbEntity
{
public:
  //DOM-IGNORE-BEGIN
  DWGMAP_DECLARE_MEMBERS(OdDbBlockReference);
  //DOM-IGNORE-END

  OdDbBlockReference();

  OdDbObjectId blockTableRecord() const;

  virtual void setBlockTableRecord(
    OdDbObjectId objectId);

  virtual OdGePoint3d position() const;

  virtual void setPosition(
    const OdGePoint3d& position);

  OdGeScale3d scaleFactors() const;

  virtual void setScaleFactors(
    const OdGeScale3d& scale);

  double rotation() const;

    virtual void setRotation(
    double angle);

  OdGeVector3d normal() const;

  virtual void setNormal(
    const OdGeVector3d& normal);

  virtual bool isPlanar() const { return true; }

  virtual OdResult getPlane(
    OdGePlane& plane,
    OdDb::Planarity& planarity) const;

  OdGeMatrix3d blockTransform() const;

  virtual OdResult setBlockTransform(
    const OdGeMatrix3d& xfm);

  OdDbObjectId appendAttribute(
    OdDbAttribute* pAttr);

  OdDbAttributePtr openAttribute(
    OdDbObjectId ObjId,
    OdDb::OpenMode mode,
    bool openErasedOne = false);

  OdDbSequenceEndPtr openSequenceEnd(
    OdDb::OpenMode mode);

  OdDbObjectIteratorPtr attributeIterator() const;
  
  OdDbAttributeCollectionView attributes() const { return OdDbAttributeCollectionView(attributeIterator()); }
  
  OdDbIdCollectionView attributeIds() const { return OdDbIdCollectionView(attributeIterator()); }

  virtual OdResult explodeToBlock(
    OdDbBlockTableRecord *BlockRecord,
    OdDbObjectIdArray *ids = 0);

  OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const;

  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;

  virtual void subViewportDraw(OdGiViewportDraw* pVd) const;

  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);

  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;

  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual OdResult dxfInFields_R12(OdDbDxfFiler* pFiler);

  virtual void dxfOutFields_R12(
  OdDbDxfFiler* pFiler) const;

  virtual OdResult dxfIn(
    OdDbDxfFiler* pFiler);

  virtual void dxfOut(
    OdDbDxfFiler* pFiler) const;

  void subClose();

  virtual OdResult subGetClassID(
    void* pClsid) const;

  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm) ODRX_OVERRIDE;

  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& xfm,
    OdDbEntityPtr& pCopy) const ODRX_OVERRIDE;
 
 /* Replace OdRxObjectPtrArray */
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE;

  void subHandOverTo(
    OdDbObject* pNewObject);

  OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const;

  OdResult explodeGeometry(OdRxObjectPtrArray& entitySet) const;

  virtual bool treatAsOdDbBlockRefForExplode() const;

  OdResult geomExtentsBestFit(OdGeExtents3d& extents,
                              const OdGeMatrix3d& parentXform = OdGeMatrix3d::kIdentity) const;

  virtual OdResult explodeToOwnerSpace() const;

  virtual void copyFrom(const OdRxObject* pSrc) ODRX_OVERRIDE;

  ODRX_SEALED_VIRTUAL OdResult subGetCompoundObjectTransform(OdGeMatrix3d & xM) const ODRX_OVERRIDE;

  ODRX_SEALED_VIRTUAL OdResult subGetSubentPathsAtGsMarker(OdDb::SubentType type,
                                    OdGsMarker gsMark,
                                    const OdGePoint3d& pickPoint,
                                    const OdGeMatrix3d& viewXform,
                                    OdDbFullSubentPathArray& subentPaths,
                                    const OdDbObjectIdArray* pEntAndInsertStack) const ODRX_OVERRIDE;

  ODRX_SEALED_VIRTUAL OdResult subGetGsMarkersAtSubentPath(const OdDbFullSubentPath& subPath,
                                    OdGsMarkerArray& gsMarkers) const ODRX_OVERRIDE;
};
 

typedef OdSmartPtr<OdDbBlockReference> OdDbBlockReferencePtr;
 
TOOLKIT_EXPORT void decompTransform(
    const OdGeMatrix3d& mTrans,
    OdGePoint3d& pOrigin,
    OdGeScale3d& sScale,
    double & dRotation,
    OdGeVector3d& vNormal );
TOOLKIT_EXPORT void decompTransform(
    OdGeVector3d& normal,
    OdGePoint3d& position,
    OdGeScale3d& scale,
    double& rotationAngle,
    const OdGeMatrix3d& transformMat,
    const OdDbBlockTableRecordPtr pBlockTableRecord);
 
#include "TD_PackPop.h"
 
#endif