ClipPlaneSet.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

BEGIN_BENTLEY_GEOMETRY_NAMESPACE

typedef bvector <ClipPlane>     T_ClipPlanes;


enum    ClipPlaneContainment
    {
    ClipPlaneContainment_StronglyInside   =  1,
    ClipPlaneContainment_Ambiguous        =  2,
    ClipPlaneContainment_StronglyOutside  =  3,
    };

// An array of arrays of T, with the point arrays to be used like a stack.
// When the stack is popped, the top array is swapped to a holding area instead of 
// going to destructor, and then reused on later push
template<typename T>
struct BVectorCache : bvector<bvector<T>>
{
bvector<bvector<T>> m_cache;
// pope the top bvector<T>, and save it in the cache.
// return false if nothing to pop
bool PopToCache ()
    {
    if (size () > 0)
        {
        m_cache.push_back (bvector<T>  ());
        back ().swap (m_cache.back ());     // This preserves the heap allocation
        m_cache.back ().clear ();    
        pop_back (); // This is an empty bvector, so destructor does not free anything.    
        return true;
        }
    return false;
    }
// push an (empty) bvector.
// (If possible, it is taken from the cache, and will have pre-allocated heap memory)
void PushFromCache ()
    {
    push_back (bvector<T>());
    if (m_cache.size () > 0)
        {
        back ().swap (m_cache.back ());     // This preserves the heap allocation
        back ().clear();
        }
    }

// push 
// push data, using sequence that reuses capacity if possible
void PushCopy (bvector<T> const &data)
    {
    PushFromCache ();
    back() = data;
    }
// clear all bvectors to the cache. (preserving heap allocations)
void ClearToCache ()
    {
    while (PopToCache ())
        {
        }
    }


bool SwapBackPop (bvector<T> &data)
    {
    data.clear ();
    if (!empty ())
        {
        data.swap (back());
        PopToCache ();
        return true;
        }
    return false;
    }
};
/*=================================================================================**/

struct  ConvexClipPlaneSet : T_ClipPlanes
    {
    ConvexClipPlaneSet () {}

    ConvexClipPlaneSet (size_t n) : T_ClipPlanes (n) { }

    GEOMDLLIMPEXP  ConvexClipPlaneSet (ClipPlaneCP planes, size_t nPlanes);

    GEOMDLLIMPEXP bool IsPointInside (DPoint3dCR point) const;

    GEOMDLLIMPEXP bool IsPointOnOrInside (DPoint3dCR point, double tolerance) const;

    GEOMDLLIMPEXP bool IsSphereInside (DPoint3dCR point, double tolerance) const;

    GEOMDLLIMPEXP bool ClipBoundedSegment (DPoint3dCR pointA, DPoint3dCR pointB, double &fraction0, double &fraction1, double planeSign) const;

    GEOMDLLIMPEXP bool ClipUnBoundedSegment (DPoint3dCR pointA, DPoint3dCR pointB, double &fraction0, double &fraction1, double planeSign) const;

    GEOMDLLIMPEXP static ConvexClipPlaneSet  FromXYBox (double x0, double y0, double x1, double y1);

    // normals
    GEOMDLLIMPEXP static ConvexClipPlaneSet  FromXYPolyLine (bvector<DPoint3d> &points, bvector<bool> &hiddenEdge, bool leftIsInside);

    GEOMDLLIMPEXP ClipPlaneContainment ClassifyPointContainment (DPoint3dCP points, size_t nPoints, bool onIsOutside = false) const;

    GEOMDLLIMPEXP void TransformInPlace (TransformCR transform);

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

    GEOMDLLIMPEXP int ReloadSweptConvexPolygon
        (
        bvector<DPoint3d> const &points, 
        DVec3dCR sweepDirection,        
        int sideSelect                  
        );
    GEOMDLLIMPEXP void ConvexPolygonClip
        (
        bvector<DPoint3d> const &input, 
        bvector<DPoint3d> &output,      
        bvector<DPoint3d> &work         
        ) const;

    GEOMDLLIMPEXP void ConvexPolygonClipInsideOutside
    (
    bvector<DPoint3d> const &input, 
    bvector<DPoint3d> &inside,      
    BVectorCache<DPoint3d> &outside,      
    bvector<DPoint3d> &work1,       
    bvector<DPoint3d> &work2,       
    bool clearOutside = true,        
    double distanceTolerance = 0.0  
    ) const;
    }; // ConvexClipPlaneSet


typedef bvector <ConvexClipPlaneSet>    T_ConvexClipPlaneSets;

/*=================================================================================**/

struct  ClipPlaneSet :  T_ConvexClipPlaneSets
    {
    ClipPlaneSet () { }

    GEOMDLLIMPEXP ClipPlaneSet(ClipPlaneCP planes, size_t nPlanes);

    GEOMDLLIMPEXP ClipPlaneSet (ConvexClipPlaneSetCR convexSet);

    GEOMDLLIMPEXP static ClipPlaneSet FromSweptPolygon (DPoint3dCP points, size_t n, DVec3dCP direction = NULL);
    GEOMDLLIMPEXP static ClipPlaneSet FromSweptPolygon (DPoint3dCP points, size_t n, DVec3dCP direction,
                bvector<bvector<DPoint3d>> *shapes
                );

    GEOMDLLIMPEXP bool IsPointInside (DPoint3dCR point) const;

    GEOMDLLIMPEXP bool IsPointOnOrInside (DPoint3dCR point, double tolerance) const;

    GEOMDLLIMPEXP bool IsSphereInside (DPoint3dCR point, double radius) const;

    GEOMDLLIMPEXP void TransformInPlace (TransformCR transform);

    GEOMDLLIMPEXP static ClipPlaneSet  FromXYBox (double x0, double y0, double x1, double y1);

    GEOMDLLIMPEXP bool    TestRayIntersect (DPoint3dCR point, DVec3dCR direction) const;

    GEOMDLLIMPEXP bool    GetRayIntersection (double& tNear, DPoint3dCR point, DVec3dCR direction) const;

    GEOMDLLIMPEXP ClipPlaneContainment ClassifyPointContainment (DPoint3dCP points, size_t nPoints, bool onIsOutside = false) const;
    
    GEOMDLLIMPEXP bool      GetRange (DRange3dR range, TransformCP transform) const;
    };

typedef bvector <ClipPlaneSet>    T_ClipPlaneSets;

END_BENTLEY_GEOMETRY_NAMESPACE