CurveDetails.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 PartialCurveDetail 
{
ICurvePrimitivePtr parentCurve;
double fraction0;
double fraction1;
int64_t userData;

GEOMDLLIMPEXP PartialCurveDetail (ICurvePrimitiveP _parentCurve, double _fraction0, double _fraction1, int64_t userData);

GEOMDLLIMPEXP PartialCurveDetail ();
GEOMDLLIMPEXP PartialCurveDetail (ICurvePrimitiveP _parentCurve, DSegment1dCR interval, int64_t userData = 0);

GEOMDLLIMPEXP PartialCurveDetail (PartialCurveDetailCR parent, double f0, double f1);

GEOMDLLIMPEXP bool ParentFractionToChildFraction (double parentFraction, double &childFraction) const;
GEOMDLLIMPEXP double ChildFractionToParentFraction (double f) const;
GEOMDLLIMPEXP bool IsSingleFraction () const;

GEOMDLLIMPEXP void UpdateFraction1AndUserData (double f1, int64_t newData)
    {
    fraction1 = f1;
    userData = newData;
    }
};

struct CurveLocationDetail
{
ICurvePrimitiveCP curve;
double          fraction;
DPoint3d        point;
size_t          componentIndex;
size_t          numComponent;
double          componentFraction;
double          a;

GEOMDLLIMPEXP CurveLocationDetail ();

GEOMDLLIMPEXP CurveLocationDetail (ICurvePrimitiveCP _curve, size_t _numComponent = 1);

GEOMDLLIMPEXP CurveLocationDetail (ICurvePrimitiveCP _curve, double _fraction, DPoint3dCR _point);

GEOMDLLIMPEXP CurveLocationDetail (ICurvePrimitiveCP _curve, double _fraction, DPoint3dCR _point, size_t _componentIndex, size_t _numComponent, double _componentFraction);

GEOMDLLIMPEXP CurveLocationDetail (ICurvePrimitiveCP _curve, double _fraction, DPoint3dCR _point, size_t _componentIndex, size_t _numComponent, double _componentFraction, double _a);

GEOMDLLIMPEXP bool UpdateIfCloser (CurveLocationDetailCR otherDetail);

GEOMDLLIMPEXP double SetDistanceFrom (DPoint3dCR refPoint);

GEOMDLLIMPEXP void SetMaxDistance ();

GEOMDLLIMPEXP void SetDistance (double value);

GEOMDLLIMPEXP void SetSingleComponentData ();

GEOMDLLIMPEXP void SetSingleComponentFractionAndA (double fraction, double a);

GEOMDLLIMPEXP double Distance (CurveLocationDetailCR other) const;

GEOMDLLIMPEXP bool Interpolate (bvector<double> const &param, double &result) const;

GEOMDLLIMPEXP ValidatedDRay3d PointAndUnitTangent () const;

GEOMDLLIMPEXP bool TryFractionToPoint (DPoint3dR xyz, DVec3dR dXdf) const;

GEOMDLLIMPEXP bool TryComponentFractionToPoint (DPoint3dR xyz, DVec3dR dXdf) const;


GEOMDLLIMPEXP bool AlmostEqualPoint (CurveLocationDetailCR other) const;

GEOMDLLIMPEXP ValidatedCurveLocationDetail Interpolate (double fraction, CurveLocationDetailCR dataB) const;

GEOMDLLIMPEXP void SetFractionFromComponentFraction (double componentFraction, size_t componentIndex, size_t numComponent);

GEOMDLLIMPEXP void SetComponentFractionFromFraction (double globalFraction, size_t numComponent);

GEOMDLLIMPEXP static void SortByCurveAndFraction (bvector<CurveLocationDetail> &detail);
};


