Constraint2dCoreAPI.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/DgnPlatformApi.h>

/*=================================================================================**/
#ifdef __CONSTRAINT2DCORE_BUILD__
    #define CONSTRAINT2DCORE_EXPORT __declspec(dllexport)
#else
    #define CONSTRAINT2DCORE_EXPORT __declspec(dllimport)
#endif

#define BEGIN_CONSTRAINT2D_NAMESPACE        BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE namespace Constraint2d {
#define END_CONSTRAINT2D_NAMESPACE                }}}
#define USING_NAMESPACE_CONSTRAINT2D        using namespace Bentley::DgnPlatform::Constraint2d;

#define CONSTRAINT2D_CORE_TYPEDEFS(t) \
    BEGIN_CONSTRAINT2D_NAMESPACE struct t; END_CONSTRAINT2D_NAMESPACE \
    ADD_BENTLEY_TYPEDEFS (DgnPlatform::Constraint2d,t);

CONSTRAINT2D_CORE_TYPEDEFS (Constraint2dSolverData)
CONSTRAINT2D_CORE_TYPEDEFS (CurveEntityIdentifier)
CONSTRAINT2D_CORE_TYPEDEFS (Constraint2dData)
CONSTRAINT2D_CORE_TYPEDEFS (Dimension2dData)
CONSTRAINT2D_CORE_TYPEDEFS (Drag2dInfo)
CONSTRAINT2D_CORE_TYPEDEFS (Constraint2dSolver)


BEGIN_CONSTRAINT2D_NAMESPACE





enum class VertexType
    {
    Edge                         = 0,   
    Start                        = 1,   
    End                          = 2,   
    Center                       = 3,   
    Parameter                    = 4,   
    PointIndex                   = 5,   
    EllipseMajor1                = 6,   
    EllipseMajor2                = 7,   
    EllipseMinor1                = 8,   
    EllipseMinor2                = 9,   
    ArcPoint                     = 10,  
    EllipseMajorEdge             = 11,  
    EllipseMinorEdge             = 12,  
    PlanarFace                   = 13,  
    };

enum class SectorAngleType
    {
    Parallel_AntiClockwise,             
    Parallel_Clockwise,                 
    AntiParallel_AntiClockwise,         
    AntiParallel_Clockwise,             
    };


enum class Constraint2dType
    {
    Distance                    = 0,    
    Angle                       = 1,    
    Concentric                  = 2,    
    Radius                      = 3,    
    Parallel                    = 4,    
    Perpendicular               = 5,    
    Coincident                  = 6,    
    Tangent                     = 7,    
    Identical                   = 8,    
    Symmetric                   = 9,    
    Major_Radius                = 10,    
    Minor_Radius                = 11,    
    Equal_Radius                = 12,    
    Equal_Distance              = 13,    
    Midpoint                    = 14,    
    Dependence                  = 15,    
    Patterned                   = 16,    
    Equal_Parameter             = 17,    
    Normal                      = 18,    
    Equal_Direction             = 19,    
    Equal_Curvature             = 20,    
    Equal_First_Derivative      = 21,    
    Equal_Second_Derivative     = 22,    
    Offset                      = 23,    
    Simple_Dependence           = 24,    
    Curve_Length                = 25,    
    Patterned_2d                = 26,    
    Pattern_Value               = 27,    
    Pattern_2d_value_1          = 28,    
    Pattern_2d_value_2          = 29,    
    Equal_Relative_Transform    = 30,    
    Arc_length                  = 31,    
    Offset_Dimension            = 32,    
    //User-defined constraints
    Area                        = 100,  
    Perimeter                   = 101,  
    Fix                         = 102,  
    Horizontal                  = 103,    
    Vertical                    = 104,  
    Equal                       = 105,  
    Planar_Distance             = 106,  

    //Invalid constraint type
    Dummy                       = 1000,
    };

enum class Constraint2dStatus
    {
    Unknown,                   
    Between_Fixed,             
    Between_Set_Members,       
    Over_Defined,              
    Non_Algebraic,             
    Not_Consistent,            
    Not_Consistent_Dimensions, 
    Not_Consistent_Other,      
    Not_Consistent_Unknown,    
    Not_Solved,                
    Not_Changed,               
    Solved,                    
    };//ConstraintStatus 

enum class DragTransformType
    {
    General,                 
    Translation,             
    Radius,                  
    Major_Radius,            
    Minor_Radius,            
    Offset_Distance,         
    };//DragTransformType
