DbMLeader.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_MLEADER_H
#define OD_MLEADER_H
 
#include "TD_PackPush.h"
#include "DbMLeaderStyle.h"
#include "DbEntity.h"
#include "DbSubentId.h"
#include "DbAttribute.h"
#include "IntArray.h"
 
#define MAX_LEADER_NUMBER     5000
#define MAX_LEADERLINE_NUMBER 5000
 
class OdDbAttribute;
class OdDbMLeaderObjectContextData;

class DBDIM_EXPORT OdDbMLeader : public OdDbEntity
{
public:
  enum MoveType {
    kMoveAllPoints,

    kMoveAllExceptArrowHeaderPoints,

    kMoveContentAndDoglegPoints
  };

  enum gsMarkType {
    kNone               = 0,

    kArrowMark          = 1,

    kLeaderLineMark     = kArrowMark  + MAX_LEADERLINE_NUMBER,

    kDoglegMark         = kLeaderLineMark + MAX_LEADERLINE_NUMBER,

    kMTextMark          = kDoglegMark + MAX_LEADER_NUMBER,

    kMTextUnderLineMark = kMTextMark + 1,

    kToleranceMark      = kMTextUnderLineMark + 1,

    kBlockMark          = kToleranceMark + 1,

    kBlockAttribute     = kBlockMark + 1
  };

  enum PropertyOverrideType {
    kLeaderLineType         = 0,

    kLeaderLineColor        = 1,

    kLeaderLineTypeId       = 2,

    kLeaderLineWeight       = 3,

    kEnableLanding          = 4,

    kLandingGap             = 5,

    kEnableDogleg           = 6,

    kDoglegLength           = 7,

    kArrowSymbolId          = 8,

    kArrowSize              = 9,

    kContentType            = 10,

    kTextStyleId            = 11,

    kTextLeftAttachmentType = 12,

    kTextAngleType          = 13,

    kTextAlignmentType      = 14,

    kTextColor              = 15,

    kTextHeight             = 16,

    kEnableFrameText        = 17,

    kDefaultMText           = 18,

    kBlockId                = 19,

    kBlockColor             = 20,

    kBlockScale             = 21,

    kBlockRotation          = 22,

    kBlockConnectionType    = 23,

    kScale                  = 24,

    kTextRightAttachmentType = 25,

    kTextSwitchAlignmentType = 26,

    kTextAttachmentDirection = 27,

    kTextTopAttachmentType   = 28,

    kTextBottomAttachmentType = 29,

    kExtendLeaderToText      = 30,

    kSize = kExtendLeaderToText + 1
  };
 
 
  ODDB_DECLARE_MEMBERS(OdDbMLeader);
 
  OdDbMLeader();
 
  virtual OdResult dwgInFields (OdDbDwgFiler* filer) ODRX_OVERRIDE;
 
  virtual void dwgOutFields(OdDbDwgFiler* filer) const ODRX_OVERRIDE;
 
  virtual OdResult dxfInFields (OdDbDxfFiler* filer) ODRX_OVERRIDE;
 
  virtual void dxfOutFields(OdDbDxfFiler* filer) const ODRX_OVERRIDE;
 
protected:
  virtual bool subWorldDraw(OdGiWorldDraw* pWd) const ODRX_OVERRIDE;
 
  virtual void  subViewportDraw(OdGiViewportDraw* mode) const ODRX_OVERRIDE;
 
  virtual OdResult subTransformBy(const OdGeMatrix3d& xform) ODRX_OVERRIDE;
 
  virtual OdResult subMoveGripPointsAt(const OdIntArray& indices, const OdGeVector3d& offset);

 
  virtual OdResult subGetSubentPathsAtGsMarker(OdDb::SubentType type, OdGsMarker gsMark, 
                                                                                const OdGePoint3d& pickPoint,const OdGeMatrix3d& xfm, 
                                                                                OdDbFullSubentPathArray& subentPaths, 
                                                                                const OdDbObjectIdArray* pEntAndInsertStack = 0) const ODRX_OVERRIDE;

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

 
  virtual OdResult subDeleteSubentPaths(const OdDbFullSubentPathArray& paths) ODRX_OVERRIDE;

 
  virtual OdDbEntityPtr subSubentPtr(const OdDbFullSubentPath& path) const ODRX_OVERRIDE;
 