struct CurveLocationDetailPair
{
public:
    CurveLocationDetail detailA;
    CurveLocationDetail detailB;
GEOMDLLIMPEXP CurveLocationDetailPair ();
GEOMDLLIMPEXP CurveLocationDetailPair (CurveLocationDetailCR _detailA, CurveLocationDetailCR _detailB);
GEOMDLLIMPEXP CurveLocationDetailPair (CurveLocationDetailCR _detailA);
GEOMDLLIMPEXP CurveLocationDetailPair (ICurvePrimitiveCP curve, double fraction0, DPoint3dCR point0);
GEOMDLLIMPEXP CurveLocationDetailPair (ICurvePrimitiveCP curve, double fraction0, DPoint3dCR point0,
                size_t componentIndex, size_t numComponent, double componentFraction);
GEOMDLLIMPEXP CurveLocationDetailPair
    (
    ICurvePrimitiveCP curve0, double a0, 
    ICurvePrimitiveCP curve1, double a1
    );

CurveLocationDetailPair (ICurvePrimitiveCP curve, double fraction0, DPoint3dCR point0, double fraction1, DPoint3dCR point1);

GEOMDLLIMPEXP bool SameCurveAndFraction ();

GEOMDLLIMPEXP void Set (double fraction0, DPoint3dCR point0, double a0, double fraction1, DPoint3dCR point1, double a1);
GEOMDLLIMPEXP void Set (ICurvePrimitiveP curveA, ICurvePrimitiveP curveB);

GEOMDLLIMPEXP DSegment3d GetDSegment3d () const;

GEOMDLLIMPEXP double DistanceSquared () const;

GEOMDLLIMPEXP double DeltaZ () const;


GEOMDLLIMPEXP double Distance () const;

static GEOMDLLIMPEXP void DeltaZExtremes (bvector<CurveLocationDetailPair> const &pairs, size_t &iMin, size_t &iMax);

static GEOMDLLIMPEXP void SplitByDeltaZ (bvector<CurveLocationDetailPair> const &pairs, double splitDistance,
    bvector<CurveLocationDetailPair> *pairA, bvector<CurveLocationDetailPair> *pairB);

};



struct SolidLocationDetail
{
public:
struct FaceIndices
    {
    private:
    friend struct SolidLocationDetail;
    ptrdiff_t m_index0;
    ptrdiff_t m_index1;
    ptrdiff_t m_index2;
    public:
    GEOMDLLIMPEXP FaceIndices (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2);
    GEOMDLLIMPEXP FaceIndices ();
    GEOMDLLIMPEXP static FaceIndices Cap0 ();
    GEOMDLLIMPEXP static FaceIndices Cap1 ();
    GEOMDLLIMPEXP void Set (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2);
    GEOMDLLIMPEXP void SetCap0 ();
    GEOMDLLIMPEXP void SetCap1 ();

    GEOMDLLIMPEXP ptrdiff_t Index0 () const;
    GEOMDLLIMPEXP ptrdiff_t Index1 () const;
    GEOMDLLIMPEXP ptrdiff_t Index2 () const;

    GEOMDLLIMPEXP void SetIndex0 (ptrdiff_t value);
    GEOMDLLIMPEXP void SetIndex1 (ptrdiff_t value);
    GEOMDLLIMPEXP void SetIndex2 (ptrdiff_t value);


