DgnPlatform/ViewGroup.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"
#include    <Bentley/WString.h>
#include    "ViewInfo.h"
#include    <Bentley/bvector.h>

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

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

typedef RefCountedPtr<ViewGroup>                 ViewGroupPtr;


typedef RefCountedPtr<ViewGroupCopyOptions>      ViewGroupCopyOptionsPtr;


enum ViewGroupStatus
{
    VG_Success                  = 0,                            
    VG_NameTooShort             = VIEW_GROUP_ERROR_BASE + 1,    
    VG_NameTooLong              = VIEW_GROUP_ERROR_BASE + 2,    
    VG_NameNotUnique            = VIEW_GROUP_ERROR_BASE + 3,    
    VG_NameIllegalCharacter     = VIEW_GROUP_ERROR_BASE + 4,    
    VG_OwningDgnFileUnknown     = VIEW_GROUP_ERROR_BASE + 5,    
    VG_WrongFile                = VIEW_GROUP_ERROR_BASE + 6,    
    VG_CantCreateElement        = VIEW_GROUP_ERROR_BASE + 7,    
    VG_CantWriteToFile          = VIEW_GROUP_ERROR_BASE + 8,    
    VG_TransientNotSaved        = VIEW_GROUP_ERROR_BASE + 9,    
    VG_CantDeleteFromFile       = VIEW_GROUP_ERROR_BASE + 10,   
    VG_NotInCollection          = VIEW_GROUP_ERROR_BASE + 11,   
    VG_ActivateRejected         = VIEW_GROUP_ERROR_BASE + 12,   
    VG_NoReplacementActiveFound = VIEW_GROUP_ERROR_BASE + 13,   
    VG_CantSetElementId         = VIEW_GROUP_ERROR_BASE + 14,   
    VG_BadArgument              = VIEW_GROUP_ERROR_BASE + 15,   
    VG_ViewGroupNotFound        = VIEW_GROUP_ERROR_BASE + 16,   
    VG_OpenViewNotFound         = VIEW_GROUP_ERROR_BASE + 17,   
};


enum class ViewGroupCopyTypeOption
{
    SourceType           = -1,   
    MakeTransient        = 0,    
    MakePermanent        = 1,    
};

//=======================================================================================
//=======================================================================================
struct ViewGroupCollection : NonCopyableClass
{
friend struct  DgnFile;
friend struct  ViewGroup;
friend struct  DgnDbG05FileIO;
friend struct  DgnDbG06FileIO;
friend struct  IModel02FileIO;

private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    typedef bvector <ViewGroupPtr>::const_iterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT const_iterator begin () const;

    DGNPLATFORM_EXPORT const_iterator end () const;

    DGNPLATFORM_EXPORT ViewGroupPtr FindByName (WCharCP name) const;

    DGNPLATFORM_EXPORT ViewGroupPtr FindByElementId (ElementId elementID) const;

    DGNPLATFORM_EXPORT ViewGroupPtr FindByModelId (ModelId modelID, bool allViewsMatch, int thisViewMatches) const;

    

    DGNPLATFORM_EXPORT ViewGroupStatus SaveChanges () const;

    DGNPLATFORM_EXPORT bool NameUnused (WCharCP name) const;

    DGNPLATFORM_EXPORT UInt32 Size () const;

    DGNPLATFORM_EXPORT ViewGroupStatus Add (ViewGroupP viewGroup);

    DGNPLATFORM_EXPORT ViewGroupStatus Delete (ViewGroupP viewGroup);

    DGNPLATFORM_EXPORT ViewGroupPtr FindLastModifiedMatchingModel (ElementId preferredElementID, ModelId modelID, bool allViewsMatch, int thisViewMatches) const;

    DGNPLATFORM_EXPORT ViewGroupCP GetActiveCP () const;

    DGNPLATFORM_EXPORT ViewGroupP GetActiveP () const;

    DGNPLATFORM_EXPORT ViewGroupStatus MakeActive (ViewGroupP newActive, bool deferInitialUpdate);

