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

#include "DgnPlatform.h"
#include <Geom/ClipPlaneSet.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

typedef bvector<DPoint2d>       T_ClipPolygon;

/*=================================================================================**/
struct ClipPolygon : bvector <DPoint2d>
{
    ClipPolygon () { }
    ClipPolygon (DPoint2dCP points, size_t nPoints);
    void Init(DPoint2dCP points, size_t nPoints);

};  // ClipPolygon


typedef ClipPolygon const*      ClipPolygonCP;
typedef ClipPolygon const&      ClipPolygonCR;

/*=================================================================================**/
struct  ClipPrimitive  : RefCountedBase
{

public:
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateCopy (ClipPrimitiveCR primitive); 
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromBlock (DPoint3dCR low, DPoint3dCR high, bool outside, ClipMask clipMask, TransformCP transformFromClip, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromShape(DPoint2dCP points, size_t numPoints, bool outside, double const* zLow, double const* zHigh, TransformCP transformFromClip, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromClipPlanes(ClipPlaneSetCR planes, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromGPA(GPArrayCR gpa, double chordTolerance, double angleTolerance, bool isMask, double const* zLow, double const* zHigh, TransformCP transformFromClip, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromGPA(GPArrayCR gpa, ClipPolygonCR, bool isMask, double const* zLow, double const* zHigh, TransformCP transformFromClip, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromBoundaryCurveVector(CurveVectorCR curveVector, double chordTolerance, double angleTolerance, double const* zLow, double const* zHigh, TransformCP transformFromClip, bool invisible = false);
    DGNPLATFORM_EXPORT static ClipPrimitivePtr  CreateFromConvexPolyface (PolyfaceQueryCR polyface);

    DGNPLATFORM_EXPORT ClipPlaneSetCP           GetClipPlanes () const;
    DGNPLATFORM_EXPORT ClipPlaneSetCP           GetMaskPlanes() const;
    DGNPLATFORM_EXPORT ClipPlaneSetCP           GetMaskOrClipPlanes() const;
    DGNPLATFORM_EXPORT GPArrayCP                GetGPA (bool onlyIfNonLinear) const;
    DGNPLATFORM_EXPORT MSBsplineCurveCP         GetBCurve () const;
    DGNPLATFORM_EXPORT bool                     GetRange (DRange3dR range, TransformCP transform, bool returnMaskRange = false) const;
    DGNPLATFORM_EXPORT TransformCP              GetTransformToClip () const;
    DGNPLATFORM_EXPORT TransformCP              GetTransformFromClip () const;
    DGNPLATFORM_EXPORT bool                     GetInvisible () const;
    DGNPLATFORM_EXPORT bool                     GetTransforms (TransformP forward, TransformP inverse);
    DGNPLATFORM_EXPORT BentleyStatus            TransformInPlace (TransformCR transform);
    DGNPLATFORM_EXPORT bool                     IsMask () const;
    DGNPLATFORM_EXPORT bool                     ClipZHigh () const;
    DGNPLATFORM_EXPORT bool                     ClipZLow() const;
    DGNPLATFORM_EXPORT double                   GetZLow() const;
    DGNPLATFORM_EXPORT double                   GetZHigh() const;
    DGNPLATFORM_EXPORT ClipPolygonCP            GetPolygon () const;
    DGNPLATFORM_EXPORT bool                     PointInside (DPoint3dCR point, double onTolerance = 0.0) const;
    DGNPLATFORM_EXPORT bool                     SphereInside (DPoint3dCR point, double radius) const;
    DGNPLATFORM_EXPORT void                     SetIsMask (bool isMask);
    DGNPLATFORM_EXPORT void                     SetZLow (double zLow);
    DGNPLATFORM_EXPORT void                     SetZHigh(double zHigh);
    DGNPLATFORM_EXPORT void                     SetClipZLow(bool clipZLow);
    DGNPLATFORM_EXPORT void                     SetClipZHigh(bool clipZHigh);
    DGNPLATFORM_EXPORT void                     SetInvisible (bool invisible); 
    DGNPLATFORM_EXPORT bool                     IsXYPolygon () const;
    DGNPLATFORM_EXPORT bool                     ContainsZClip() const;
    DGNPLATFORM_EXPORT void                     ParseClipPlanes () const;
    DGNPLATFORM_EXPORT BentleyStatus            ApplyCameraToPlanes (double focalLength);
    DGNPLATFORM_EXPORT ClipPlaneContainment     ClassifyPointContainment (DPoint3dCP points, size_t nPoints, bool ignoreMasks = false) const;
    DGNPLATFORM_EXPORT void                     TransformToClip (DPoint3dR point) const;
    DGNPLATFORM_EXPORT void                     TransformFromClip(DPoint3dR point) const;
    DGNPLATFORM_EXPORT void                     ExpandClipPlanes(double distance);

};

END_BENTLEY_DGNPLATFORM_NAMESPACE