DbDimension.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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_DBDIM_H
#define OD_DBDIM_H
 
#include "TD_PackPush.h"
 
#include "DbEntity.h"
#include "DbMText.h"
#include "Ge/GeScale3d.h"
 
class OdDbDimStyleTableRecord;
 
typedef OdSmartPtr<OdDbDimStyleTableRecord> OdDbDimStyleTableRecordPtr;
 
class TOOLKIT_EXPORT OdDbDimension : public OdDbEntity
{
public:
  ODDB_DECLARE_MEMBERS(OdDbDimension);
 
  OdDbDimension();
 
  OdGePoint3d textPosition() const;
  
  void setTextPosition(
    const OdGePoint3d& textPosition);
 
  bool isUsingDefaultTextPosition() const;
 
  void useSetTextPosition();
 
  void useDefaultTextPosition();
 
  OdGeVector3d normal() const;
 
  void setNormal(
    const OdGeVector3d& normal);
 
  virtual bool isPlanar() const { return true; }
 
  virtual OdResult getPlane(
    OdGePlane& plane, 
    OdDb::Planarity& planarity) const;
 
  double elevation() const;
 
  void setElevation(
    double elevation);
 
  const OdString dimensionText() const;
 
  void setDimensionText(
    const OdString& dimensionText);
    
  double textRotation() const;
 
  void setTextRotation(
    double textRotation);
 
  OdDbObjectId dimensionStyle() const;
 
  void setDimensionStyle(
    OdDbObjectId objectID);
 
  OdDbMText::AttachmentPoint textAttachment() const;
 
  void setTextAttachment(
    OdDbMText::AttachmentPoint attachmentPoint);
 
  OdDb::LineSpacingStyle textLineSpacingStyle() const;
 
  void setTextLineSpacingStyle(
    OdDb::LineSpacingStyle lineSpacingStyle);
 
  double textLineSpacingFactor() const;
 
  void setTextLineSpacingFactor(
    double lineSpacingFactor);
 
  void getDimstyleData(
    OdDbDimStyleTableRecord *pRecord) const;
 
  void setDimstyleData(
    const OdDbDimStyleTableRecord* pDimstyle);
    
  void setDimstyleData(
    OdDbObjectId dimstyleID);
 
  double horizontalRotation() const;
 
  void setHorizontalRotation(
    double horizontalRotation);
 
 
  OdDbObjectId dimBlockId() const;
 
  void setDimBlockId(
    const OdDbObjectId& dimBlockId, 
    bool singleReferenced = true);
 
  bool isSingleDimBlockReference() const;
 
  OdGePoint3d dimBlockPosition() const;
 
  void setDimBlockPosition(
    const OdGePoint3d& dimBlockPosition);
 
 
  double dimBlockRotation() const;
 
  void setDimBlockRotation(
    double dimBlockRotation);
 
  OdGeScale3d dimBlockScale() const;
 
  void setDimBlockScale(
    const OdGeScale3d& dimBlockScale);
 
  OdGeMatrix3d dimBlockTransform() const;
  
  void recomputeDimBlock(
    bool forceUpdate = true);
 
  double getMeasurement() const;
 
  double measurement();
 
 
  // 2005-2006 support
  
  OdUInt16 getBgrndTxtColor(OdCmColor& bgrndTxtColor) const;
  
  void setBgrndTxtColor(const OdCmColor& bgrndTxtColor, OdUInt16 bgrndTxtFlags );
 
  bool getExtLineFixLenEnable() const;
 
  void setExtLineFixLenEnable(bool extLineFixLenEnable);
 
  double getExtLineFixLen() const;
 
  void setExtLineFixLen(double extLineFixLen);
 
  OdDbObjectId getDimLinetype() const;
 
  void setDimLinetype(const OdDbObjectId& linetypeId);
 
  OdDbObjectId getDimExt1Linetype() const;
 
  void setDimExt1Linetype(const OdDbObjectId& linetypeId);
 
  OdDbObjectId getDimExt2Linetype() const;
 
  void setDimExt2Linetype(const OdDbObjectId& linetypeId);
 
  bool getArrowFirstIsFlipped() const;
 
  bool getArrowSecondIsFlipped() const;
  
  void setArrowFirstIsFlipped(bool bIsFlipped);
 
  void setArrowSecondIsFlipped(bool bIsFlipped);
 
  enum DimInspect 
  {
    kShapeRemove  = 0x00,     // No inspection label displays.
    kShapeRound   = 0x01,     // Inspection label displays with a rounded end (this is the default).
    kShapeAngular = 0x02,     // Inspection label displays with an angular end.
    kShapeNone    = 0x04,     // Inspection label displays without a bounding shape.
    kShapeLabel   = 0x10,     // Inspection label displays with a prefix, including a separator and alpha field.
    kShapeRate    = 0x20      // Inspection label displays at a specified frequency.
  };
 
