DbLeader.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_DBLEOD_H
#define OD_DBLEOD_H 1
 
#include "TD_PackPush.h"
 
#include "DbCurve.h"
#include "DbDimStyleTableRecord.h"
#include "DwgDeclareMembers.h"

class DBDIM_EXPORT OdDbLeader : public OdDbCurve
{
public:
  DWGMAP_DECLARE_MEMBERS(OdDbLeader);
 
  OdDbLeader();
    
  virtual OdGeVector3d normal() const;
  
  virtual int numVertices() const;

  virtual bool appendVertex(
    const OdGePoint3d& vertex);

  virtual void removeLastVertex();

  virtual OdGePoint3d firstVertex() const;

  virtual OdGePoint3d lastVertex() const;

  virtual OdGePoint3d vertexAt(
    int vertexIndex) const;

  virtual bool setVertexAt(
    int vertexIndex, 
    const OdGePoint3d& vertex);
  
  bool isArrowHeadEnabled() const;

  virtual bool hasArrowHead() const;

  virtual void enableArrowHead();

  virtual void disableArrowHead();

  virtual bool hasHookLine() const;

  virtual bool isHookLineOnXDir() const;

  virtual void setToSplineLeader();

  virtual void setToStraightLeader();

  virtual bool isSplined() const;
  
  virtual OdDbHardPointerId dimensionStyle() const;

  virtual void setDimensionStyle(
    const OdDbHardPointerId& dimStyleId);
    
  virtual void attachAnnotation(
    OdDbObjectId annoId);

  virtual void attachAnnotation(
    OdDbObjectId annoId,
    OdGeVector3d xDir,
    double annotationWidth,
    double annotationHeight,
    bool hookLineOnXDir);

  virtual void detachAnnotation();

  virtual OdDbObjectId annotationObjId() const;

  virtual OdGeVector3d annotationXDir() const;

  virtual OdGeVector3d annotationOffset() const;

  virtual void setAnnotationOffset(
    const OdGeVector3d& offset);
  
  
  enum AnnoType
  { 
    kMText      = 0,   // OdDbMText
    kFcf        = 1,   // OdDbFcf
    kBlockRef   = 2,   // OdDbBlockReference.
    kNoAnno     = 3    // No annotation.
    //FELIX_CHANGE_BEGIN
  , kText  = 4    // OdDbText
    //FELIX_CHANGE_END
  };

  AnnoType annoType() const;

  double annoHeight() const;

  double annoWidth() const;
  
   virtual double dimasz() const;

   virtual OdCmColor dimclrd() const;

   virtual double dimgap() const;

   virtual OdDb::LineWeight dimlwd() const;

   virtual OdDbObjectId dimldrblk() const;

  virtual bool dimsah() const;

   virtual double dimscale() const;

   virtual int dimtad() const;

   virtual OdDbObjectId dimtxsty() const;

   virtual double dimtxt() const;
  
   virtual void setDimasz(
    double val);

   virtual void setDimclrd(
    const OdCmColor& val);

   virtual void setDimgap(
    double val);

   virtual void setDimldrblk(
    OdDbObjectId val);
  
  virtual void setDimldrblk(
    const OdString& val);

   virtual void setDimlwd(
    OdDb::LineWeight val); 

   virtual void setDimsah(
    bool val);

   virtual void setDimscale(
    double val);

   virtual void setDimtad(
    int val);

   virtual void setDimtxsty(
    OdDbObjectId val);

   virtual void setDimtxt(
    double val);
    
  virtual OdResult subGetClassID(
    void* pClsid) const;
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const ODRX_OVERRIDE;
 
  ODRX_SEALED_VIRTUAL void subViewportDraw(
    OdGiViewportDraw* pVd) const ODRX_OVERRIDE;
 
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE; 
 
  virtual void subClose() ODRX_OVERRIDE;
 
  virtual OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const ODRX_OVERRIDE;
 
  virtual bool isPlanar() const;
 
  virtual OdResult getPlane(
    OdGePlane& plane, 
    OdDb::Planarity& planarity) const;
 
  virtual bool isClosed() const;
 
  virtual bool isPeriodic() const;
 
  virtual OdResult getStartParam(
    double& startParam) const;
 
  virtual OdResult getEndParam (
  double& endParam) const;
 
  virtual OdResult getStartPoint(
    OdGePoint3d& startPoint) const;
 
  virtual OdResult getEndPoint(
    OdGePoint3d& endPoint) const;
 
  virtual OdResult getPointAtParam(
    double param, 
    OdGePoint3d& pointOnCurve) const ODRX_OVERRIDE;
 
  virtual OdResult getParamAtPoint(
    const OdGePoint3d& pointOnCurve, 
    double& param) const ODRX_OVERRIDE;
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm) ODRX_OVERRIDE;
 
  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& xform,
    OdDbEntityPtr& pEnt) const ODRX_OVERRIDE;
 
  virtual OdResult getDistAtParam( double param, double& dist ) const;
 
  virtual OdResult getParamAtDist( double dist, double& param ) const;
 
  virtual OdResult getFirstDeriv (
    double param,
    OdGeVector3d& firstDeriv) const;
 
  virtual OdResult getSecondDeriv (
    double param,
    OdGeVector3d& secondDeriv) const;
 
  virtual OdResult getArea(
    double& area) const;
 
  TD_USING(OdDbCurve::getFirstDeriv);
  TD_USING(OdDbCurve::getSecondDeriv);

  void subSetDatabaseDefaults(
    OdDbDatabase *pDb,
    bool doSubents);
  
  virtual OdResult evaluateLeader();
 
  
  virtual void modifiedGraphics(
    const OdDbObject* pObject);
  
  virtual void erased(
    const OdDbObject* pObject, 
    bool erasing = true);

  void getDimstyleData(
    OdDbDimStyleTableRecord *pRecord) const;

  void setDimstyleData(
    const OdDbDimStyleTableRecord* pDimstyle);
    
  void setDimstyleData(
    OdDbObjectId dimstyleID);

  virtual void setPlane(
    const OdGePlane& leaderPlane);
 
  enum gsMarkType {
    kArrowMark = 3,
    kLeaderLineMark = kArrowMark + 1
  };
 
protected:
  OdResult subGetSubentPathsAtGsMarker( OdDb::SubentType type,
    OdGsMarker gsMark, 
    const OdGePoint3d& ,
    const OdGeMatrix3d& , 
    OdDbFullSubentPathArray& subentPaths, 
    const OdDbObjectIdArray* pEntAndInsertStack ) const;
  
  OdResult subGetGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath, OdGsMarkerArray& gsMarkers) const;
  
  OdDbObjectPtr subWblockClone(OdDbIdMapping& idMap, OdDbObject* owner, bool bPrimary) const override;
};

typedef OdSmartPtr<OdDbLeader> OdDbLeaderPtr;
 
#include "TD_PackPop.h"
 
#endif