ElementRefBase.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 <RmgrTools/Tools/HeapzoneAllocator.h>
#include "DgnElements.h"
#include "DgnAppData.h"

BENTLEY_TYPEDEFS (HeapZone);
DGNPLATFORM_TYPEDEFS (ElementRefVec);

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

enum ElementRefType
{
    ELEMENT_REF_TYPE_Persistent     = 1,
    ELEMENT_REF_TYPE_TransientElm   = 2,
    ELEMENT_REF_TYPE_ViewTemp       = 3,
    ELEMENT_REF_TYPE_ProxyDisplay   = 4,
};

enum ElementHiliteState
{
    HILITED_None                = 0,
    HILITED_Normal              = 1,
    HILITED_Bold                = 2,
    HILITED_Dashed              = 3,
    HILITED_ComponentsNormal    = 4,
    HILITED_ComponentsOnly      = 5,
    HILITED_Background          = 6,
};

//=======================================================================================
//=======================================================================================
enum ElemRefChangeReason
{
    ELEMREF_CHANGE_REASON_Delete            = 1,
    ELEMREF_CHANGE_REASON_Modify            = 2,
    ELEMREF_CHANGE_REASON_MovedToNewElemRef = 4,
    ELEMREF_CHANGE_REASON_ClearQVData       = 5,
};

//=======================================================================================
//=======================================================================================
struct      ElementRefAppData
{
    virtual ~ElementRefAppData() {}
    
    //=======================================================================================
    //=======================================================================================
    struct Key : AppDataKey {};

    virtual WCharCP _GetName () {return NULL;}

    virtual void _OnCleanup (ElementRefP host, bool unloadingModel, HeapZoneR zone) = 0;

    virtual bool _OnElemChanged (ElementRefP host, bool qvCacheDeleted, ElemRefChangeReason reason) {return false;}

private:
    virtual bool _Dummy3(void*) {return false;}
    virtual bool _Dummy2(void*) {return false;}
    virtual bool _Dummy1(void*) {return false;}
};

typedef bvector<ElementRefP> T_StdElementRefVector;

//=======================================================================================
// @bsiclass                                                     Bentley Systems
//=======================================================================================
struct  ElementRefVec : bvector<ElementRefBase*> 
{
};

//=======================================================================================
//=======================================================================================
CLRPUBLIC struct ElementRefBase 
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    DGNPLATFORM_EXPORT HeapZoneR GetHeapZone ();

    DGNPLATFORM_EXPORT StatusInt AddAppData (ElementRefAppData::Key const& key, ElementRefAppData* appData, HeapZoneR heapZone, bool allowOnDeleted=false);
                                
    DGNPLATFORM_EXPORT StatusInt DropAppData (ElementRefAppData::Key const& key);

    DGNPLATFORM_EXPORT ElementRefAppData* FindAppData (ElementRefAppData::Key const& key);

    DGNPLATFORM_EXPORT ElementRefP GetParentElementRef ();

    DGNPLATFORM_EXPORT DgnModelP GetDgnModelP ();

    DGNPLATFORM_EXPORT DependentElm* GetFirstDependent ();

    DGNPLATFORM_EXPORT int GetDependents (ElementRefP* depRefs, int maxDependents);

    DGNPLATFORM_EXPORT bool IsDependent (ElementRefP isThisDependent, bool recurse);

    DGNPLATFORM_EXPORT ElementId GetElementId () const;

    DGNPLATFORM_EXPORT int GetElementType () const;

    DGNPLATFORM_EXPORT UInt32 GetLevel () const;

    DGNPLATFORM_EXPORT T_Adouble GetLastModified () const;

    DGNPLATFORM_EXPORT bool IsComplexComponent () const;

    DGNPLATFORM_EXPORT bool IsGraphics () const;

    DGNPLATFORM_EXPORT ElementRefP ValidateElementRef ();
    };

END_BENTLEY_DGNPLATFORM_NAMESPACE