    GEOMDLLIMPEXP bool IsCap0 () const;
    GEOMDLLIMPEXP bool IsCap1 () const;
    GEOMDLLIMPEXP bool IsCap () const;
    GEOMDLLIMPEXP bool Is (ptrdiff_t index0, ptrdiff_t index1, ptrdiff_t index2) const ;
    GEOMDLLIMPEXP bool Is (ptrdiff_t index0, ptrdiff_t index1) const ;
    };


private:
double m_uParameter;
double m_vParameter;
double m_parameter;
DPoint3d m_xyz;
DVec3d   m_uDirection;
DVec3d   m_vDirection;
FaceIndices m_faceIndices;

int m_parentId;

double m_a;

public:

GEOMDLLIMPEXP SolidLocationDetail ();
GEOMDLLIMPEXP SolidLocationDetail (int parentId, double s);

GEOMDLLIMPEXP SolidLocationDetail (int parentId, double s, DPoint3dCR xyz);

GEOMDLLIMPEXP SolidLocationDetail (int parentId, double s, DPoint3dCR xyz, double u, double v, DVec3dCR uVector, DVec3dCR vVector);

GEOMDLLIMPEXP void Init ();

GEOMDLLIMPEXP void SetFaceIndices (ptrdiff_t _id0, ptrdiff_t _id1, ptrdiff_t _id2);

GEOMDLLIMPEXP void SetFaceIndices01 (ptrdiff_t _id0, ptrdiff_t _id1);

GEOMDLLIMPEXP void SetFaceIndices (SolidLocationDetail::FaceIndices const &indices);


GEOMDLLIMPEXP static const int PrimaryIdCap = -1;

GEOMDLLIMPEXP void SetCapSelector (int id);

GEOMDLLIMPEXP int GetParentId () const;
GEOMDLLIMPEXP void SetParentId (int id);

GEOMDLLIMPEXP int GetPrimarySelector () const;
GEOMDLLIMPEXP int GetSecondarySelector () const;

GEOMDLLIMPEXP SolidLocationDetail::FaceIndices GetFaceIndices () const;
GEOMDLLIMPEXP double GetPickParameter () const;

GEOMDLLIMPEXP DPoint3d GetXYZ () const;

GEOMDLLIMPEXP DPoint2d GetUV () const;
GEOMDLLIMPEXP double GetU ();
GEOMDLLIMPEXP double GetV ();
GEOMDLLIMPEXP double GetA ();
GEOMDLLIMPEXP DVec3d GetUDirection () const;

GEOMDLLIMPEXP DVec3d GetVDirection () const;

GEOMDLLIMPEXP void SetUV (double u, double v, DVec3dCR uDirection, DVec3dCR vDirection);
GEOMDLLIMPEXP void SetUV (DPoint2dCR xyz);
GEOMDLLIMPEXP void SetU (double u);
GEOMDLLIMPEXP void SetV (double v);
GEOMDLLIMPEXP void SetA (double a);


GEOMDLLIMPEXP void SetXYZ (DPoint3dCR xyz);
GEOMDLLIMPEXP void SetUDirection (DVec3d dXdu);
GEOMDLLIMPEXP void SetVDirection (DVec3d dXdv);
GEOMDLLIMPEXP void SetPickParameter (double f);

GEOMDLLIMPEXP bool IsCapSelect (int &capId) const;

GEOMDLLIMPEXP static bool cb_compareLT_parameter
(
SolidLocationDetail const &dataA,
SolidLocationDetail const &dataB
);

typedef struct SolidLocationDetail::FaceIndices const & FaceIndicesCR;
typedef struct SolidLocationDetail::FaceIndices  const * FaceIndicesCP;
typedef struct SolidLocationDetail::FaceIndices  &FaceIndicesR;
typedef struct SolidLocationDetail::FaceIndices  *FaceIndicesP;


GEOMDLLIMPEXP static bool IsCap0 (int selector0, int selector1);
GEOMDLLIMPEXP static bool IsCap1 (int selector0, int selector1);

GEOMDLLIMPEXP void TransformInPlace (TransformCR transform);

GEOMDLLIMPEXP bool MapPickParameterFractionToRange (DRange1dCR range);

GEOMDLLIMPEXP bool UpdateIfSmallerA (SolidLocationDetailCR source);
};



/*=================================================================================**/
struct ICurvePrimitiveInfo : public IRefCounted {};
typedef RefCountedPtr<ICurvePrimitiveInfo> ICurvePrimitiveInfoPtr;

/*=================================================================================**/
struct FacetEdgeLocationDetail
    {
    size_t m_readIndex;
    double m_fraction;
    GEOMDLLIMPEXP FacetEdgeLocationDetail (size_t readIndex, double fraction);
    GEOMDLLIMPEXP FacetEdgeLocationDetail ();
    };

/*=================================================================================**/
struct CurveOffsetOptions
{
private:
double m_tolerance;
double m_arcAngle;  // (if this is positive) turns larger than this become arcs.
double m_chamferAngle; // (if this is positive) "outer chamfers" are created with this max angle.
double m_offsetDistance;
bool   m_forceClosure;
bool   m_unusedBool[8];
double m_unusedDouble[8];
int    m_bCurvePointsPerKnot;   // When offsetting bspline, number of points requested per knot interval.
int    m_bCurveMethod;      // 0=default=MX spline fit.  1=greville absisae with current knots.
int    m_unusedInt[6];
public:
GEOMDLLIMPEXP CurveOffsetOptions (double offsetDistance);  // construct with default options.

GEOMDLLIMPEXP void SetTolerance (double tol);
GEOMDLLIMPEXP void SetOffsetDistance (double distance);
GEOMDLLIMPEXP void SetArcAngle (double valueRadians);
GEOMDLLIMPEXP void SetChamferAngle (double value);
GEOMDLLIMPEXP void SetForceClosure (bool value);
GEOMDLLIMPEXP void SetBCurvePointsPerKnot (int n);
GEOMDLLIMPEXP void SetBCurveMethod (int n);
GEOMDLLIMPEXP double GetTolerance () const;
GEOMDLLIMPEXP double GetOffsetDistance () const;
GEOMDLLIMPEXP double GetArcAngle () const;
GEOMDLLIMPEXP double GetChamferAngle () const;
GEOMDLLIMPEXP bool  GetForceClosure () const;
GEOMDLLIMPEXP int GetBCurvePointsPerKnot () const;
GEOMDLLIMPEXP int GetBCurveMethod () const;
};


