GeCurve3d.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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_GECURVE3D_H_
#define _OD_GECURVE3D_H_ 
#include "Ge/GeEntity3d.h"
#include "Ge/GeDoubleArray.h"
#include "Ge/GeVector3dArray.h"
#include "Ge/GeCurve3dPtrArray.h"
#include "Ge/GeIntArray.h"
#include "Ge/GeInterval.h"
#include "Ge/GeBoundBlock3d.h"
class OdGeCurve2d;
class OdGeSurface;
class OdGePoint3d;
class OdGePlane;
class OdGeVector3d;
class OdGeLinearEnt3d;
class OdGeLine3d;
class OdGePointOnCurve3d;
class OdGePointOnSurface;
class OdGeMatrix3d;
class OdGePointOnCurve3dData;
 
#include "TD_PackPush.h"
 
class GE_TOOLKIT_EXPORT OdGeCurve3d : public OdGeEntity3d
{
public:
 
  void getInterval(
    OdGeInterval& interval) const;
 
  void getInterval(
    OdGeInterval& interval,
    OdGePoint3d& start,
    OdGePoint3d& end) const;
 
  OdGeCurve3d& reverseParam();
 
  OdGeCurve3d& setInterval();
 
  bool setInterval(
    const OdGeInterval& interval);
 
