AcDbMLeader.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcDbEntity.h"
#include "..\acdb17\AcDb.h"
#include "..\acdb17\AcDbMLeaderStyle.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
template < typename Param1 > class AcArrayObjectCopyReallocator;
class AcCmColor;
class AcDbAttribute;
class AcDbDatabase;
class AcDbDwgFiler;
class AcDbDxfFiler;
class AcDbEntity;
class AcDbExtents;
class AcDbFullSubentPath;
class AcDbGripData;
class AcDbMLeaderObjectContextData;
class AcDbMLeaderStyle;
class AcDbMText;
class AcDbObject;
class AcDbObjectId;
class AcDbSystemInternals;
class AcGeMatrix3d;
class AcGePlane;
class AcGePoint3d;
class AcGeScale3d;
class AcGeVector3d;
class AcGiViewportDraw;
class AcGiWorldDraw;
class AcRxClass;
 
class ARX_API AcDbMLeader : public AcDbEntity
{
public:
    enum MoveType
    {
        kMoveAllPoints = 0,
        kMoveAllExceptArrowHeaderPoints = 1,
        kMoveContentAndDoglegPoints = 2
    };
    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,
        kSize = kTextSwitchAlignmentType + 1
    };
    public:
    ACRX_DECLARE_MEMBERS(AcDbMLeader)
 
    public:
    AcDbMLeader(void);
    bool  enableAnnotationScale(void)const ;
    bool  enableDogleg(void)const ;
    bool  enableFrameText(void)const ;
    bool  enableLanding(void)const ;
    bool  hasContent(void)const ;
    bool  isOverride( PropertyOverrideType)const ;
    AcCmColor  blockColor(void)const ;
    AcCmColor  leaderLineColor(void)const ;
    AcCmColor  textColor(void)const ;
    AcDbMText *  mtext(void)const ;
    AcDbObjectId  MLeaderStyle(void);
    AcDbObjectId  arrowSymbolId(int)const ;
    AcDbObjectId  arrowSymbolId(void)const ;
    AcDbObjectId  blockContentId(void)const ;
    AcDbObjectId  leaderLineTypeId(void)const ;
    AcDbObjectId  textStyleId(void)const ;
    AcGePlane  plane(void)const ;
    AcGeScale3d  blockScale(void)const ;
    AcGeVector3d  normal(void)const ;
    double  arrowSize(void)const ;
    double  blockRotation(void)const ;
    double  doglegLength(void)const ;
    double  landingGap(void)const ;
    double  scale(void)const ;
    double  textHeight(void)const ;
    AcDb::LineWeight  leaderLineWeight(void)const ;
    AcDbMLeaderStyle::BlockConnectionType  blockConnectionType(void)const ;
    AcDbMLeaderStyle::ContentType  contentType(void)const ;
    AcDbMLeaderStyle::LeaderType  leaderLineType(void)const ;
    AcDbMLeaderStyle::TextAlignmentType  textAlignmentType(void)const ;
    AcDbMLeaderStyle::TextAngleType  textAngleType(void)const ;
    AcDbMLeaderStyle::TextAttachmentDirection textAttachmentDirection() const;
    AcDbMLeaderStyle::TextAttachmentType  textAttachmentType( AcDbMLeaderStyle::LeaderDirectionType)const ;
    AcDbMLeaderStyle::TextAttachmentType  textAttachmentType(void)const ;
    Acad::ErrorStatus  addFirstVertex(int, AcGePoint3d const &);
    Acad::ErrorStatus  addLastVertex(int, AcGePoint3d const &);
    Acad::ErrorStatus  addLeader(int &);
    Acad::ErrorStatus  addLeaderLine( AcGePoint3d const &,int &);
    Acad::ErrorStatus  addLeaderLine(int,int &);
    Acad::ErrorStatus  connectionPoint( AcGeVector3d const &, AcGePoint3d &)const ;
    Acad::ErrorStatus  doglegLength(int,double &)const ;
    Acad::ErrorStatus  getBlockAttributeValue( AcDbObjectId const &, AcDbAttribute * &)const ;
    Acad::ErrorStatus  getBlockAttributeValue( AcDbObjectId const &,wchar_t * &)const ;
    Acad::ErrorStatus  getBlockPosition( AcGePoint3d &)const ;
    Acad::ErrorStatus  getContentGeomExtents( AcDbExtents &)const ;
    Acad::ErrorStatus  getDoglegDirection(int, AcGeVector3d &)const ;
    Acad::ErrorStatus  getFirstVertex(int, AcGePoint3d &)const ;
    Acad::ErrorStatus  getLastVertex(int, AcGePoint3d &)const ;
    Acad::ErrorStatus  getLeaderIndex(int,int &)const ;
    Acad::ErrorStatus  getLeaderIndexes( AcGeIntArray &)const ;
    Acad::ErrorStatus  getLeaderLineIndexes( AcGeIntArray &)const ;
    Acad::ErrorStatus  getLeaderLineIndexes(int, AcGeIntArray &)const ;
    Acad::ErrorStatus  getOverridedMLeaderStyle( AcDbMLeaderStyle &);
    Acad::ErrorStatus  getTextLocation( AcGePoint3d &)const ;
    Acad::ErrorStatus  getToleranceLocation( AcGePoint3d &)const ;
    Acad::ErrorStatus  getVertex(int,int, AcGePoint3d &)const ;
    Acad::ErrorStatus  moveMLeader( AcGeVector3d const &, MoveType,bool=true);
    Acad::ErrorStatus  numVertices(int,int &)const ;
    Acad::ErrorStatus  postMLeaderToDb( AcDbDatabase *);
    Acad::ErrorStatus  recomputeBreakPoints(void);
    Acad::ErrorStatus  removeFirstVertex(int);
    Acad::ErrorStatus  removeLastVertex(int);
    Acad::ErrorStatus  removeLeader(int);
    Acad::ErrorStatus  removeLeaderLine(int);
    Acad::ErrorStatus  removeLeaderLineRefAssoc(int)const ;
    Acad::ErrorStatus  setArrowSize(double);
    Acad::ErrorStatus  setArrowSymbolId( AcDbObjectId);
    Acad::ErrorStatus  setArrowSymbolId(int, AcDbObjectId);
    Acad::ErrorStatus  setBlockAttributeValue( AcDbObjectId const &, AcDbAttribute const *);
    Acad::ErrorStatus  setBlockAttributeValue( AcDbObjectId const &,wchar_t const *);
    Acad::ErrorStatus  setBlockColor( AcCmColor const &);
    Acad::ErrorStatus  setBlockConnectionType( AcDbMLeaderStyle::BlockConnectionType);
    Acad::ErrorStatus  setBlockContentId( AcDbObjectId);
    Acad::ErrorStatus  setBlockPosition( AcGePoint3d const &);
    Acad::ErrorStatus  setBlockRotation(double);
    Acad::ErrorStatus  setBlockScale( AcGeScale3d const &);
    Acad::ErrorStatus  setContentType( AcDbMLeaderStyle::ContentType);
    Acad::ErrorStatus  setContextDataManager(void *);
    Acad::ErrorStatus  setDoglegDirection(int, AcGeVector3d const &);
    Acad::ErrorStatus  setDoglegLength(double);
    Acad::ErrorStatus  setDoglegLength(int,double);
    Acad::ErrorStatus  setEnableAnnotationScale(bool);
    Acad::ErrorStatus  setEnableDogleg(bool);
    Acad::ErrorStatus  setEnableFrameText(bool);
    Acad::ErrorStatus  setEnableLanding(bool);
    Acad::ErrorStatus  setFirstVertex(int, AcGePoint3d const &);
    Acad::ErrorStatus  setLandingGap(double);
    Acad::ErrorStatus  setLastVertex(int, AcGePoint3d const &);
    Acad::ErrorStatus  setLeaderLineColor( AcCmColor const &);
    Acad::ErrorStatus  setLeaderLineType( AcDbMLeaderStyle::LeaderType);
    Acad::ErrorStatus  setLeaderLineTypeId( AcDbObjectId);
    Acad::ErrorStatus  setLeaderLineWeight( AcDb::LineWeight);
    Acad::ErrorStatus  setMLeaderStyle( AcDbObjectId);
    Acad::ErrorStatus  setMText( AcDbMText const *);
    Acad::ErrorStatus  setOverride( PropertyOverrideType,bool);
    Acad::ErrorStatus  setScale(double);
    Acad::ErrorStatus  setTextAlignmentType( AcDbMLeaderStyle::TextAlignmentType);
    Acad::ErrorStatus  setTextAngleType( AcDbMLeaderStyle::TextAngleType);
    Acad::ErrorStatus  setTextAttachmentDirection(AcDbMLeaderStyle::TextAttachmentDirection);
    Acad::ErrorStatus  setTextAttachmentType( AcDbMLeaderStyle::TextAttachmentType);
    Acad::ErrorStatus  setTextAttachmentType( AcDbMLeaderStyle::TextAttachmentType, AcDbMLeaderStyle::LeaderDirectionType);
    Acad::ErrorStatus  setTextColor( AcCmColor const &);
    Acad::ErrorStatus  setTextHeight(double);
    Acad::ErrorStatus  setTextLocation( AcGePoint3d const &);
    Acad::ErrorStatus  setTextStyleId( AcDbObjectId);
    Acad::ErrorStatus  setToleranceLocation( AcGePoint3d const &);
    Acad::ErrorStatus  setVertex(int,int, AcGePoint3d const &);
    Acad::ErrorStatus  updateContentScale( AcDbMLeaderObjectContextData *);
    Acad::ErrorStatus  updateLeaderLinePosition(void);
    int  numLeaderLines(void)const ;
    int  numLeaders(void)const ;
 
    virtual  ~AcDbMLeader(void);
    virtual  AcDbEntity *  subSubentPtr( AcDbFullSubentPath const &)const ;
    virtual  Acad::ErrorStatus  subDeleteSubentPaths( AcArray< AcDbFullSubentPath, AcArrayObjectCopyReallocator< AcDbFullSubentPath> > const &);
    virtual  Acad::ErrorStatus  dwgInFields( AcDbDwgFiler *);
    virtual  Acad::ErrorStatus  dwgOutFields( AcDbDwgFiler *)const ;
    virtual  Acad::ErrorStatus  dxfInFields( AcDbDxfFiler *);
    virtual  Acad::ErrorStatus  dxfOutFields( AcDbDxfFiler *)const ;
    virtual  Acad::ErrorStatus  subExplode( AcDbVoidPtrArray &)const ;
    virtual  Acad::ErrorStatus  subGetClassID( _GUID *)const ;
    virtual  Acad::ErrorStatus  subGetGeomExtents( AcDbExtents &)const ;
    virtual  Acad::ErrorStatus  subGetGsMarkersAtSubentPath( AcDbFullSubentPath const &, AcGeIntArray &)const ;
    virtual  Acad::ErrorStatus  subGetSubentPathsAtGsMarker(unsigned long,int, AcGePoint3d const &, AcGeMatrix3d const &,int &, AcDbFullSubentPath * &,int = 0, AcDbObjectId * = nullptr)const ;
    virtual  Acad::ErrorStatus  subGetTransformedCopy( AcGeMatrix3d const &, AcDbEntity * &)const ;
    virtual  Acad::ErrorStatus  highlight( AcDbFullSubentPath const &,int)const ;
    virtual  Acad::ErrorStatus  subMoveGripPointsAt( AcDbVoidPtrArray const &, AcGeVector3d const &, const int);
    virtual  Acad::ErrorStatus  subClose(void);
    virtual  Acad::ErrorStatus  subErase(int);
    virtual  Acad::ErrorStatus  subTransformBy( AcGeMatrix3d const &);
    virtual  Acad::ErrorStatus  unhighlight( AcDbFullSubentPath const &,const int)const ;
    virtual Adesk::Boolean  subWorldDraw( AcGiWorldDraw *);
    virtual void  modified( AcDbObject const *);
    virtual void  objectClosed( AcDbObjectId const );
    virtual void  subViewportDraw( AcGiViewportDraw *);
    void *  getContextDataManager(void)const ;
    void  setPlane( AcGePlane const &);
 
    virtual Adesk::UInt32 subSetAttributes(AcGiDrawableTraits*) const;
    virtual void subSetDatabaseDefaults(AcDbDatabase *);
    virtual Acad::ErrorStatus subWblockClone(AcRxObject*, AcDbObject*& , AcDbIdMapping&, Adesk::Boolean = true) const;
    virtual Acad::ErrorStatus subDeepClone(AcDbObject*,AcDbObject*&,AcDbIdMapping&, Adesk::Boolean = true) const;
 
protected:
          AcDbMLeader( AcDbSystemInternals *);
 
};