  virtual void subClose() ODRX_OVERRIDE;
 
  virtual OdResult subExplode(OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE;
 
  virtual OdResult subGetGeomExtents(OdGeExtents3d& extents) const ODRX_OVERRIDE;
 
  virtual OdResult subGetClassID(
    void* pClsid) const ODRX_OVERRIDE;
 
//#if 0
//
//  virtual OdResult getGripEntityUCS(
//    const void* pGripAppData,
//    OdGeVector3d& normalVec,
//    OdGePoint3d& origin,
//    OdGeVector3d& xAxis) const;
//
//  virtual void  gripStatus(
//    const OdDb::GripStat status);
//
//#endif
 
  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& xform,
    OdDbEntityPtr& pEnt) const;
 
 
public:
  void setOverride(
    PropertyOverrideType propertyType,
    bool isOverride = true);

  bool  isOverride(
    PropertyOverrideType propertyType) const;

  OdResult setScale(
    double scale);

  double  scale() const;

  OdResult getBlockAttributeValue(
    OdDbObjectId attdefId,
    OdDbAttributePtr& pAtt) const;

  OdResult setBlockAttributeValue(
    OdDbObjectId attdefId,
    const OdDbAttribute* pAtt);

  OdGePlane plane() const;

  void  setPlane(
    const OdGePlane& plane);
 
  OdGeVector3d  normal() const;

  OdResult moveMLeader(
    const OdGeVector3d& vector,
    MoveType moveType,
    bool bAutoSwitchDogleg = true);

  OdResult getContentGeomExtents(
    OdGeExtents3d& extents) const;
 
  // Deprecated (Instead, use the method getLeaderIndexes(...))
  int numLeaders() const;

  void getLeaderIndexes(
    OdIntArray& leaderIndexes) const;

  void addLeader(
    int& leaderIndex);

  void removeLeader(
    int leaderIndex);
 
  // Deprecated (Instead, use the method getLeaderLineIndexes(...))
  int numLeaderLines() const;

  void getLeaderLineIndexes(
    OdIntArray& leaderLineIndexes) const;

  OdResult addLeaderLine(
    int leaderIndex, 
    int& leaderLineIndex);

  OdResult addLeaderLine(
    const OdGePoint3d& point, 
    int& leaderLineIndex);

  void removeLeaderLine(
    int leaderLineIndex);

  OdResult addFirstVertex(
    int leaderLineIndex, const OdGePoint3d& point);

  OdResult removeFirstVertex(
    int leaderLineIndex);

  OdResult getFirstVertex(
    int leaderLineIndex, 
    OdGePoint3d& point) const;

  OdResult setFirstVertex(
    int leaderLineIndex, 
    const OdGePoint3d& point);

  OdResult addLastVertex(
    int leaderLineIndex,
    const OdGePoint3d& point);

  OdResult removeLastVertex(
    int leaderLineIndex);

  OdResult getLastVertex(
    int leaderLineIndex,
    OdGePoint3d& point) const;

  OdResult setLastVertex(
    int leaderLineIndex,
    const OdGePoint3d& point);

  OdResult numVertices(
    int leaderLineIndex, 
    int& num) const;

  OdResult setVertex(
    int leaderLineIndex,
    int index,
    const OdGePoint3d& point);

  void getVertex(
    int leaderLineIndex,
    int index, OdGePoint3d& point) const;

  void getLeaderIndex(
    int leaderLineIndex,
    int& leaderIndex) const; 

  void getLeaderLineIndexes(
    int leaderIndex,
    OdIntArray& leaderLineIndexes) const;

  void setDoglegDirection(
    int leaderIndex,
    const OdGeVector3d& vector);

  void getDoglegDirection(
    int leaderIndex,
    OdGeVector3d& vector) const;

  void setLeaderLineType(
    OdDbMLeaderStyle::LeaderType leaderLineType);

  OdDbMLeaderStyle::LeaderType  leaderLineType() const;

  void setLeaderLineColor(
    const OdCmColor& leaderLineColor);

  OdCmColor leaderLineColor() const;

  void setLeaderLineTypeId(
    OdDbObjectId leaderLineTypeId);

  OdDbObjectId  leaderLineTypeId() const;