  double distanceTo(
    const OdGePoint3d& point,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double distanceTo(
    const OdGeCurve3d& curve,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGePoint3d closestPointTo(
    const OdGePoint3d& point,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGePoint3d closestPointTo(
    const OdGeCurve3d& curve,
    OdGePoint3d& pntOnOtherCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGePoint3d closestPointTo(
    const OdGePoint3d & point,
    double & param,
    const OdGeInterval* range,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getClosestPointTo(
    const OdGePoint3d& point,
    OdGePointOnCurve3d& pntOnCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getClosestPointTo(
    const OdGeCurve3d& curve,
    OdGePointOnCurve3d& pntOnThisCrv,
    OdGePointOnCurve3d& pntOnOtherCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGePoint3d projClosestPointTo(
    const OdGePoint3d& point,
    const OdGeVector3d& projectDirection,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGePoint3d projClosestPointTo(
    const OdGeCurve3d& curve,
    const OdGeVector3d& projectDirection,
    OdGePoint3d& pntOnOtherCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getProjClosestPointTo(
    const OdGePoint3d& point,
    const OdGeVector3d& projectDirection,
    OdGePointOnCurve3d& pntOnCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getProjClosestPointTo(
    const OdGeCurve3d& curve,
    const OdGeVector3d& projectDirection,
    OdGePointOnCurve3d& pntOnThisCrv,
    OdGePointOnCurve3d& pntOnOtherCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool getNormalPoint(
    const OdGePoint3d& point,
    OdGePointOnCurve3d& pntOnCrv,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGeBoundBlock3d boundBlock() const;
 
  OdGeBoundBlock3d boundBlock(
    const OdGeInterval& range) const;
 
  OdGeBoundBlock3d orthoBoundBlock() const;
 
  OdGeBoundBlock3d orthoBoundBlock(
    const OdGeInterval& range) const;
 
  OdGeExtents3d getGeomExtents(
    const OdGeInterval& range = OdGeInterval(),
    const OdGeMatrix3d* coordSystem = NULL) const;
 
  OdGeEntity3d* project(
    const OdGePlane& projectionPlane,
    const OdGeVector3d& projectDirection,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  OdGeEntity3d* orthoProject(
    const OdGePlane& projectionPlane,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  //DOM-IGNORE-BEGIN
  // Tests if point is on *curve*.
  TD_USING(OdGeEntity3d::isOn);
  //DOM-IGNORE-END
 
  bool isOn(
    const OdGePoint3d& point,
    double& param,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isOn(
    double param,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double paramOf(
    const OdGePoint3d& point,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double paramOf(
    const OdGePoint3d& point,
    const OdGeInterval* range,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getTrimmedOffset(
    double distance,
    const OdGeVector3d& planeNormal,
    OdGeCurve3dPtrArray& offsetCurveList,
    OdGe::OffsetCrvExtType extensionType = OdGe::kFillet,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isClosed(
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isPlanar(
    OdGePlane& plane,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isLinear(
    OdGeLine3d& line,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isCoplanarWith(
    const OdGeCurve3d& curve,
    OdGePlane& plane,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isPeriodic(
    double& period) const;
 
  double length(
    double fromParam,
    double toParam,
    double tol
#ifndef SWIG
    = OdGeContext::gTol.equalPoint()
#endif
    ) const;
 
  double length(
    double tol
#ifndef SWIG
    = OdGeContext::gTol.equalPoint()
#endif
    ) const;
 
  double paramAtLength(
    double datumParam,
    double length,
    bool posParamDir
#ifndef SWIG
    = true
#endif
    , double tol
#ifndef SWIG
    = OdGeContext::gTol.equalPoint()
#endif
    ) const;
 
  bool area(
    double startParam,
    double endParam,
    double& value,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isDegenerate(
    OdGe::EntityId& degenerateType,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool isDegenerate(
    OdGeEntity3d*& pConvertedEntity,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getSplitCurves(
    double param,
    OdGeCurve3d*& piece1,
    OdGeCurve3d*& piece2) const;
 
  bool explode(
    OdGeCurve3dPtrArray& explodedCurves,
    OdGeIntArray& newExplodedCurves,
    const OdGeInterval* pInterval = NULL) const;
 
  void getLocalClosestPoints(
    const OdGePoint3d& point,
    OdGePointOnCurve3d& approxPntOnThisCrv,
    const OdGeInterval* pInterval1 = NULL,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  void getLocalClosestPoints(
    const OdGeCurve3d& curve,
    OdGePointOnCurve3d& approxPntOnThisCrv,
    OdGePointOnCurve3d& approxPntOnOtherCrv,
    const OdGeInterval* pInterval1 = NULL,
    const OdGeInterval* pInterval2 = NULL,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  bool hasStartPoint(
    OdGePoint3d& startPoint) const;
 
  bool hasEndPoint(
    OdGePoint3d& endPoint) const;
 
  bool hasMidPoint(
    OdGePoint3d& point,
    double coef = 0.5) const;
 
  OdGePoint3d midPoint(
    double coef = 0.5) const;
 
  OdGePoint3d evalPoint(
    double param) const;
 
  OdGePoint3d evalPoint(
    double param,
    int numDeriv,
    OdGeVector3dArray& derivatives) const;
 
  void getSamplePoints(
    double fromParam,
    double toParam,
    double approxEps,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray& paramArray,
    bool forceResampling = false) const;
 
  void getSamplePoints(
    int numSample,
    OdGePoint3dArray& pointArray) const;
 
  void getSamplePoints(
    int numSample,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray& paramArray) const;
 
  OdGeCurve3d& operator =(const OdGeCurve3d& curve);
 
  // TD Special :
 
  void getSamplePoints(
    double fromParam,
    double toParam,
    double approxEps,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray* paramArray = NULL) const;
 
  void getSamplePoints(
    const OdGeInterval* paramInterval,
    double approxEps,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray* pParamArray = NULL) const;
 
  void appendSamplePoints(
    double fromParam,
    double toParam,
    double approxEps,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray* pParamArray = NULL) const;
 
  void appendSamplePoints(
    int numSample,
    OdGePoint3dArray& pointArray,
    OdGeDoubleArray* pParamArray = NULL) const;
 
  void appendSamplePoints(
    const OdGeInterval *paramInterval, 
    double approxEps, 
    OdGePoint3dArray& pointArray, 
    OdGeDoubleArray* pParamArray = NULL) const;
 
  OdGeCurve2d* convertTo2d(
    const OdGeTol& tol = OdGeContext::gTol,
    bool sameParametrization = false) const;
//DOM-IGNORE-BEGIN
protected:
  OdGeCurve3d();
  OdGeCurve3d(
    const OdGeCurve3d& source);
//DOM-IGNORE-END
};
 
#include "TD_PackPop.h"
 
#endif