ConstraintHandlerBase.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\ParametricModeling.h>
#include    <Mstn\Constraint2dElement\Constraint2dElementApi.h>

BEGIN_CONSTRAINT2D_NAMESPACE

typedef bmap <ElementRefP, EditElementHandleP>  T_ModifiedElementMap;
typedef bvector <PersistentElementPath>         T_PepVector;



/*=================================================================================**/
struct ConstraintDisplayUtils
{
    CONSTRAINT2DELEMENT_EXPORT static ISpriteP GetSpriteByIconName (WStringCR iconName, size_t size);
};
/*=================================================================================**/
struct ConstraintHandlerUtils
{
    CONSTRAINT2DELEMENT_EXPORT static void RegisterRejectExtensions (HandlerR handler);

};  // ConstraintHandlerUtils

/*---------------------------------------------------------------------------------**/
struct IConstraintRootPepCollection : RefCountedBase
    {
    virtual size_t                  GetCount() const = 0;
    virtual PersistentElementPathP  GetPep (size_t index) = 0;
    virtual bool                    Remove (size_t index) = 0;

    struct ConstraintRootPepIterator : std::iterator<std::forward_iterator_tag, PersistentElementPath>
        {
    private:
        IConstraintRootPepCollection&   m_collection;
        size_t                          m_index;
    public:
        reference                   operator*() const { return *m_collection.GetPep (m_index); }
        bool                        operator==(ConstraintRootPepIterator const& rhs) const { return &m_collection == &rhs.m_collection && m_index == rhs.m_index; }
        bool                        operator!=(ConstraintRootPepIterator const& rhs) const { return !(*this == rhs); }
        ConstraintRootPepIterator&  operator++() { ++m_index; return *this; }

        ConstraintRootPepIterator (IConstraintRootPepCollection& collection, size_t index) : m_collection (collection), m_index (index) { }
        };

    typedef ConstraintRootPepIterator   iterator;

    iterator                        begin() { return iterator (*this, 0); }
    iterator                        end()   { return iterator (*this, GetCount()); }
    };

typedef RefCountedPtr<IConstraintRootPepCollection> IConstraintRootPepCollectionPtr;

/*---------------------------------------------------------------------------------**/
enum class ConstraintOrientation
    {
    NotSpecified            = 0,
    Aligned,
    AntiAligned,
    Unsupported             = 0xff,
    };

/*=================================================================================**/
struct  ConstraintProxy : RefCountedBase
{
    virtual     Constraint2dType        _GetConstraintType() const = 0;
    virtual     bool                    _HasElementRef (ElementRefP elementRef) const = 0;
    virtual     ConstraintOrientation   _GetOrientation() const = 0;
    virtual     bool                    _SetOrientation (ConstraintOrientation orientation) = 0;
    virtual     WCharCP                 _GetIconName() const = 0;

}; // ConstraintProxy

/*=================================================================================**/
struct  DimensionProxy : RefCountedBase
{
    virtual     Constraint2dType _GetConstraintType() const = 0;
    virtual     bool    _HasElementRef (ElementRefP elementRef) const = 0;
    virtual     double  _GetValue () const = 0;
    virtual     void    _SetValue (double value) = 0;
    virtual     WString _GetVariableName() const = 0;
    virtual     void    _SetVariableName (WCharCP name) = 0;
    virtual     UInt32  _GetDiaType() const = 0;
    virtual     void    _SetDiaType (UInt32 value) = 0;

};//  DimensionProxy

typedef RefCountedPtr <ConstraintProxy>     ConstraintProxyPtr;
typedef RefCountedPtr <DimensionProxy>      DimensionProxyPtr;


/*=================================================================================**/
struct  ConstraintSolverDataProxy : RefCountedBase
{
    bvector <ConstraintProxyPtr>  m_constraints;
    bvector <DimensionProxyPtr>   m_dimensions;