// from DCM_half_space
enum class DimensionHalfSpace
    {
    Unspecified                = 0,
    Left                       = 1,
    Right                      = 2,
    };

enum class DimensionAlignmentType
    {
    DimAlign_Unknown,                   
    DimAlign_Drawing_X,                 
    DimAlign_Drawing_X_Reversed,        
    DimAlign_Drawing_Y,                 
    DimAlign_Drawing_Y_Reversed,        
    };


//=======================================================================================
//Identifier for sub-entitiy in curve vector
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct CurveEntityIdentifier
{
private:
    CurveVectorPtr                  m_curveVectorPtr;
    UInt32                          m_pepIndex;
    ElementRefP                     m_elementRef;

    CurvePrimitiveIdPtr             m_edgeId;
    size_t                          m_subEdgeIndex;
    VertexType                      m_vertexType;

    UInt32                          m_segmentsInCurveVector;

    // The following members are used during solving - but not persisted.
    mutable bool                    m_fixed;
    mutable bool                    m_hosted;

public:
    CONSTRAINT2DCORE_EXPORT CurveEntityIdentifier ();                                                 

    CONSTRAINT2DCORE_EXPORT CurveEntityIdentifier (CurveVectorR curve, CurvePrimitiveIdCP edgeId, size_t subIndex, VertexType vertexType, ElementRefP elementRef);

    CONSTRAINT2DCORE_EXPORT CurveEntityIdentifier (CurveVectorR curve, CurveLocationDetailCR location, VertexType vertexType, ElementRefP elementRef);

    CONSTRAINT2DCORE_EXPORT bool                   operator == (CurveEntityIdentifierCR rhs) const;

    CONSTRAINT2DCORE_EXPORT bool                   operator < (CurveEntityIdentifierCR rhs) const;

    CONSTRAINT2DCORE_EXPORT bool                IsValid () const;
    CONSTRAINT2DCORE_EXPORT void                SetEdgeId (CurvePrimitiveIdP edgeId);
    CONSTRAINT2DCORE_EXPORT CurvePrimitiveIdCP  GetEdgeId () const;
                            
    CONSTRAINT2DCORE_EXPORT void                SetSubEdgeIndex (size_t subEdgeIndex);
    CONSTRAINT2DCORE_EXPORT size_t              GetSubEdgeIndex () const;

    CONSTRAINT2DCORE_EXPORT void                SetVertexType (VertexType vertexType);

    // Put here, no need to expose another class for SDK examples
    CONSTRAINT2DCORE_EXPORT static StatusInt    ElementToCurveVector (CurveVectorPtr& curveVector, ElementHandleCR eh);

    CONSTRAINT2DCORE_EXPORT VertexType          GetVertexType () const;

    CONSTRAINT2DCORE_EXPORT void                SetPointIndex (size_t pointIndex);
    CONSTRAINT2DCORE_EXPORT size_t              GetPointIndex () const;                                                                                                                                                                          
};//CurveEntityIdentifier

typedef bvector<CurveEntityIdentifier>             T_CurveEntityIdArray;
typedef bset<CurveEntityIdentifier>                T_CurveEntityIdSet;


//=======================================================================================
//Structure to hold data for constraint
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Constraint2dData
{
private:
    Constraint2dType        m_constraintType;
    Constraint2dStatus      m_constraintStatus;
    T_CurveEntityIdArray    m_curveIds;
    
    mutable bool            m_filtered;
    UInt32                  m_version;

protected:
    virtual BentleyStatus   _Load (DataInternalizer& source);
    virtual void            _Store (DataExternalizer& sink) const;
public:
    CONSTRAINT2DCORE_EXPORT Constraint2dData ();
    
    CONSTRAINT2DCORE_EXPORT Constraint2dData (Constraint2dType constraintType);
    
    CONSTRAINT2DCORE_EXPORT virtual ~Constraint2dData () {;}

    CONSTRAINT2DCORE_EXPORT Constraint2dData (Constraint2dData const& c2);
    CONSTRAINT2DCORE_EXPORT Constraint2dData& operator = (Constraint2dData const& c2);

    CONSTRAINT2DCORE_EXPORT void                            SetConstraintType (Constraint2dType type);
    CONSTRAINT2DCORE_EXPORT Constraint2dType                GetConstraintType () const;

    CONSTRAINT2DCORE_EXPORT void                            SetConstraintStatus (Constraint2dStatus status);
    CONSTRAINT2DCORE_EXPORT Constraint2dStatus              GetConstraintStatus () const;
    CONSTRAINT2DCORE_EXPORT void                            AddCurveIdentifier (CurveEntityIdentifierCR id);
    CONSTRAINT2DCORE_EXPORT T_CurveEntityIdArray const&     GetCurveIdentifiers () const;
};//Constraint2dData


