CurvePrimitive.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once



#ifdef BENTLEY_WIN32
#pragma warning (push)
#pragma warning (default : 4266)        // NEEDS WORK -- warnings about missing virtuals?
#endif
BEGIN_BENTLEY_GEOMETRY_NAMESPACE




struct ICurvePrimitive :  public RefCountedBase
{
public:
enum CurvePrimitiveType
    {
    CURVE_PRIMITIVE_TYPE_Invalid            =  0,
    CURVE_PRIMITIVE_TYPE_Line               =  1,
    CURVE_PRIMITIVE_TYPE_LineString         =  2,
    CURVE_PRIMITIVE_TYPE_Arc                =  3,
    CURVE_PRIMITIVE_TYPE_BsplineCurve       =  4,
    CURVE_PRIMITIVE_TYPE_InterpolationCurve =  5,
    CURVE_PRIMITIVE_TYPE_AkimaCurve         =  6,
    CURVE_PRIMITIVE_TYPE_PointString        =  7,
    CURVE_PRIMITIVE_TYPE_CurveVector        =  8,
    CURVE_PRIMITIVE_TYPE_Spiral             =  9,
    CURVE_PRIMITIVE_TYPE_PartialCurve       = 10,
    CURVE_PRIMITIVE_TYPE_NotClassified      = -1,
    };





enum CurvePrimitiveMarkerBit
    {
    CURVE_PRIMITIVE_BIT_GapCurve = 0x00010000,
    CURVE_PRIMITIVE_BIT_AllApplicationBits = 0x0000FFFF
    };

GEOMDLLIMPEXP bool GetMarkerBit (CurvePrimitiveMarkerBit selector) const;
GEOMDLLIMPEXP void SetMarkerBit (CurvePrimitiveMarkerBit selector, bool value);


GEOMDLLIMPEXP int64_t GetTag () const;
GEOMDLLIMPEXP int GetIntTag () const;
GEOMDLLIMPEXP void SetTag (int64_t tag);
GEOMDLLIMPEXP void SetTag (int tag);

GEOMDLLIMPEXP CurvePrimitiveIdCP  GetId() const;
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

GEOMDLLIMPEXP CurvePrimitiveType           GetCurvePrimitiveType () const;




GEOMDLLIMPEXP bool TryGetLine (DSegment3dR segment) const;
GEOMDLLIMPEXP bool TryGetArc  (DEllipse3dR arc) const;

GEOMDLLIMPEXP DSegment3dCP                 GetLineCP () const;
GEOMDLLIMPEXP bvector<DPoint3d> const* GetLineStringCP () const;
GEOMDLLIMPEXP bool TryGetSegmentInLineString (DSegment3dR segment, size_t startPointIndex) const;

GEOMDLLIMPEXP bool TryAddLineStringPoint (DPoint3dCR xyz);

GEOMDLLIMPEXP DEllipse3dCP                 GetArcCP () const;
GEOMDLLIMPEXP MSBsplineCurveCP             GetBsplineCurveCP () const;
GEOMDLLIMPEXP MSBsplineCurvePtr             GetBsplineCurvePtr () const;
GEOMDLLIMPEXP MSBsplineCurveCP             GetProxyBsplineCurveCP () const;
GEOMDLLIMPEXP MSBsplineCurvePtr            GetProxyBsplineCurvePtr () const;
GEOMDLLIMPEXP MSInterpolationCurveCP       GetInterpolationCurveCP () const;
GEOMDLLIMPEXP bvector<DPoint3d> const* GetAkimaCurveCP () const;
GEOMDLLIMPEXP bvector<DPoint3d> const* GetPointStringCP () const;
GEOMDLLIMPEXP CurveVectorCP            GetChildCurveVectorCP () const;
GEOMDLLIMPEXP DSpiral2dPlacementCP         GetSpiralPlacementCP () const;
GEOMDLLIMPEXP PartialCurveDetailCP         GetPartialCurveDetailCP () const;
GEOMDLLIMPEXP bool  TryGetPartialCurveData (double &fractionA, double &fractionB, ICurvePrimitivePtr &parentCurve, int64_t &tag) const;






GEOMDLLIMPEXP static ICurvePrimitivePtr CreateLine (DSegment3dCR segment);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateLineString (DPoint3dCP points, size_t nPoints);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateLineString (bvector<DPoint3d> const &points);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateArc (DEllipse3dCR ellipse);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreateBsplineCurve (MSBsplineCurveCR curve);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreateBsplineCurveSwapFromSource (MSBsplineCurveR curve);


GEOMDLLIMPEXP static ICurvePrimitivePtr CreateBsplineCurve (MSBsplineCurvePtr curve);


GEOMDLLIMPEXP static ICurvePrimitivePtr CreateInterpolationCurve (MSInterpolationCurveCR fitCurve);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateInterpolationCurveSwapFromSource (MSInterpolationCurveR fitCurve);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateAkimaCurve (DPoint3dCP points, size_t nPoints);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreatePointString (DPoint3dCP points, size_t nPoints);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreatePointString (bvector<DPoint3d> &points);


GEOMDLLIMPEXP static ICurvePrimitivePtr CreateRectangle(double x0, double y0, double x1, double y1, double z, int areaSignPreference = 0);


GEOMDLLIMPEXP static ICurvePrimitivePtr CreateSpiral (DSpiral2dBaseCR spiral, TransformCR frame,
                            double fractionA, double fractionB);


GEOMDLLIMPEXP static ICurvePrimitivePtr CreateSpiralBearingCurvatureBearingCurvature
      (
      int transitionType,
      double startRadians,
      double startCurvature,
      double endRadians,
      double endCurvature,
      TransformCR frame,
      double fractionA,
      double fractionB
      );

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateSpiralBearingRadiusBearingRadius
      (
      int transitionType,
      double startRadians,
      double startRadius,
      double endRadians,
      double endRadius,
      TransformCR frame,
      double fractionA,
      double fractionB
      );

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateSpiralBearingRadiusLengthRadius
      (
      int transitionType,
      double startRadians,
      double startRadius,
      double length,
      double endRadius,
      TransformCR frame,
      double fractionA,
      double fractionB
      );

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateSpiralBearingCurvatureLengthCurvature
      (
      int transitionType,
      double startRadians,
      double startCurvature,
      double length,
      double endCurvature,
      TransformCR frame,
      double fractionA,
      double fractionB
      );
GEOMDLLIMPEXP static bool CreateSpiralsStartShoulderTarget
(
int transitionType,     
DPoint3dCR pointA,     
DPoint3dCR pointB,      
DPoint3dCR pointC,      
ICurvePrimitivePtr &primitiveA, 
ICurvePrimitivePtr &primitiveB  
);

GEOMDLLIMPEXP static ICurvePrimitivePtr CreatePseudoSpiralPointBearingRadiusLengthRadius
(
int typeCode,               
DPoint3dCR startPoint,      
double startRadians,        
double radiusA,             
double lengthAB,            
double radiusB              
);

GEOMDLLIMPEXP static ICurvePrimitivePtr  CreatePartialCurve (ICurvePrimitiveP parentCurve, double fraction0, double fraction1, int64_t index = 0);

GEOMDLLIMPEXP static ICurvePrimitivePtr  CreateInterpolationBetweenCurves
(
ICurvePrimitiveCR curveA,
double fraction,
ICurvePrimitiveCR curveB
);


GEOMDLLIMPEXP ICurvePrimitivePtr Clone () const;

GEOMDLLIMPEXP ICurvePrimitivePtr CloneComponent (ptrdiff_t componentIndex) const;

GEOMDLLIMPEXP ICurvePrimitivePtr CloneBetweenFractions (double fractionA, double fractionB, bool allowExtrapolation) const;

GEOMDLLIMPEXP ICurvePrimitivePtr CloneAsSingleOffsetPrimitiveXY (CurveOffsetOptionsCR options) const;

GEOMDLLIMPEXP ICurvePrimitivePtr CloneDereferenced (bool allowExtrapolation = false, bool maximumDeref = true) const;

GEOMDLLIMPEXP static ICurvePrimitivePtr CreateChildCurveVector (CurveVectorPtr source);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreateChildCurveVector_CopyFromSource (CurveVectorCR source);
GEOMDLLIMPEXP static ICurvePrimitivePtr CreateChildCurveVector_SwapFromSource (CurveVectorR source);




GEOMDLLIMPEXP bool FractionToPoint (double f, DPoint3dR point) const;

GEOMDLLIMPEXP bool FractionToPoint (double f, DPoint3dR point, DVec3dR tangent) const;

GEOMDLLIMPEXP bool FractionToPointWithTwoSidedDerivative (double f, DPoint3dR point, DVec3dR derivativeA, DVec3dR derivativeB) const;


GEOMDLLIMPEXP bool ComponentFractionToPoint (ptrdiff_t componentIndex, double f, DPoint3dR point) const;

GEOMDLLIMPEXP bool ComponentFractionToPoint (ptrdiff_t componentIndex, double f, DPoint3dR point, DVec3dR tangent) const;



GEOMDLLIMPEXP bool FractionToPoint (double f, DRay3dR ray) const;

GEOMDLLIMPEXP bool FractionToPoint (double f, CurveLocationDetail &detail) const;


GEOMDLLIMPEXP bool FractionToPoint (double f, DPoint3dR point, DVec3dR tangent, DVec3dR derivative2) const;

GEOMDLLIMPEXP bool FractionToPoint (double f, DPoint3dR point, DVec3dR tangent, DVec3dR derivative2, DVec3dR derivative3) const;

GEOMDLLIMPEXP bool FractionToFrenetFrame (double f, TransformR frame) const;





GEOMDLLIMPEXP bool Length (double &length) const;

GEOMDLLIMPEXP bool Length (RotMatrixCP worldToLocal, double &length) const;



GEOMDLLIMPEXP bool FastLength (double &length) const;


GEOMDLLIMPEXP bool GetRange (DRange3dR range) const;
GEOMDLLIMPEXP bool GetRange (DRange3dR range, TransformCR transform) const;

GEOMDLLIMPEXP DRange1d ProjectedParameterRange (DRay3dCR ray, double fraction0, double fraction1) const;

GEOMDLLIMPEXP DRange1d ProjectedParameterRange (DRay3dCR ray) const;

GEOMDLLIMPEXP double FastMaxAbs () const;

GEOMDLLIMPEXP bool IsSameStructure (ICurvePrimitiveCR other) const;

GEOMDLLIMPEXP bool IsSameStructureAndGeometry (ICurvePrimitiveCR other, double tolerance = 0.0) const;

GEOMDLLIMPEXP size_t NumComponent() const;



GEOMDLLIMPEXP bool GetBreakFraction (size_t breakFractioniIndex, double &fraction) const;
GEOMDLLIMPEXP bool AdjustFractionToBreakFraction (double fraction, Rounding::RoundingMode mode, size_t &breakIndex, double &adjustedFraction) const;
GEOMDLLIMPEXP bool GetMSBsplineCurve (MSBsplineCurveR curve, double fraction0 = 0.0, double fraction1 = 1.0) const;
GEOMDLLIMPEXP MSBsplineCurvePtr GetMSBsplineCurvePtr (double fraction0 = 0.0, double fraction1 = 1.0) const;


GEOMDLLIMPEXP bool SignedDistanceBetweenFractions (double startFraction, double endFraction, double &signedDistance) const;

GEOMDLLIMPEXP bool SignedDistanceBetweenFractions (RotMatrixCP worldToLocal, double startFraction, double endFraction, double &signedDistance) const;


GEOMDLLIMPEXP bool PointAtSignedDistanceFromFraction (double startFraction, double signedDistance, bool allowExtension, CurveLocationDetailR location) const;


GEOMDLLIMPEXP bool PointAtSignedDistanceFromFraction (RotMatrixCP worldToView, double startFraction, double signedDistance, bool allowExtension, CurveLocationDetailR location) const;

GEOMDLLIMPEXP bool ClosestPointBounded (DPoint3dCR spacePoint, double &fraction, DPoint3dR curvePoint) const;

GEOMDLLIMPEXP void AnnounceKeyPoints
(
DPoint3dCR spacePoint,                       
CurveKeyPointCollector &collector,           
bool extend0,                               
bool extend1                                
) const;


GEOMDLLIMPEXP bool ClosestPointBounded (DPoint3dCR spacePoint, CurveLocationDetailR location, bool extend0, bool extend1) const;

GEOMDLLIMPEXP bool ClosestPointBounded (DPoint3dCR spacePoint, CurveLocationDetailR location) const;



GEOMDLLIMPEXP bool ClosestPointBoundedXY (DPoint3dCR spacePoint, DMatrix4dCP worldToLocal, CurveLocationDetailR location) const;


GEOMDLLIMPEXP bool ClosestPointBoundedXY (DPoint3dCR spacePoint, DMatrix4dCP worldToLocal, CurveLocationDetailR location, bool extend0, bool extend1) const;

GEOMDLLIMPEXP bool GetStartEnd (DPoint3dR pointA, DPoint3dR pointB) const;
GEOMDLLIMPEXP bool GetStartEnd (DPoint3dR pointA, DPoint3dR pointB, DVec3dR unitTangentA, DVec3dR unitTangentB) const;

GEOMDLLIMPEXP bool GetStartPoint (DPoint3dR point) const;

GEOMDLLIMPEXP bool TrySetStart (DPoint3dCR xyz);
GEOMDLLIMPEXP bool TrySetEnd (DPoint3dCR xyz);

GEOMDLLIMPEXP bool IsExtensibleFractionSpace () const;

GEOMDLLIMPEXP bool IsMappableFractionSpace () const;

GEOMDLLIMPEXP bool IsFractionSpace () const;


GEOMDLLIMPEXP bool IsPeriodicFractionSpace(double &period) const;


GEOMDLLIMPEXP bool TransformInPlace (TransformCR transform);

GEOMDLLIMPEXP bool ReverseCurvesInPlace ();




GEOMDLLIMPEXP void AppendCurvePlaneIntersections (DPlane3dCR plane, bvector<CurveLocationDetailPair> &intersections, double tolerance = 0.0) const;

GEOMDLLIMPEXP void  AppendCurveRangeIntersections
(
LocalRangeCR range,                          
bvector<PartialCurveDetail> &intersections   
) const;

GEOMDLLIMPEXP void  AppendCurveBilinearPatchIntersections
(
DBilinearPatch3dCR patch,                      
bvector<CurveAndSolidLocationDetail> &intersections   
) const;

GEOMDLLIMPEXP void  AppendCurvePlaneIntersections
(
DPlane3dByVectorsCR plane,  
UVBoundarySelect   bounded,         
bvector<CurveAndSolidLocationDetail> &intersections   
) const;

GEOMDLLIMPEXP bool WireCentroid (double &length, DPoint3dR centroid, double fraction0 = 0.0, double fraction1 = 1.0) const;



GEOMDLLIMPEXP bool AddStrokes (bvector <DPoint3d> &points, IFacetOptionsR options,
                bool includeStartPoint = true,
                double startFraction = 0.0,
                double endFraction = 1.0
                ) const;
GEOMDLLIMPEXP size_t GetStrokeCount (IFacetOptionsR options, double startFraction = 0.0, double endFraction = 1.0) const;

GEOMDLLIMPEXP static bool AddRuledSurfaceRayIntersections
    (
    bvector<struct SolidLocationDetail> &pickData,
    ICurvePrimitiveCR curveA,
    ICurvePrimitiveCR curveB,
    DRay3dCR ray
    );


}; // ICurvePrimitive


END_BENTLEY_GEOMETRY_NAMESPACE

#ifdef BENTLEY_WIN32
#pragma warning (pop)
#endif