DbMLeaderStyle.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_DBMLEADERSTYLE_H
#define OD_DBMLEADERSTYLE_H
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
#include "DbMText.h"
 
class OdGeScale3d;
class OdString;
 
class TOOLKIT_EXPORT OdDbMLeaderStyle : public OdDbObject
{
public:
  enum ContentType {
    kNoneContent                = 0,
 
    kBlockContent               = 1,
 
    kMTextContent               = 2,
 
    kToleranceContent           = 3
  };
 
  enum DrawMLeaderOrderType {
    kDrawContentFirst           = 0,
 
    kDrawLeaderFirst            = 1
  };
 
  enum DrawLeaderOrderType {
    kDrawLeaderHeadFirst        = 0,
 
    kDrawLeaderTailFirst        = 1
  };
 
  enum LeaderType {
    kInVisibleLeader            = 0,
 
    kStraightLeader             = 1,
    
    kSplineLeader               = 2
  };
 
  enum TextAttachmentDirection {
    kAttachmentHorizontal       = 0,
    kAttachmentVertical         = 1
  };
 
  enum TextAttachmentType {
    kAttachmentTopOfTop         = 0,
 
    kAttachmentMiddleOfTop      = 1,
 
    kAttachmentMiddle           = 2,
 
    kAttachmentMiddleOfBottom   = 3,
 
    kAttachmentBottomOfBottom   = 4,
 
    kAttachmentBottomLine       = 5,
 
    kAttachmentBottomOfTopLine  = 6,
 
    kAttachmentBottomOfTop      = 7,
 
    kAttachmentAllLine          = 8,
 
    kAttachmentCenter           = 9,
 
    kAttachmentLinedCenter      = 10
  };
 
  enum TextAngleType {
    kInsertAngle                = 0,
 
    kHorizontalAngle            = 1,
        
    kAlwaysRightReadingAngle    = 2
  };
 
  enum TextAlignmentType {
    kLeftAlignment              = 0,
 
    kCenterAlignment            = 1,
 
    kRightAlignment             = 2
  };
 
  enum BlockConnectionType {
    kConnectExtents             = 0,
 
    kConnectBase                = 1
  };
 
  enum LeaderDirectionType {
    kUnknownLeader              = 0,
 
    kLeftLeader                 = 1,
 
    kRightLeader                = 2,
 
    kTopLeader                  = 3,
 
    kBottomLeader               = 4
  };
 
 
  enum SegmentAngleType {
    kAny                        = 0, 
 
        k15                         = 1,
 
    k30                         = 2,
 
    k45                         = 3,
 
    k60                         = 4,
 
    k90                         = 6,
 
    kHorz                       = 12
  };
 
public:
  ODDB_DECLARE_MEMBERS(OdDbMLeaderStyle);
 
  OdDbMLeaderStyle();
 
  void setDatabaseDefaults( OdDbDatabase* pDb );
 
//  virtual ~OdDbMLeaderStyle();
 
  virtual OdString getName() const;
 
  virtual void   setName(
    const OdString& name);
 
  virtual OdString  description() const;
 
  virtual void   setDescription(
    const OdString& description);
 
  virtual OdUInt32       bitFlags() const;
 
  virtual void setBitFlags(
    OdUInt32 flags);
 
  void setContentType(
    ContentType contentType);
 
  ContentType contentType() const;
 
  void setDrawMLeaderOrderType(
    DrawMLeaderOrderType drawMLeaderOrderType);
 
  DrawMLeaderOrderType  drawMLeaderOrderType() const;
 
  void setDrawLeaderOrderType(
    DrawLeaderOrderType drawLeaderOrderType);
 
  DrawLeaderOrderType drawLeaderOrderType() const;
 
  void setMaxLeaderSegmentsPoints(
    int maxLeaderSegmentsPoints);
 
  int maxLeaderSegmentsPoints() const;
 
  void setFirstSegmentAngleConstraint(
    SegmentAngleType angle);
 