//=======================================================================================
//Structure to hold data for dimensional constraint
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Dimension2dData : Constraint2dData
{
private:
    double              m_dimensionValue;
    WString             m_variableName;
    DVec2d              m_textOffset;
    double              m_fraction;
    SectorAngleType     m_sectorAngleType;
    UInt32              m_angleSectorIndex;
    DimensionHalfSpace  m_halfSpace1;
    DimensionHalfSpace  m_halfSpace2;
    DimensionAlignmentType  m_alignType;
    UInt32              m_diaType;
    
    ElementId           m_dimensionStyle;
    bvector<DVec2d>     m_leaderLines;
    UInt32              m_dimensionOptions;

public:
    CONSTRAINT2DCORE_EXPORT Dimension2dData ();
    CONSTRAINT2DCORE_EXPORT Dimension2dData (Constraint2dType constraintType);

    CONSTRAINT2DCORE_EXPORT Dimension2dData (Dimension2dData const& d2);
    CONSTRAINT2DCORE_EXPORT Dimension2dData& operator = (Dimension2dData const& d2);
    
    CONSTRAINT2DCORE_EXPORT void                SetDimensionValue (double value);
    CONSTRAINT2DCORE_EXPORT double              GetDimensionValue () const;
    CONSTRAINT2DCORE_EXPORT void                SetVariableName (WStringCR name);
    CONSTRAINT2DCORE_EXPORT WStringCR           GetVariableName () const;

    CONSTRAINT2DCORE_EXPORT void                SetSectorAngleType (SectorAngleType type);
    CONSTRAINT2DCORE_EXPORT SectorAngleType     GetSectorAngleType () const;

    CONSTRAINT2DCORE_EXPORT void                SetDimensionHeight (double value);
    CONSTRAINT2DCORE_EXPORT double              GetDimensionHeight () const;

    CONSTRAINT2DCORE_EXPORT void                SetDimensionFraction (double value);
    CONSTRAINT2DCORE_EXPORT double              GetDimensionFraction () const;

    CONSTRAINT2DCORE_EXPORT void                SetAngleSectorIndex (UInt32 sectorIndex);
    CONSTRAINT2DCORE_EXPORT UInt32              GetAngleSectorIndex () const;

    CONSTRAINT2DCORE_EXPORT void                SetHalfSpace1 (DimensionHalfSpace halfSpace);
    CONSTRAINT2DCORE_EXPORT DimensionHalfSpace  GetHalfSpace1 () const;
    CONSTRAINT2DCORE_EXPORT void                SetHalfSpace2 (DimensionHalfSpace halfSpace);
    CONSTRAINT2DCORE_EXPORT DimensionHalfSpace  GetHalfSpace2 () const;

    CONSTRAINT2DCORE_EXPORT void                    SetDimensionAlignmentType (DimensionAlignmentType type);
    CONSTRAINT2DCORE_EXPORT DimensionAlignmentType  GetDimensionAlignmentType () const;

    CONSTRAINT2DCORE_EXPORT bool operator == (Dimension2dDataCR rhs) const;    

    CONSTRAINT2DCORE_EXPORT void                SetDimensionXOffset (double value);
    CONSTRAINT2DCORE_EXPORT double              GetDimensionXOffset () const;
    
    CONSTRAINT2DCORE_EXPORT void                SetDiaType (UInt32 value);
    CONSTRAINT2DCORE_EXPORT UInt32              GetDiaType () const;



};//Dimension2dData

typedef bset <Constraint2dData>         T_Constraint2dDataSet;
typedef bvector<Constraint2dData>       T_Constraint2dDataArray;

typedef bset <Dimension2dData>          T_Dimension2dDataSet;
typedef bvector<Dimension2dData>        T_Dimension2dDataArray;