    virtual StatusInt   _EvaluateAndUpdate (EditElementHandleR eeh) = 0;
    virtual void        _RemoveUnresolvedData (IConstraintRootPepCollection const& rootPeps) = 0;
    virtual size_t      _RemoveInvalidConstraints (ElementRefP root, ElementHandleCR dependent) = 0;
    virtual StatusInt   _Replace (IReplaceXAttribute* tbr) = 0;
    virtual StatusInt   _UpdateDimensions (ElementRefP elRef, bvector<DimensionProxy*> const& modifiedDimensions) = 0;
    virtual StatusInt   _GetDegreesOfFreedom (int& dof, int& rigidDof, DgnModelRefR modelRef) const = 0;

    bool                IsEmpty() const { return m_constraints.empty() && m_dimensions.empty(); }
};  // ConstraintDataProxy 

typedef RefCountedPtr <ConstraintSolverDataProxy>      ConstraintSolverDataProxyPtr;

/*=================================================================================**/
struct ConstraintXAttributeHandlerBase : IXAttributePointerContainerHandler, IDependencyHandler, XAttributeHandler, IParameterDependencyHandler
{
private:
    StatusInt                                               OnPreprocessCopyConstraints (IReplaceXAttribute* tbr, ElementHandleCR eh, IConstraintRootPepCollection& rootPeps, ElementCopyContextP cc);
    StatusInt                                               OnPreprocessCopyRemapConstraints (IReplaceXAttribute* tbr, ElementHandleCR eh, IConstraintRootPepCollection& rootPeps);
    IConstraintRootPepCollectionPtr                         GetRootPeps (DataInternalizer& source, XAttributeHandleCR xa, DgnModelRefR modelRef) const;
protected:
    virtual IConstraintRootPepCollectionPtr                 _GetRootPeps (DataInternalizer& source, XAttributeHandleCR xa, DgnModelRefR modelRef) const = 0;
    virtual BentleyStatus                                   _ReplaceRootPeps (DataExternalizer& sink, DataInternalizer& source, IConstraintRootPepCollection& rootPeps, DgnModelRefR modelRef) const = 0;
    virtual ConstraintSolverDataProxyPtr                    _GetConstraintSolverData (ElementHandleCR eh) const = 0;
    virtual bool                                            _IsConstraintElement (ElementHandleCR eh) const = 0;
    virtual bool                                            _FinishRootsChanged (ElementHandleCR dependent, ConstraintSolverDataProxy& data, T_StdElementRefSet& roots, bool modified) const = 0;
    virtual ConstraintSolverDataProxyPtr                    _GetConstraintSolverDataForRemap (ElementHandleCR eh) const { return _GetConstraintSolverData (eh); }

    CONSTRAINT2DELEMENT_EXPORT virtual bool                 _IsParameterReferenced (ParameterDefinitionCR def, IParameterDefinitionsCR defs) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                 _RemapOrDrop (ParameterDefinitionCR def, IEditParameterDefinitionsR defs, ParameterDefinitionCP remapTo) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual bool                 _GetControllingParameterAccessString (WStringR accessString, IDgnECTypeAdapterContextCR context) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                 _ValidateDependencies (IParameterDefinitionsCR defs) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                 _RemapParameterNames (IParameterDefinitionsCR defs, IParameterNameRemapperCR remapper) const override;
public:

    CONSTRAINT2DELEMENT_EXPORT virtual void                 _DisclosePointers (T_StdElementRefSet* refs, XAttributeHandleCR xa, DgnModelRefP homeModel) override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                 _OnElementIDsChanged (XAttributeHandleR xa, ElementAndModelIdRemappingCR remapTable, ElementHandleCR eh) override;
    CONSTRAINT2DELEMENT_EXPORT virtual StatusInt            _OnPreprocessCopy (IReplaceXAttribute* toBeReplaced, XAttributeHandleCR xa, ElementHandleCR eh, ElementCopyContextP cc) override;

    CONSTRAINT2DELEMENT_EXPORT virtual StatusInt            _OnPreprocessCopyRemapIds (IReplaceXAttribute* toBeReplaced, XAttributeHandleCR xa, ElementHandleCR eh) override;
    CONSTRAINT2DELEMENT_EXPORT virtual IDependencyHandler*  _GetIDependencyHandler () override {return this;}