    DGNPLATFORM_EXPORT ViewInfoCP GetActiveViewInfoCP (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT ViewInfoP GetActiveViewInfoP (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT ViewPortInfoP GetActiveViewPortInfoP (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT ViewPortInfoCP GetActiveViewPortInfoCP (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT DgnFileP GetDgnFileP () const;

    DGNPLATFORM_EXPORT ViewGroupStatus GetUniqueNameFromBase (WStringR uniqueName, WCharCP baseName, DgnModelP model, bool transient) const;


};

//=======================================================================================
//=======================================================================================
struct ViewGroupCopyOptions : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT static   ViewGroupCopyOptionsPtr CreateOptions();

    DGNPLATFORM_EXPORT static   ViewGroupCopyOptionsPtr Duplicate(ViewGroupCopyOptionsCR seedOptions);

    DGNPLATFORM_EXPORT void     SetCopyType (ViewGroupCopyTypeOption);   
    DGNPLATFORM_EXPORT void     SetCopyViewClip ();             
    DGNPLATFORM_EXPORT void     SetCopyViewLevels ();           
    DGNPLATFORM_EXPORT void     SetCopyViewACS ();              
    DGNPLATFORM_EXPORT void     SetDoNotAddToCollection ();     
    DGNPLATFORM_EXPORT void     SetNewName (WCharCP);           
    DGNPLATFORM_EXPORT void     SetNewDescription (WCharCP);    


};

//=======================================================================================
//=======================================================================================
struct ViewGroup : public RefCountedBase, NonCopyableClass
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public:
    DGNPLATFORM_EXPORT WStringCR GetName () const;

    DGNPLATFORM_EXPORT WStringCR GetDescription () const;

    DGNPLATFORM_EXPORT UInt32 GetUIDisplayOrder () const;

    DGNPLATFORM_EXPORT ElementId GetElementId () const;

    DGNPLATFORM_EXPORT ElementRefP GetElementRef () const;

    DGNPLATFORM_EXPORT DgnFileP GetDgnFileP () const;

    DGNPLATFORM_EXPORT ViewGroupStatus SetName (WCharCP name);

    DGNPLATFORM_EXPORT void SetDescription (WCharCP description);

    DGNPLATFORM_EXPORT void SetUIDisplayOrder (UInt32 value);

    DGNPLATFORM_EXPORT bool IsTransient () const;

    DGNPLATFORM_EXPORT void SetTransient (bool transient);

    DGNPLATFORM_EXPORT ViewInfoR GetViewInfoR (UInt32 viewNumber);

    DGNPLATFORM_EXPORT ViewInfoCR GetViewInfo (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT ViewPortInfoR GetViewPortInfoR (UInt32 viewNumber);

    DGNPLATFORM_EXPORT ViewPortInfoCR GetViewPortInfo (UInt32 viewNumber) const;

    DGNPLATFORM_EXPORT void SetViewInfo (ViewInfoR viewInfo, UInt32 viewNumber);

    DGNPLATFORM_EXPORT void SetViewPortInfo (ViewPortInfoR viewPortInfo, UInt32 viewNumber);

    DGNPLATFORM_EXPORT bool MatchesModel (ModelId modelID, bool allViewsMatch, int thisViewMatches);

    DGNPLATFORM_EXPORT void SynchViewDisplay (UInt32 viewNumber, bool levelsChanged, bool undoable, bool synchViewTitle) const;


    DGNPLATFORM_EXPORT void EnsureLevelMaskCoverage (DgnModelRefP modelRef, bool fromExchange);

    DGNPLATFORM_EXPORT void ResetEffectiveLevelMasks ();

    DGNPLATFORM_EXPORT void ResetEffectiveLevelMasksForModel (DgnModelRefP modelRef, bool includeChildModelRefs);

    DGNPLATFORM_EXPORT void ResetEffectiveLevelMasksForChildren (DgnModelRefP modelRef);


    DGNPLATFORM_EXPORT ViewGroupStatus SaveChanges () const;


    DGNPLATFORM_EXPORT ViewGroupStatus WriteImmediatelyToFile () const;

    DGNPLATFORM_EXPORT DgnModelP GetFirstRootModelP () const;

    DGNPLATFORM_EXPORT void GetZOrder (byte* zOrder, size_t numEntries) const;

    DGNPLATFORM_EXPORT void SetZOrder (byte* zOrder, size_t numEntries);


    DGNPLATFORM_EXPORT bool AllViewsOneModel (ModelId& onlyModel) const;

    DGNPLATFORM_EXPORT LevelId GetActiveLevel () const;

    DGNPLATFORM_EXPORT void SetActiveLevel (LevelId activeLevel);

    DGNPLATFORM_EXPORT UInt32 GetActiveColor () const;

    DGNPLATFORM_EXPORT void SetActiveColor (UInt32 activeColor);

    DGNPLATFORM_EXPORT  UInt32                  GetActiveWeight () const;
    DGNPLATFORM_EXPORT void SetActiveWeight (UInt32 activeWeight);

    DGNPLATFORM_EXPORT Int32 GetActiveStyle () const;

    DGNPLATFORM_EXPORT void SetActiveStyle (Int32 activeStyle);

    DGNPLATFORM_EXPORT ViewGroupStatus From (ViewGroupCR source, ViewGroupCopyOptions const& copyOptions);

    DGNPLATFORM_EXPORT static ViewGroupStatus Create (ViewGroupPtr& createdViewGroup, DgnModelR rootModel, bool transient, WCharCP name, bool addToCollection);

    DGNPLATFORM_EXPORT static ViewGroupStatus Create (ViewGroupPtr& createdViewGroup, ModelId rootModelId, DgnFileR dgnFile, bool transient, WCharCP name, bool addToCollection);

    DGNPLATFORM_EXPORT static ViewGroupStatus Copy (ViewGroupPtr& copiedViewGroup, DgnModelR rootModel, DgnModelRefR sourceModel, ViewGroupCopyOptions const& copyOptions);

    DGNPLATFORM_EXPORT static ViewGroupStatus Copy (ViewGroupPtr& copiedViewGroup, DgnModelR rootModel, ViewGroupCR source, ViewGroupCopyOptions const& copyOptions);
   
    DGNPLATFORM_EXPORT static ViewGroupStatus FindActiveViewGroup (ViewGroupPtr& activeViewGroup, DgnFileR dgnFile);

    DGNPLATFORM_EXPORT ViewGroupStatus FindFirstOpenView (int& viewNumber);

};
END_BENTLEY_DGNPLATFORM_NAMESPACE