//=================================================================================
//=================================================================================
struct CurveGapOptions
{
private:
double m_equalPointTolerance;
double m_maxDirectAdjust;
double m_maxAdjustAlongCurve;
bool   m_removePriorGapPrimitives;
double m_unusedDouble[10];
int    m_unusedInt[10];
bool   m_unusedBool[10];
public:
GEOMDLLIMPEXP CurveGapOptions ();   // default options (1e-7, 1e-4,1e-3)
GEOMDLLIMPEXP CurveGapOptions (double m_equalPointTolerance, double maxDirectAdjust, double maxAdjustAlongCurve); 

GEOMDLLIMPEXP void SetEqualPointTolerance (double value); 
GEOMDLLIMPEXP void SetMaxDirectAdjustTolerance (double value);
GEOMDLLIMPEXP void SetMaxAdjustAlongCurve (double value);
GEOMDLLIMPEXP void SetRemovePriorGapPrimitives (bool value);

GEOMDLLIMPEXP double GetEqualPointTolerance () const;    
GEOMDLLIMPEXP double GetMaxDirectAdjustTolerance () const; 
GEOMDLLIMPEXP double GetMaxAdjustAlongCurve () const;
GEOMDLLIMPEXP bool GetRemovePriorGapPrimitives () const;


};





enum BlendType
    {
    CURVE_CURVE_BLEND_BisectorParabola,        // for parabola with axis that bisects the angle between the defining lines
    CURVE_CURVE_BLEND_VerticalAxisParabola,    // parabola with vertical axis
    };


enum AreaSelect
    {
    AreaSelect_Parity                      = 0,
    AreaSelect_CCWPositiveWindingNumber    = 1,
    AreaSelect_CCWNonzeroWindingNumber     = 2,
    AreaSelect_CCWNegativeWindingNumber    = 3,
    };

// Area analysis generates (a) an integer property at each leaf level face, (b) a true/false from that int.
// At higher level, BoolSelect gives choices of interpretation of the collection.
enum BoolSelect
    {
    BoolSelect_Parity = 0,    // XOR of leaf-level bools
    BoolSelect_Union  = 2,    // UNION of leaf level bools
    BoolSelect_Summed_Parity   = 3,   // XOR of leaf level integers
    BoolSelect_Summed_Positive = 4,   // Positive sum of leaf level integers 
    BoolSelect_Summed_NonZero  = 5,   // Nonzero sum of leaf level integers
    BoolSelect_Summed_Negative = 6,    // Negative sum of leaf level integers.
    BoolSelect_FromStructure = 1000   // Dictated by structure of supplied data.
    };

struct BlendDetail
{
CurveLocationDetail detailA, detailB;
ICurvePrimitivePtr geometry;
};

struct CurvePrimitivePtrPair
    {
    ICurvePrimitivePtr curveA;
    ICurvePrimitivePtr curveB;
    CurvePrimitivePtrPair (ICurvePrimitivePtr curveA, ICurvePrimitivePtr curveB);
    };
typedef bvector<CurvePrimitivePtrPair> CurvePrimitivePtrPairVector;