    CONSTRAINT2DELEMENT_EXPORT virtual void                 _OnRootsChanged (ElementHandleR dependent, bvector<RootChange> const& rootsChanged, bvector<XAttributeHandle> const& xAttrsAffected) override;
    virtual void                                            _OnUndoRedoRootsChanged (ElementHandleR dependent, bvector<RootChange> const& rootsChanged, bvector<XAttributeHandle> const& xAttrsAffected) const override { }


    CONSTRAINT2DELEMENT_EXPORT static void                  DisplayInvalidConstraintRemovedMessage ();
    CONSTRAINT2DELEMENT_EXPORT static void                  DisplayConstraintAppliedMessage ();


};  // ConstraintXAttributeHandlerBase

/*=================================================================================**/
struct ConstraintAgendaEventListener : public IElementAgendaEvents
{
    struct IConstraintSolver 
        {
        UInt16          m_handlerMinorId;
        IConstraintSolver (UInt16 handlerMinorId) : m_handlerMinorId (handlerMinorId) { }
        virtual bool    _SolveAndModifyElements (ElementHandleCR hostEh, bmap <ElementRefP, EditElementHandleP>& modifiedElements, bool addRelatedChanges) = 0; 
        };

private:

    struct SolverAndModelRef
        {
        IConstraintSolver*      m_solver;
        DgnModelRefP            m_modelRef;

        SolverAndModelRef () { } 
        SolverAndModelRef (IConstraintSolver* solver, DgnModelRefP modelRef) : m_solver (solver), m_modelRef (modelRef) { }
        }; 

    typedef bvector <ElementRefP>       T_ElementRefs;

    bmap <ElementRefP, DgnModelRefP>        m_constrained;
    bmap <ElementRefP, SolverAndModelRef>   m_hostMap;
    T_ModifiedElementMap                    m_modifiedElementMap;
    ElementAgenda                           m_controlElmsToAdd;
    bvector <IConstraintSolver*>            m_solvers;

    bool        IsConstraintElement (ElementHandleCR eh, UInt16 handlerMinorId);
    ElementRefP FindConstraintElement (ElementRefP ref, UInt16 handlerMinorId);


protected:
    CONSTRAINT2DELEMENT_EXPORT virtual void _OnPreCopyAgenda (ElementAgendaCP agenda, AgendaOperation opType, AgendaModify modify, ElementCopyContextP cc) override;
    CONSTRAINT2DELEMENT_EXPORT virtual void _OnPreModifyAgenda (ElementAgendaCP agenda, AgendaOperation opType, AgendaModify modify, bool isGroupOperation) override;
    
    CONSTRAINT2DELEMENT_EXPORT virtual void _OnPostModifyAgenda (ElementAgendaCP agenda, AgendaOperation opType, AgendaModify modify, bool isGroupOperation) override;
    CONSTRAINT2DELEMENT_EXPORT virtual bool _OnRedrawGroupEvent (ElementAgendaCP agenda, AgendaOperation opType, AgendaModify modify, RedrawGroupInfo const* info) override;

public:
    CONSTRAINT2DELEMENT_EXPORT  static void Register ();
    CONSTRAINT2DELEMENT_EXPORT  static void AddSolver (IConstraintSolver* solver);

};  // ConstraintAgendaEventListenerBase