  bool inspection() const;
  void setInspection(bool val);
 
  int inspectionFrame() const;
  void setInspectionFrame(int frame);
 
  OdString inspectionLabel() const;
  void setInspectionLabel(const OdString& label);
 
  OdString inspectionRate() const;
  void setInspectionRate(const OdString& label);
 
#define VAR_DEF(type, name, dxf, def_value, metric_def_value, reserve1, reserve2)\
 \
  virtual type dim##name() const; \
\
 \
virtual void setDim##name(type val);
#include "DimVarDefs.h"
#undef  VAR_DEF
 
  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;
 
  OdResult subGetClassID(void* pClsid) const;
 
  OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const;
 
  bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
 
  void subViewportDraw(
    OdGiViewportDraw* pVd) const;
 
  /* Replace OdRxObjectPtrArray */
  
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE; 
 
  void subClose();
 
  virtual void modified (
    const OdDbObject* pObject);
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm) ODRX_OVERRIDE;
  
  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& xfm, 
    OdDbEntityPtr& pCopy) const ODRX_OVERRIDE;
 
  void subSetDatabaseDefaults(
    OdDbDatabase *pDb,
    bool doSubents);
 
  virtual void appendToOwner(
    OdDbIdPair& idPair, 
    OdDbObject* pOwnerObject, 
    OdDbIdMapping& ownerIdMap) ODRX_OVERRIDE;
 
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
 
  void formatMeasurement(
    OdString& formattedMeasurement, 
    double measurementValue, 
    const OdString& dimensionText);
 
  OdResult explodeGeometry(OdRxObjectPtrArray& entitySet) const;
 
  OdDbObjectPtr dimBlock(OdDb::OpenMode openMode = OdDb::kForRead);
 
  /*
      void generateLayout();
      void getOsnapPoints(OdDb::OsnapMode osnapMode, const OdDbFullSubentPath& subentId,
                          const OdGePoint3d& pickPoint, const OdGePoint3d& lastPoint,
                          const OdGeMatrix3d& viewXform, OdGePoint3dArray& snapPoints,
                          OdDbIntArray& geomIds ) const;
  */
 
  virtual OdResult subGetCompoundObjectTransform(OdGeMatrix3d & xM) const ODRX_OVERRIDE;
 
  // Dynamic dimensions support
  // (The methods are NOT related to constraint support)
  
  bool isDynamicDimension() const;
  void setDynamicDimension(
    bool bDynamic);
 
  // Dimensional constraint support
 
  bool isConstraintObject() const;
  OdResult isConstraintObject(
    bool& isConstraintObject,
    bool& hasExpression,
    bool& isReferenceConstraint) const;
 
  bool  isConstraintDynamic() const;
  OdResult setConstraintDynamic(
    bool bDynamic);
 
  bool  shouldParticipateInOPM() const;
  void  setShouldParticipateInOPM(
    bool bShouldParticipate);
  
  void setDIMTALN(bool val);
  bool getDIMTALN() const;
 
  void removeTextField();
  void fieldToMText(OdDbMTextPtr& pDimMText);
  void fieldFromMText(OdDbMTextPtr& pDimMText);
 
  OdGeMatrix3d getEcs( ) const;
  
  void resetTextDefinedSize();
 
  void setTextDefinedSize(
    double width,
    double height);
 
  void textDefinedSize(
    double& width,
    double& height) const;
 
};
 
typedef OdSmartPtr<OdDbDimension> OdDbDimensionPtr;
 
class OdDbDimensionObjectContextData;
 
class TOOLKIT_EXPORT OdDbDimensionRecomputePE : public OdRxObject
{
public:
  static void setMeasurementValue(OdDbDimension* pDimension, double measurementValue);
  static void resetDimBlockInsertParams(OdDbDimension* pDimension);
 
  ODRX_DECLARE_MEMBERS(OdDbDimensionRecomputePE);
 
  virtual void recomputeDimMeasurement(OdDbDimension* pDimension) = 0;
 
  virtual void recomputeDimBlock(OdDbDimension* pDimension, OdDbDimensionObjectContextData* ctx) = 0;
 
 
  virtual void formatMeasurement(OdDbDimension* pDimension, OdString& formattedMeasurement, 
     double measurementValue, const OdString& dimensionText ) = 0;
};
 
typedef OdSmartPtr<OdDbDimensionRecomputePE> OdDbDimensionRecomputePEPtr;
 
#include "TD_PackPop.h"
 
#endif