DbPolyline.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_DBPL_H
#define OD_DBPL_H
 
#include "TD_PackPush.h"
 
#include "DbCurve.h"
#include "Db2dPolyline.h"
#include "DwgDeclareMembers.h"
 
class OdDb2dPolyline;
class OdGeLineSeg2d;
class OdGeLineSeg3d;
class OdGeCircArc2d;
class OdGeCircArc3d;

class DBENT_EXPORT OdDbPolyline : public OdDbCurve
{
public:
  DWGMAP_DECLARE_MEMBERS(OdDbPolyline);
 
  OdDbPolyline();

  OdResult convertFrom(
    OdDbEntity* pSource, 
    bool transferId = true);

  OdResult convertTo(
    OdDb2dPolyline* pDest, 
    bool transferId = true);

  void getPointAt(
    unsigned int vertexIndex, 
    OdGePoint2d& point2d) const;
    
  void getPointAt(
    unsigned int vertexIndex, 
    OdGePoint3d& point3d) const;
 
 
  enum SegType
  {
    kLine,        // Straight segment with length > 0.
    kArc,         // Arc segment with length > 0.
    kCoincident,  // Segment with length == 0.
    kPoint,       // Polyline with 1 vertex.
    kEmpty        // Polyline with 0 vertices.
  };

  SegType segType(
    unsigned int segmentIndex) const;

  void getLineSegAt(
    unsigned int segmentIndex, 
    OdGeLineSeg2d& line2d) const;

  void getLineSegAt(
    unsigned int segmentIndex, 
    OdGeLineSeg3d& line3d) const;

  void getArcSegAt(
    unsigned int segmentIndex, 
    OdGeCircArc2d& arc2d) const;

  void getArcSegAt(
    unsigned int segmentIndex, 
    OdGeCircArc3d& arc3d) const;

  virtual bool onSegAt(
    unsigned int segmentIndex, 
    const OdGePoint2d& point2d, 
    double& param) const;

  void setClosed(
    bool closed);

  void setPlinegen(
    bool plinegen);

  void setElevation(
    double elevation);

  void setThickness(
    double thickness);

  void setConstantWidth(
    double constantWidth);

  void setNormal(
    const OdGeVector3d& normal);

  bool isOnlyLines() const;

  bool hasPlinegen() const;

  double elevation() const;

  double thickness() const;

  double getConstantWidth() const;

  OdGeVector3d normal() const;

  void addVertexAt(
    unsigned int vertexIndex,
    const OdGePoint2d& point2d,
    double bulge = 0.,
    double startWidth = -1.,
    double endWidth = -1.,
    OdInt32 vertexIdentifier = 0);

  void removeVertexAt(
    unsigned int vertexIndex);

  unsigned int numVerts() const;
 

  double getBulgeAt(
    unsigned int index) const;

  OdInt32 getVertexIdentifierAt(
    unsigned int index) const;

  void getWidthsAt(
    unsigned int segmentIndex, 
    double& startWidth,  
    double& endWidth) const;

  void setPointAt(
    unsigned int vertexIndex, 
    const OdGePoint2d& point2d);

  void setBulgeAt(
    unsigned int index, 
    double bulge);

  void setVertexIdentifierAt(
    unsigned int index,
    OdInt32 suggestedId);

  void setWidthsAt(
    unsigned int index, 
    double startWidth, 
    double endWidth);

  void minimizeMemory();

  void maximizeMemory();

  void reset(
    bool reuse, 
    unsigned int numVerts);

  bool hasBulges() const;

  bool hasVertexIdentifiers() const;

  bool hasWidth() const;
 
  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& mat, OdDbEntityPtr& pCopy) const ODRX_OVERRIDE;
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm) ODRX_OVERRIDE;
 
  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const ODRX_OVERRIDE;
 
  //FELIX_CHANGE_BEGIN
  virtual OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const ODRX_OVERRIDE;
  //FELIX_CHANGE_END
 
  virtual void subViewportDraw(
    OdGiViewportDraw* pVd) const ODRX_OVERRIDE;
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler) ODRX_OVERRIDE;
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const ODRX_OVERRIDE;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler) ODRX_OVERRIDE;
 
  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler) ODRX_OVERRIDE;
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const ODRX_OVERRIDE;
 
  virtual OdResult subGetClassID(
    void* pClsid) const ODRX_OVERRIDE;
 
  virtual bool isPlanar() const ODRX_OVERRIDE;
 
  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;
 
  virtual OdResult getParamAtPoint(
    const OdGePoint3d& pointOnCurve, 
    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);
 
  virtual OdResult getDistAtParam( double param, double& dist ) const;
 
  virtual OdResult getParamAtDist( double dist, double& param ) const;
 
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const;
 
  virtual OdResult explodeGeometry(
    OdRxObjectPtrArray& entitySet) const;
 
  virtual OdResult subGetSubentPathsAtGsMarker(OdDb::SubentType type,
                                            OdGsMarker gsMark, 
                                            const OdGePoint3d& pickPoint,
                                            const OdGeMatrix3d& viewXform, 
                                            OdDbFullSubentPathArray& subentPaths, 
                                            const OdDbObjectIdArray* pEntAndInsertStack) const;
 
  virtual OdResult subGetGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath, 
                                                OdGsMarkerArray& gsMarkers) const;
 
  virtual OdDbEntityPtr subSubentPtr(const OdDbFullSubentPath& path) const;
 
  virtual OdResult reverseCurve();

  OdGeMatrix3d getEcs( ) const;
 
  virtual OdResult getOdGeCurve(OdGeCurve3d*& pGeCurve, const OdGeTol& tol = OdGeContext::gTol) const;
  virtual OdResult setFromOdGeCurve(const OdGeCurve3d& geCurve, OdGeVector3d *normal = NULL, const OdGeTol& tol = OdGeContext::gTol);
  void subSetDatabaseDefaults(OdDbDatabase* pDb, bool doSubEnts);
};

typedef OdSmartPtr<OdDbPolyline> OdDbPolylinePtr;
 
#include "TD_PackPop.h"
 
#endif //OD_DBPL_H