DisplayPath.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"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
CLRPUBLIC struct DisplayPath : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

    DGNPLATFORM_EXPORT DgnModelRefP GetRoot () const;

    DGNPLATFORM_EXPORT int          GetCount () const;

    DGNPLATFORM_EXPORT ElementRefP  GetPathElem (int index) const;

    DGNPLATFORM_EXPORT ElementRefP  GetHeadElem () const;

    DGNPLATFORM_EXPORT ElementRefP  GetTailElem () const;

    DGNPLATFORM_EXPORT ElementRefP  GetCursorElem () const;

    DGNPLATFORM_EXPORT ElementRefP  GetComponentElem () const;

    DGNPLATFORM_EXPORT ElementRefP  GetChildElem (ExposeChildrenReason reason = ExposeChildrenReason::Query) const;

    DGNPLATFORM_EXPORT ElementRefP  GetSharedChildElem (ExposeChildrenReason reason = ExposeChildrenReason::Query) const;
    
    DGNPLATFORM_EXPORT void         SetRoot (DgnModelRefP ref);

    DGNPLATFORM_EXPORT void         PushPathElem (ElementRefP elRef);

    DGNPLATFORM_EXPORT ElementRefP  PopPathElem ();

    DGNPLATFORM_EXPORT void         SetCursorIndex (int index);

    DGNPLATFORM_EXPORT static DisplayPathPtr Create ();

}; // DisplayPath

END_BENTLEY_DGNPLATFORM_NAMESPACE