DbSpline.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 ODDB_DBSPLINE_H
#define ODDB_DBSPLINE_H
 
#include "TD_PackPush.h"
 
#include "DbCurve.h"
#include "DwgDeclareMembers.h"
 
static const unsigned int kPlineVerticesThrehold = 10000U;
 
class OdGeKnotVector;

class DBENT_EXPORT OdDbSpline : public OdDbCurve
{
public:
  DWGMAP_DECLARE_MEMBERS(OdDbSpline);
 
  OdDbSpline();
  
  bool isRational() const;
  
  int degree() const;
  
  void elevateDegree(int newDegree);
    
  int numControlPoints() const;
  
  void getControlPointAt(
    int controlPointIndex, 
    OdGePoint3d& point) const;
  
  void setControlPointAt(
    int controlPointIndex, 
    const OdGePoint3d& point);
  
  int numFitPoints() const;
  
  OdResult getFitPointAt(
    int fitPointIndex, 
    OdGePoint3d& point) const;
  
  void setFitPointAt(
    int fitPointIndex, 
    const OdGePoint3d& point);
  
  void insertFitPointAt(
    int fitPointIndex, 
    const OdGePoint3d& point);
  
  void removeFitPointAt(
    int fitPointIndex);
  
  double fitTolerance() const;
  
  void setFitTol(
    double fitTolerance);
  
  OdResult getFitTangents(
    OdGeVector3d& startTangent, 
    OdGeVector3d& endTangent) const;
  
  void setFitTangents(
    const OdGeVector3d& startTangent, 
    const OdGeVector3d& endTangent);
  
  bool hasFitData() const;
  
  OdResult getFitData(
    OdGePoint3dArray& fitPoints, 
    int& degree, 
    double& fitTolerance, 
    bool& tangentsExist, 
    OdGeVector3d& startTangent, 
    OdGeVector3d& endTangent ) const;
  
  OdResult getFitData(
    OdGePoint3dArray& fitPoints, 
    int& degree, 
    double& fitTolerance, 
    bool& tangentsExist, 
    OdGeVector3d& startTangent, 
    OdGeVector3d& endTangent,
    OdGe::OdGeKnotParameterization& knotParam) const;
  
  void setFitData(
    const OdGePoint3dArray& fitPoints, 
    int degree, 
    double fitTolerance, 
    const OdGeVector3d& startTangent, 
    const OdGeVector3d& endTangent );
  
  void setFitData(
    const OdGePoint3dArray& fitPoints, 
    int degree, 
    double fitTolerance, 
    const OdGeVector3d& startTangent, 
    const OdGeVector3d& endTangent,
    OdGe::OdGeKnotParameterization knotParam);
  
  void purgeFitData();
  
  
  void getNurbsData(
    int& degree, 
    bool& rational, 
    bool& closed, 
    bool& periodic,
    OdGePoint3dArray& controlPoints, 
    OdGeDoubleArray& knots, 
    OdGeDoubleArray& weights, 
    double& controlPtTol,
    double& knotTol) const;

  void getNurbsData(
    int& degree, 
    bool& rational, 
    bool& closed, 
    bool& periodic,
    OdGePoint3dArray& controlPoints, 
    OdGeKnotVector& knots, 
    OdGeDoubleArray& weights, 
    double& controlPtTol) const;
  
  void setNurbsData(int degree, 
    bool rational, 
    bool closed, 
    bool periodic,
    const OdGePoint3dArray& controlPoints, 
    const OdGeDoubleArray& knots, 
    const OdGeDoubleArray& weights,
    double controlPtTol, 
    double knotTol );
  
  void setNurbsData(
    int degree, 
    bool rational, 
    bool closed, 
    bool periodic,
    const OdGePoint3dArray& controlPoints, 
    const OdGeKnotVector& knots, 
    const OdGeDoubleArray& weights,
    double controlPtTol);
  
  double weightAt(
    int weightIndex) const;
  
  void setWeightAt(
    int weightIndex, 
    double weight);
  
  void insertKnot(double param);
  
  virtual OdResult reverseCurve();
  
  
  virtual OdResult subGetClassID(
    void* pClsid) const;
  
  /*
     void getOffsetCurvesGivenPlaneNormal(const OdGeVector3d& normal,  //Replace OdRxObjectPtrArray
                                          double offsetDist, 
                                          OdRxObjectPtrArray& offsetCurves ) 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;
 
  //FELIX_CHANGE_BEGIN
  virtual OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const;
  //FELIX_CHANGE_END
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm);
 
  virtual bool isPlanar() const;
 
  virtual OdResult getPlane(
    OdGePlane& plane, 
    OdDb::Planarity& planarity) const;
 

 
  virtual OdResult getPointAtParam(
    double param, 
    OdGePoint3d& pointOnCurve) const;
 
  virtual OdResult getParamAtPoint(
    const OdGePoint3d& pointOnCurve, 
    double& param) 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 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;
 
  //DOM-IGNORE-BEGIN
  TD_USING(OdDbCurve::getFirstDeriv);
  TD_USING(OdDbCurve::getSecondDeriv);
  TD_USING(OdDbCurve::getSplitCurves);
  //DOM-IGNORE-END
 
  virtual OdResult getSplitCurves(
    const OdGeDoubleArray& params, 
    OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE;
  
  OdDbObjectPtr decomposeForSave(
    OdDb::DwgVersion ver,
    OdDbObjectId& replaceId,
    bool& exchangeXData);

  enum SplineType 
  {
    kFitPoints = 0,     // By fit points.
    kControlPoints = 1  // By control points.
  };

  SplineType type() const;

  OdResult setType(SplineType type);

  bool cvFrame() const;

  void setCvFrame(bool bVisible);

  OdResult insertControlPointAt(double knotParam, const OdGePoint3d& ctrlPt, double weight = 1.0);

  OdResult removeControlPointAt(int index);

  bool isNull() const;

  bool modifyPositionAndTangent(double param, const OdGePoint3d& point, const OdGeVector3d* deriv);
 
  virtual OdResult getOdGeCurve(OdGeCurve3d*& pGeCurve, const OdGeTol& tol = OdGeContext::gTol) const ODRX_OVERRIDE;
  virtual OdResult setFromOdGeCurve(const OdGeCurve3d& geCurve, OdGeVector3d *normal = NULL, const OdGeTol& tol = OdGeContext::gTol) ODRX_OVERRIDE;

  OdResult toPolyline(OdDbCurve*& pCurve, 
    int precision = 10, int* maxSuggestedPrecision = NULL,
    unsigned int numOfVerticesThreshold = kPlineVerticesThrehold) const;

  OdResult toPolyline(OdDbCurve*& pCurve, 
    bool bConvertAsArcs, bool bToLWPolyline,
    int precision = 10, int* maxSuggestedPrecision = NULL,
    unsigned int numOfVerticesThreshold = kPlineVerticesThrehold) const;

  virtual OdResult subExplode(OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE;
};

typedef OdSmartPtr<OdDbSpline> OdDbSplinePtr;

class DBENT_EXPORT OdDbSplinePE : public OdRxObject
{
public:
    ODRX_DECLARE_MEMBERS(OdDbSplinePE);
 
  virtual OdResult getParamAtPoint(
    const OdDbCurve* pCurve,
    const OdGePoint3d& pointOnCurve,
    double& param) const = 0;
 
  virtual OdResult getArea(
    const OdDbCurve* pCurve,
    double& area) const = 0;
};

typedef OdSmartPtr<OdDbSplinePE> OdDbSplinePEPtr;
 
#include "TD_PackPop.h"
 
#endif