/*=================================================================================**/
struct ConstraintECProvider : IDgnECProvider, DgnECIntrinsicRelationshipProvider
    {
    typedef bmap <ECN::ECClassCP, ElementECEnablerPtr>  ExternalEnablersByClass;
private:


    ECN::ECSchemaPtr                        m_schema;
    ECN::ECSchemaPtr                        m_relationshipSchema;
    ExternalEnablersByClass                 m_enablerCache;

    bool                                    IsGeometricConstraint(WCharCP classname);
protected:
    // IECProvider
    CONSTRAINT2DELEMENT_EXPORT ConstraintECProvider(UInt16 providerId);

    CONSTRAINT2DELEMENT_EXPORT virtual UInt16                          _GetProviderId() const override  = 0;
    CONSTRAINT2DELEMENT_EXPORT virtual WCharCP                         _GetProviderName() const override = 0;
    CONSTRAINT2DELEMENT_EXPORT virtual ConstraintSolverDataProxyPtr    _GetConstraintSolverData (ElementHandleCR eh) const = 0;


    // IDgnECProvider
    CONSTRAINT2DELEMENT_EXPORT virtual ECN::ECSchemaPtr                _LocateSchemaInDgnFile (SchemaInfoR schemaInfo, ECN::SchemaMatchType matchType) override;
    CONSTRAINT2DELEMENT_EXPORT virtual BentleyStatus                   _LocateSchemaXmlInDgnFile (WStringR schemaXml, SchemaInfoR schemaInfo, ECN::SchemaMatchType matchType) override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                            _GetSchemaInfos (bvector<SchemaInfo>& infos, DgnFileR dgnfile, ECSchemaPersistence persistence) override;
    CONSTRAINT2DELEMENT_EXPORT virtual DgnECHostType                   _GetHostType() const override;
    CONSTRAINT2DELEMENT_EXPORT virtual bool                            _SupportsQueryFlags (ECQueryProcessFlags flags) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual bool                            _ExternalizeInstanceId (WStringR externalizedId, WCharCP internalId) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual bool                            _InternalizeInstanceId (WStringR internalizedId, WCharCP externalizedId, DgnFileP dgnfile, DgnModelRefP modelRef, ElementRefP elemRef) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                            _GetPotentialInstanceChanges (DgnECInstanceChangeRecordsR changes, DgnECTxnInfoCR txns, DgnECInstanceCreateContextCR context) const override;

    // IDgnECRelationshipProvider
    CONSTRAINT2DELEMENT_EXPORT virtual IDgnECInstanceFinderPtr         _CreateFinder (DgnFileR dgnfile, ECQueryCR ecquery, void* providerPerFileCache, DgnECInstanceCreateContextCR context) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual IDgnECInstanceFinderPtr         _CreateRelatedFinder (DgnECInstanceCR source, QueryRelatedClassSpecifierCR spec, DgnECInstanceCreateContextCR context) const override;
    CONSTRAINT2DELEMENT_EXPORT virtual void                            _GetSupportedRelationshipInfos (DgnECInstanceCR instance, DgnECRelationshipInfoVector& infos) const override;

    CONSTRAINT2DELEMENT_EXPORT virtual DgnECInstanceEnablerP           _ObtainInstanceEnablerByName (WCharCP schemaName, WCharCP className, DgnFileR dgnfile, void* providerPerFileCache) override;
    CONSTRAINT2DELEMENT_EXPORT virtual DgnECRelationshipEnablerP       _ObtainDgnECRelationshipEnabler (WCharCP schemaName, WCharCP className, DgnFileR dgnfile) override;

    CONSTRAINT2DELEMENT_EXPORT virtual DgnECInstancePtr                _LocateInstance (IDgnECInstanceLocatorCR locator, DgnECInstanceCreateContextCR context) const override;

    CONSTRAINT2DELEMENT_EXPORT virtual void                            _OnUnregistered() override;

public:
    ElementECEnablerPtr                     CreateEnabler (UInt16 providerId, WCharCP classname, ECAccessorTable & table);
    ElementECEnablerPtr                     GetEnablerByName (WCharCP classname) const;
                                                            
    ConstraintSolverDataProxyPtr            GetConstraintSolverData (ElementHandleCR eh) const { return _GetConstraintSolverData (eh); }
    static WString                          GetConstraintLabel(Constraint2dType  type);
    CONSTRAINT2DELEMENT_EXPORT static bool  GetControllingParameterAccessString (WStringR accessString, IDgnECTypeAdapterContextCR context, ConstraintSolverDataProxy const& solverData);
    };





END_CONSTRAINT2D_NAMESPACE