struct LocalRange
{
Transform m_localToWorld;
Transform m_worldToLocal;
DRange3d  m_localRange;
DRange3d  m_worldRange;
GEOMDLLIMPEXP DPoint3d RangeFractionToLocal (double x, double y, double z) const;
GEOMDLLIMPEXP DPoint3d RangeFractionToWorld (double x, double y, double z) const;
GEOMDLLIMPEXP void InitNullRange ();
GEOMDLLIMPEXP LocalRange (TransformCR localToWorld, TransformCR worldToLocal, DRange3dCR localRange);
GEOMDLLIMPEXP LocalRange (TransformCR localToWorld, TransformCR worldToLocal, DRange3dCR localRange, DRange3dCR worldRange);
// Initialize with identity transforms and empty range
GEOMDLLIMPEXP LocalRange ();
GEOMDLLIMPEXP bool InitFromPrincipalAxesOfPoints (bvector<DPoint3d> const &xyz);
GEOMDLLIMPEXP bool InitFromPrincipalAxesOfPoints (bvector<DPoint4d> const &xyzw);
// Return 0 if space point is in or on the range.
// Otherwise return shortest distanced to any point of the range.
GEOMDLLIMPEXP double DistanceOutside (DPoint3dCR spacePoint) const;
};

struct TaggedLocalRange : public LocalRange
{
size_t m_indexA, m_indexB;
double m_a;
GEOMDLLIMPEXP TaggedLocalRange (size_t indexA, size_t indexB, double a = 0.0);
// sort an array of TaggedLocalRanges by increasing "a" value.    
static GEOMDLLIMPEXP void SortByA (bvector<TaggedLocalRange> &data);
// Compute and save distance from the range to space point.
void GEOMDLLIMPEXP SetDistanceOutside (DPoint3dCR spacePoint);
};

struct CurveAndSolidLocationDetail
{
CurveLocationDetail m_curveDetail;
SolidLocationDetail m_solidDetail;
CurveAndSolidLocationDetail
    (
    CurveLocationDetailCR curveDetail,
    SolidLocationDetailCR solidDetail
    )
    : m_curveDetail (curveDetail), m_solidDetail(solidDetail)
    {}
};

struct UVBoundarySelect
{
public:
static const int Unbounded = 0;
static const int Triangle  = 1;
static const int UnitSquare = 2;
static const int CenteredSquare = 3;

static const int UnitCircle = 4;

private:
    int m_selector;   // one of the constants UVBoundarySelect::Unbounded, UVBoundarySelect::Triangle, UVBoundarySelect::Square, UVBoundarySelectUnitCircle
public:
UVBoundarySelect (int select);

bool IsInOrOn (double u, double v) const;

bool IsInOrOn (DPoint2dCR uv) const;

};


struct CurveKeyPointCollector
{
enum KeyPointType
{
EndPoint = 0,
Perpendicular = 1,
Tangency = 2,
BreakPoint = 3,
NumTypes = 4
};
protected:
bool m_needKeyPointType [10];
bool m_xyOnly;
DMatrix4d m_worldToLocal;

public:
GEOMDLLIMPEXP CurveKeyPointCollector ();
GEOMDLLIMPEXP void EnableKeyPointType (KeyPointType selector, bool value);

GEOMDLLIMPEXP void EnableSingleKeyPointType (KeyPointType selector);

GEOMDLLIMPEXP void SetXYOnly (DMatrix4dCR worldToLocal);
GEOMDLLIMPEXP bool NeedKeyPointType (KeyPointType selector) const;
GEOMDLLIMPEXP bool GetWorldToLocal (DMatrix4dR worldToLocal) const;

virtual void AnnouncePoint (CurveLocationDetailCR worldDetail, KeyPointType selector);

};

struct CurveKeyPoint_ClosestPointCollector : CurveKeyPointCollector
{
private:
CurveLocationDetail m_closestPoint; 
DPoint3d m_worldBiasPoint;
CurveKeyPointCollector::KeyPointType m_keyPointType;
public:
GEOMDLLIMPEXP CurveKeyPoint_ClosestPointCollector
(
DPoint3dCR biasPoint 
);
GEOMDLLIMPEXP virtual void AnnouncePoint (CurveLocationDetailCR worldDetail, KeyPointType selector) override;
GEOMDLLIMPEXP bool GetResult (CurveLocationDetailR detail, KeyPointType &selector) const;
};

END_BENTLEY_GEOMETRY_NAMESPACE

#ifdef BENTLEY_WIN32
#pragma warning (pop)
#endif