  void setLeaderLineWeight(
    OdDb::LineWeight leaderLineWeight);

  OdDb::LineWeight leaderLineWeight() const;

  void setLandingGap(
    double landingGap);

  double landingGap() const;

  void setEnableLanding(
    bool enableLanding);

  bool enableLanding() const;

  void setEnableDogleg(
    bool enableDogleg);

  bool enableDogleg() const;

  void setDoglegLength(
    int leaderIndex,
    double dDoglegLength);

  double doglegLength(
    int leaderIndex) const;
 
  //deprecated 
  OdResult    setDoglegLength        (double doglegLength);
  //deprecated 
  double      doglegLength           () const;

  void setArrowSymbolId(
    OdDbObjectId arrowSymbolId);

  OdDbObjectId  arrowSymbolId() const;

  void setArrowSize(
    double arrowSize);

  double arrowSize() const;

  void setContentType(
    OdDbMLeaderStyle::ContentType contentType);

  OdDbMLeaderStyle::ContentType contentType() const;

  void setTextStyleId(
    OdDbObjectId textStyleId);

  OdDbObjectId  textStyleId() const;

  void setTextAttachmentType(
      OdDbMLeaderStyle::TextAttachmentType textAttachmentType,
      OdDbMLeaderStyle::LeaderDirectionType leaderDirection);

  OdDbMLeaderStyle::TextAttachmentType  textAttachmentType(
      OdDbMLeaderStyle::LeaderDirectionType leaderDirection) const;

  void setTextAngleType(
    OdDbMLeaderStyle::TextAngleType textAngleType);

  OdDbMLeaderStyle::TextAngleType textAngleType() const;

  void setTextAlignmentType(
    OdDbMLeaderStyle::TextAlignmentType textAlignmentType);

  OdDbMLeaderStyle::TextAlignmentType textAlignmentType() const;

  void setTextColor(const OdCmColor& textColor);

  OdCmColor textColor() const;

  void setTextHeight(
    double textHeight);

  double  textHeight() const;

  void setEnableFrameText(
    bool enableFrameText);

  bool  enableFrameText() const;

  void setMText(
    const OdDbMText* pMText);

  OdDbMTextPtr mtext() const;

  void setBlockContentId(
    OdDbObjectId blockId);

  OdDbObjectId  blockContentId() const;

  void setBlockColor(
    const OdCmColor& blockColor);

  OdCmColor blockColor() const;

  void setBlockScale(
    const OdGeScale3d& scale);

  OdGeScale3d blockScale() const;

  void setBlockRotation(
    double rotation);

  double blockRotation() const;

  void setBlockConnectionType(
    OdDbMLeaderStyle::BlockConnectionType blockConnectionType);

  OdDbMLeaderStyle::BlockConnectionType blockConnectionType() const;

  void setEnableAnnotationScale(
    bool enableAnnotationScale);

  bool  enableAnnotationScale() const;

  void setMLeaderStyle(
    OdDbObjectId newStyleId);

  OdDbObjectId MLeaderStyle() const;

  OdResult getOverridedMLeaderStyle(
    OdDbMLeaderStyle& mleaderStyle) const;

  OdResult setContextDataManager(
    void* pContextDataManager);

  void* getContextDataManager() const;

  void setBlockPosition(
    const OdGePoint3d& position);

  void getBlockPosition(
    OdGePoint3d& position) const;

  void setTextLocation(
    const OdGePoint3d& location);

  void getTextLocation(
    OdGePoint3d& location) const;

  OdResult setToleranceLocation(
    const OdGePoint3d& location);

  OdResult getToleranceLocation(
    OdGePoint3d& location) const;

  void setArrowSymbolId(
    int leaderLineIndex,
    OdDbObjectId arrowSymbolId);

  OdDbObjectId  arrowSymbolId(
    int leaderLineIndex) const;

  bool  hasContent() const;

  OdResult connectionPoint(
    const OdGeVector3d& vect,
    OdGePoint3d& point) const;

  OdResult connectionPoint(
    const OdGeVector3d& vect,
    OdGePoint3d& point,
    OdDbMLeaderStyle::TextAttachmentDirection direction) const;

    OdResult recomputeBreakPoints();

  OdResult postMLeaderToDb(
    OdDbDatabase* pDb);
 
  // dim associativity support

