ElementCopyContext.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 "DependencyManagerLinkage.h"   // for DependencyRoot
#include "ElementHandle.h"                 // for ElementLinkageIteratorR
#include <Bentley/RefCounted.h>

DGNPLATFORM_TYPEDEFS (PropertyCollection)

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
//=======================================================================================

//=======================================================================================
//=======================================================================================
enum class CopyContextLevelOption
{
    ByUserPreference   = 0,
    CopyIfNotFound     = 1,
    CopyIfDifferent    = 2,
    CopyAlways         = 3,
    AlreadyRemapped    = 4,
    CopyByNumber       = 5,
};

//=======================================================================================
//=======================================================================================
CLRPUBLIC struct ElementCopyContext
{
private:
    struct  ECImpl;

    ECImpl* m_pimpl;

public:
    struct  IEventHandler;

//=======================================================================================
//=======================================================================================
enum class SharedCellNameConflicts
{
    Undefined    = -1,
    None         = 0,
    HasDefId     = 1,
    All          = 2,
};

//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

DGNPLATFORM_EXPORT ~ElementCopyContext ();

DGNPLATFORM_EXPORT ElementCopyContext (ElementCopyContext const&);

DGNPLATFORM_EXPORT ElementCopyContext& operator= (ElementCopyContext const&);

DGNPLATFORM_EXPORT explicit ElementCopyContext (DgnModelRefP dest);

//---------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

DGNPLATFORM_EXPORT StatusInt DoCopy (EditElementHandleR eh);

//---------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

DGNPLATFORM_EXPORT void SetDestinationModelRef (DgnModelRefP);

DGNPLATFORM_EXPORT DgnModelP GetDestinationModel ();

DGNPLATFORM_EXPORT DgnModelRefP GetDestinationModelRef ();

DGNPLATFORM_EXPORT void SetSourceModelRef (DgnModelRefP);

DGNPLATFORM_EXPORT DgnModelRefP GetSourceModelRef (ElementHandleCP el = NULL);

DGNPLATFORM_EXPORT DgnModelP GetSourceCache (ElementHandleCP el = NULL);

DGNPLATFORM_EXPORT bool IsCopyFromReference ();

DGNPLATFORM_EXPORT bool IsSameCache (ElementHandleCP eh = NULL);

DGNPLATFORM_EXPORT bool IsSameFile (ElementHandleCP eh = NULL);

DGNPLATFORM_EXPORT void GetModels (DgnModelRefP *srcModelRefP, DgnModelRefP *destModelP, bool *sameCacheP, bool *sameFileP, ElementHandleCP elemHandle = NULL);

DGNPLATFORM_EXPORT void SetModelFromElmdscr (bool useElmdscr);

DGNPLATFORM_EXPORT bool GetModelFromElmdscr () const;

//---------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

//=======================================================================================
struct  IEventHandler : IRefCounted
{
virtual void OnElementCopied (EditElementHandleR eh, ElementCopyContext&, bool isPre) = 0;
virtual void OnLevelCloned (ULong destLevelId, ULong sourceLevelId, bool uniqueName, ElementCopyContext& cc) = 0;
virtual void OnProcessDatabaseLinkages (EditElementHandleR eh, ElementCopyContext&) {}

}; // IEventHandler

DGNPLATFORM_EXPORT static void AddHandler (IEventHandler& handler);

DGNPLATFORM_EXPORT static void DropHandler (IEventHandler& handler);

//---------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

//---------------------------------------------------------------------------------------

DGNPLATFORM_EXPORT void SetWriteElements (bool writeAllElements);

DGNPLATFORM_EXPORT bool GetWriteElements () const;

DGNPLATFORM_EXPORT void SetMatchDimToDestination (bool changeDimension);

DGNPLATFORM_EXPORT bool GetMatchDimToDestination () const;

DGNPLATFORM_EXPORT void SetScaleReferenceDimensions (bool);

DGNPLATFORM_EXPORT bool GetScaleReferenceDimensions () const;

DGNPLATFORM_EXPORT void SetTransformToDestination (bool transformToDestination);

DGNPLATFORM_EXPORT bool GetTransformToDestination () const;

DGNPLATFORM_EXPORT void SetAssignNewGGs (bool assignNewGGs);

DGNPLATFORM_EXPORT bool GetAssignNewGGs () const;

DGNPLATFORM_EXPORT void SetAssignNewNodes (bool assignNewNodes);

DGNPLATFORM_EXPORT bool GetAssignNewNodes () const;

DGNPLATFORM_EXPORT void SetViewport (ViewportP vp);

DGNPLATFORM_EXPORT ViewportP GetViewport () const;

DGNPLATFORM_EXPORT void SetLevelHandling (CopyContextLevelOption levelOption);

DGNPLATFORM_EXPORT void SetKeepRefColorIndexOnCopy (bool);

DGNPLATFORM_EXPORT bool GetKeepRefColorIndexOnCopy ();

DGNPLATFORM_EXPORT void SetSharedCellNameConflicts (SharedCellNameConflicts);

DGNPLATFORM_EXPORT SharedCellNameConflicts GetSharedCellNameConflicts () const;

DGNPLATFORM_EXPORT void SetDontPlaceTagsInGG (bool);

DGNPLATFORM_EXPORT bool GetDontPlaceTagsInGG () const;

DGNPLATFORM_EXPORT void SetDisableAnnotationScaling (bool b);

DGNPLATFORM_EXPORT bool GetDisableAnnotationScaling () const;

//---------------------------------------------------------------------------------------
//---------------------------------------------------------------------------------------


}; // ElementCopyContext
END_BENTLEY_DGNPLATFORM_NAMESPACE