FenceParams.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_DGNPLATFORM_NAMESPACE
//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
enum class FenceClipMode
    {
    None        = 0, 
    Original    = 1, 
    Copy        = 3, 
    };

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct FenceParams
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT void                 SetViewParams (ViewportP);

DGNPLATFORM_EXPORT void                 SetModelRef (DgnModelRefP);

DGNPLATFORM_EXPORT void                 SetOverlapMode (bool mode);

DGNPLATFORM_EXPORT void                 SetClipMode (FenceClipMode);

DGNPLATFORM_EXPORT void                 SetClip (ClipVectorCR clip);

DGNPLATFORM_EXPORT void                 SetTransform (TransformCR);

DGNPLATFORM_EXPORT void                 SetLocateInteriors (LocateSurfacesPref);

DGNPLATFORM_EXPORT StatusInt            StoreClippingPoints (bool outside, DPoint2dP, int nPoints);

DGNPLATFORM_EXPORT StatusInt            StoreClippingElement (ElementHandleCR, bool outside);

DGNPLATFORM_EXPORT void                 ClippingPointsFromRootPoints (DPoint2dP, DPoint3dP, int numPts, ViewportP);

DGNPLATFORM_EXPORT bool                 IsCameraOn () const;

DGNPLATFORM_EXPORT double               GetFocalLength () const;

DGNPLATFORM_EXPORT DgnModelRefP         GetModelRef () const;

DGNPLATFORM_EXPORT ClipVectorPtr        GetClipVector () const;

DGNPLATFORM_EXPORT FenceClipMode        GetClipMode () const;

DGNPLATFORM_EXPORT ViewportP            GetViewport () const;

DGNPLATFORM_EXPORT TransformP           GetTransform ();

DGNPLATFORM_EXPORT bool                 PointInside (DPoint3dCR);

DGNPLATFORM_EXPORT bool                 HasOverlaps () const;

DGNPLATFORM_EXPORT bool                 AllowOverlaps () const;

DGNPLATFORM_EXPORT StatusInt            SetToModelRef (DgnModelRefP);

DGNPLATFORM_EXPORT bool                 AcceptElement (ElementHandleCR);

DGNPLATFORM_EXPORT BentleyStatus        BuildAgenda (ElementAgendaR agenda, DgnModelRefListP searchList);

DGNPLATFORM_EXPORT static FenceParamsP  Create (DgnModelRefP);

DGNPLATFORM_EXPORT static void          Delete (FenceParamsP);

}; // FenceParams

END_BENTLEY_DGNPLATFORM_NAMESPACE