  OdResult updateLeaderLinePosition();

  OdResult removeLeaderLineRefAssoc(
    int leaderLineIndex) const;

  OdResult updateContentScale(
    OdDbMLeaderObjectContextData* pContext);
 
  virtual bool isPlanar() const ODRX_OVERRIDE;
  virtual OdResult getPlane(OdGePlane& plane, OdDb::Planarity& planarity) const ODRX_OVERRIDE;

  void setTextAttachmentDirection(
    OdDbMLeaderStyle::TextAttachmentDirection direction);

  OdDbMLeaderStyle::TextAttachmentDirection textAttachmentDirection() const;

  enum LeaderLineOverrideType
  {
    kOverrideLeaderType = 0,
    kOverrideLineColor,
    kOverrideLineTypeId,
    kOverrideLineWeight,
    kOverrideArrowSize,
    kOverrideArrowSymbolId  
  };
  
  bool isOverride(int leaderLineIndex, LeaderLineOverrideType value);

  void setLeaderLineType(
    int leaderLineIndex,
    OdDbMLeaderStyle::LeaderType leaderLineType);
  
  OdDbMLeaderStyle::LeaderType leaderLineType(
    int leaderLineIndex) const;

  void setLeaderLineColor(
    int leaderLineIndex,
    const OdCmColor& leaderLineColor);
    
  OdCmColor leaderLineColor(
    int leaderLineIndex) const;

  void setLeaderLineTypeId(
    int leaderLineIndex,
    OdDbObjectId leaderLineTypeId);

  OdDbObjectId leaderLineTypeId(
    int leaderLineIndex) const;

  void setLeaderLineWeight(
    int leaderLineIndex,
    OdDb::LineWeight leaderLineWeight);

  OdDb::LineWeight leaderLineWeight(
    int leaderLineIndex) const;

  void setArrowSize(
    int leaderLineIndex,
    double arrowSize);

  double arrowSize(
    int leaderLineIndex) const;

  void setExtendLeaderToText(bool bSet);

  bool extendLeaderToText() const;
 
  virtual void copyFrom(const OdRxObject* pSource);
protected:
  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const ODRX_OVERRIDE;
  virtual void subSetDatabaseDefaults(OdDbDatabase *pDb, bool doSubents) ODRX_OVERRIDE;
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject* pObj, bool bPrimary) const ODRX_OVERRIDE;
  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& ownerIdMap, OdDbObject* pObj, bool bPrimary) const ODRX_OVERRIDE;
 
  virtual void modified(const OdDbObject* pObj) ODRX_OVERRIDE;
};
 
DBDIM_EXPORT void fxMLeaderRecompute( OdDbMLeader* pMLeader ); //FELIX_CHANGE

typedef OdSmartPtr<OdDbMLeader> OdDbMLeaderPtr;

class DBDIM_EXPORT OdDbMLeaderRecomputePE : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbMLeaderRecomputePE);
 
  virtual OdResult recomputeBreakPoints(OdDbMLeader* pMLeader) = 0;
};

typedef OdSmartPtr<OdDbMLeaderRecomputePE> OdDbMLeaderRecomputePEPtr;

OdUInt32 DBDIM_EXPORT OdDbMLeader_setRecomputeFlags(OdDbMLeader* pMLeader, OdUInt32 flags); // for tests only

bool DBDIM_EXPORT OdDbMLeader_setAcadBehaviour(OdDbMLeader* pMLeader, OdUInt32 bug, bool bValue); // for tests only

OdGePoint3d DBENT_EXPORT OdDbMLeader_getPtInternal(OdDbMLeader* pMLeader, OdUInt32 index = 0); // for tests only

bool DBENT_EXPORT OdDbMLeader_applyData(OdDbMLeader* pMLeader, const OdGePoint3dArray& points,
                                        OdDbObject* pObj = NULL, int ver = 0);

void DBENT_EXPORT OdDbObject_clearDatabase(OdDbObject* pObj); // for tests only

void DBENT_EXPORT OdDbObject_setWorkingDatabase(OdDbObject* pObj, OdDbDatabase* pWrkDb); // for tests only

//void DBENT_EXPORT OdDbObject_clearModified(OdDbObject* pObj); // for tests only
 
#include "TD_PackPop.h"
 
#endif // OD_MLEADER_H