  SegmentAngleType  firstSegmentAngleConstraint() const;
 
  void setSecondSegmentAngleConstraint(
    SegmentAngleType angle);
 
  SegmentAngleType  secondSegmentAngleConstraint() const;
 
  void setLeaderLineType(
    LeaderType leaderLineType);
 
  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 setEnableLanding(
    bool enableLanding);
 
  bool  enableLanding() const;
 
  void setLandingGap(
    double landingGap);
 
  double  landingGap() const;
 
  void setEnableDogleg(
    bool enableDogleg);
 
  bool  enableDogleg() const;
 
  void setDoglegLength(
    double doglegLength);
 
  double  doglegLength() const;
 
  void setArrowSymbolId(
    const OdString& name);
 
  void setArrowSymbolId(
    OdDbObjectId arrowSymbolId);
 
  OdDbObjectId  arrowSymbolId() const;
 
  void setArrowSize(
    double arrowSize);
 
  double  arrowSize() const;
 
  void setDefaultMText(
    const OdDbMTextPtr defaultMText);
 
  OdDbMTextPtr  defaultMText() const;
 
  void setTextStyleId(
    OdDbObjectId textStyleId);
 
  OdDbObjectId  textStyleId() const;
 
  void setTextAttachmentType(
    TextAttachmentType textAttachmentType,
    LeaderDirectionType leaderDirection);
 
  TextAttachmentType  textAttachmentType(
    LeaderDirectionType leaderDirection) const;
 
  void setTextAngleType(
    TextAngleType textAngleType);
 
  TextAngleType textAngleType() const;
 
  void setTextAlignmentType(
    TextAlignmentType textAlignmentType);
 
  TextAlignmentType textAlignmentType() const;
 
  void setTextAlignAlwaysLeft(
    bool bAlwaysLeft);
 
  bool  textAlignAlwaysLeft() const;
 
  void setTextColor(
    const OdCmColor& textColor);
 
  OdCmColor textColor() const;
 
  void setTextHeight(
    double textHeight);
 
  double  textHeight() const;
 
  void setEnableFrameText(
    bool enableFrameText);
 
  bool  enableFrameText() const;
 
  void setAlignSpace(
    double alignSpace);
 
  double  alignSpace() const;
 
  void setBlockId(
    const OdString& name);
 
  void setBlockId(
    OdDbObjectId blockId);
 
  OdDbObjectId  blockId() const;
 
  void setBlockColor(
    const OdCmColor& blockColor);
 
  OdCmColor blockColor() const;
 
  void setBlockScale(
    const OdGeScale3d& scale);
 
  OdGeScale3d blockScale() const;
 
  void setEnableBlockScale(
    bool enableBlockScale);
 
  bool  enableBlockScale() const;
 
  void setBlockRotation(
    double rotation);
 
  double  blockRotation() const;
 
  void setEnableBlockRotation(
    bool enableBlockRotation);
 
  bool  enableBlockRotation() const;
 
  void setBlockConnectionType(
    BlockConnectionType blockConnectionType);
 
  BlockConnectionType blockConnectionType() const;
 
  void setScale(
    double scale);
 
  double  scale() const;
 
  bool  overwritePropChanged() const;
 
  OdDbObjectId postMLeaderStyleToDb(
    OdDbDatabase* pDb, 
    const OdString& styleName);
 
  void setAnnotative(
    bool isAnnotative);
 
  bool  annotative() const;
 
  void setBreakSize (
    double size);
 
  double  breakSize() const;
 
  void setTextAttachmentDirection(
    TextAttachmentDirection direction);
 
  TextAttachmentDirection textAttachmentDirection() const;
 
  void setExtendLeaderToText(bool bSet);
 
  bool extendLeaderToText() const;
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual void subClose();
 
  OdResult subGetClassID(void* pClsid) const;
};
 
typedef OdSmartPtr<OdDbMLeaderStyle> OdDbMLeaderStylePtr;
 
#include "TD_PackPop.h"
 
#endif