//=======================================================================================
//Structure to hold information for dragging manipulator
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Drag2dInfo
{
private:
    CurveEntityIdentifier       m_subEntityIdentifer;
    DragTransformType           m_transformType;
    DVec3d                      m_moveValue;
    double                      m_radius;

public:
    CONSTRAINT2DCORE_EXPORT Drag2dInfo ();
    CONSTRAINT2DCORE_EXPORT Drag2dInfo (CurveEntityIdentifierCR identifer, DragTransformType transformType = DragTransformType::Translation);

    CONSTRAINT2DCORE_EXPORT CurveEntityIdentifierCR     GetCurveEntityIdentifier () const;
    CONSTRAINT2DCORE_EXPORT void                        SetCurveEntityIdentifier (CurveEntityIdentifierCR identifer);

    CONSTRAINT2DCORE_EXPORT DragTransformType           GetDraggingTransform () const;
    CONSTRAINT2DCORE_EXPORT void                        SetDraggingTransform  (DragTransformType transformType);

    CONSTRAINT2DCORE_EXPORT DVec3dCR                    GetMoveValue () const;
    CONSTRAINT2DCORE_EXPORT void                        SetMoveValue (DVec3dCR value);

    CONSTRAINT2DCORE_EXPORT double                      GetRadius () const;
    CONSTRAINT2DCORE_EXPORT void                        SetRadius (double radius);
    CONSTRAINT2DCORE_EXPORT void                        Clear ();

};//Drag2dInfo
typedef bvector<Drag2dInfo>  Drag2dInfoArray;
typedef bvector<Drag2dInfo>& Drag2dInfoArrayR;
//=======================================================================================
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Constraint2dSolver: public NonCopyableClass
{
private:
    struct D2dSolver*               m_solverImp;

public:
    CONSTRAINT2DCORE_EXPORT Constraint2dSolver (double localToWorldScale, bool isAutoConstraining = false);

    CONSTRAINT2DCORE_EXPORT ~Constraint2dSolver ();

    CONSTRAINT2DCORE_EXPORT bool SetData (Constraint2dSolverDataCR data, double uorPerMaster = 1.0);
    CONSTRAINT2DCORE_EXPORT void GetData (Constraint2dSolverDataR data);

    CONSTRAINT2DCORE_EXPORT BentleyStatus Evaluate (Drag2dInfoArray const& dragInfos, bool isDynamic);

    CONSTRAINT2DCORE_EXPORT BentleyStatus GetResultCurveVector (CurveVectorPtr& resultCurve, ElementRefP elementRef);

    };//Constraint2dSolver
//=======================================================================================
// @remark Required library : Contraint2dCore<ApiNumber>.lib  i.e. Contraint2dCore1.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct Constraint2dSolverData   
{
    T_Constraint2dDataArray     m_constraints;
    T_Dimension2dDataArray      m_dimensions;
    
public:
    CONSTRAINT2DCORE_EXPORT Constraint2dSolverData () {;}
    CONSTRAINT2DCORE_EXPORT Constraint2dSolverData (Constraint2dSolverData const& rhs);
    CONSTRAINT2DCORE_EXPORT Constraint2dSolverData& operator= (Constraint2dSolverData const& rhs);
    
    CONSTRAINT2DCORE_EXPORT void            Clear () { m_constraints.clear(); m_dimensions.clear(); }

    CONSTRAINT2DCORE_EXPORT bool            IsEmpty () const   {return (m_constraints.empty() && m_dimensions.empty());}
    CONSTRAINT2DCORE_EXPORT bool            IsResolved () const;
    CONSTRAINT2DCORE_EXPORT bool            IsComplete () const;
    
    CONSTRAINT2DCORE_EXPORT size_t          GetElementRefs (T_StdElementRefSet& elementRefs) const;

    CONSTRAINT2DCORE_EXPORT bool            Merge (Constraint2dSolverData const& rhs);

    CONSTRAINT2DCORE_EXPORT size_t          CollateByElement (bvector<Constraint2dSolverData>& childGroups) const;

                            void            RemoveDuplicates ();

    CONSTRAINT2DCORE_EXPORT bool            RemoveElementRef (ElementRefP elementRef);
    CONSTRAINT2DCORE_EXPORT void            RemoveUnresolvedElementRefs ();
    CONSTRAINT2DCORE_EXPORT void            RemoveInvalidConstraints (size_t& invalidCount, ElementRefP elementRef);
    
    CONSTRAINT2DCORE_EXPORT bool            Reverse (ElementRefP elementRef, CurveVectorCP curveVector = NULL);
    CONSTRAINT2DCORE_EXPORT void            Replace (ElementRefP oldElementRef, ElementRefP newElementRef);

    CONSTRAINT2DCORE_EXPORT bool            IsCurvePlaneFixed (CurveEntityIdentifierCR curveId) const;
    CONSTRAINT2DCORE_EXPORT bool            IsCurvePlaneConstrained (CurveEntityIdentifierCR curveId) const;
    
};  // Constraint2dSolverData


END_CONSTRAINT2D_NAMESPACE