DgnPlatform/LineStyle.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 "IViewDraw.h"  // For LineStyleParams
#include "DgnHost.h"
typedef UInt32 RscFileHandle;


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


typedef RefCountedPtr <LsMap> LsMapPtr;

typedef RefCountedPtr <LsSystemMap>LsSystemMapPtr;

typedef RefCountedPtr <LsResourceFileMap> LsResourceFileMapPtr;

typedef RefCountedPtr <LsDgnFileMap> LsDgnFileMapPtr;

typedef RefCountedPtr <LineStyleHandle> LineStyleHandlePtr;
typedef RefCountedPtr <LsComponent> LsComponentPtr;
typedef RefCountedPtr <LsCompoundComponent> LsCompoundComponentPtr;
typedef RefCountedPtr <LsPointSymbolComponent> LsPointSymbolComponentPtr;
typedef RefCountedPtr <LsLineCodeComponent> LsLineCodeComponentPtr;
typedef RefCountedPtr <LsInternalComponent> LsInternalComponentPtr;
typedef RefCountedPtr <LsLinePointComponent> LsLinePointComponentPtr;
typedef RefCountedPtr <LsPointSymbolInfo> LsPointSymbolInfoPtr;
typedef RefCountedPtr <LsStrokeData> LsStrokeDataPtr;
typedef RefCountedPtr <LsCompoundInfo> LsCompoundInfoPtr;
typedef RefCountedPtr <LsRasterImageComponent> LsRasterImageComponentPtr;




typedef bvector <LsComponentPtr> LsComponentVector;


/*----------------------------------------------------------------------+
|                                                                       |
|   LineStyleNameInfo                                                   |
|                                                                       |
|   Information returned from the mdlLineStyle_nameQuery function       |
|                                                                       |
+----------------------------------------------------------------------*/
struct LineStyleNameInfo
{
    UInt32          rscFile;    // Resource file handle
    UInt32          rscType;    // Resource type
    ElementId       rscID;      // Resource ID
    UInt32          attributes; // Name Attributes
    long            styleID;    // Style ID for MASTERFILE
};



enum LsKnownStyleNumber
{
    STYLE_MinLineCode = 0,
    STYLE_MaxLineCode = 7,
    STYLE_ByLevel     = 0x7fffffff,
    STYLE_ByCell      = 0x7ffffffe,
    STYLE_Invalid     = 0x7fffff00
};


enum class LsElementType
{
    Unknown         = 0,             
    PointSymbol     = 1,
    Compound        = 2,
    LineCode        = 3,
    LinePoint       = 4,
    Internal        = 6,
    RasterImage     = 7,
};


enum class LsLocationType
{
    Unknown       = 0,                 
    ResourceFile  = 1,
    DgnFile       = 2,
    System        = 3,
    LinFile       = 4,
    Importer      = 5,
};


enum class LsResourceType
{
    Unknown               = 1,       
    Internal              = 0,
    Compound              = 'lsLS',  
    LineCode              = 'lsLC',  
    LinePoint             = 'lsLP',  
    PointSymbol           = 'l8PS',  
    PointSymbolV7         = 'lsPS',  
    RasterImage           = 'lsRI',  
    NameEntry             = 'lsNm',  
};

enum class LsCapMode
{
    LCCAP_Closed            = 0,
    LCCAP_Open              = 1,
    LCCAP_Extended          = 2,
    LCCAP_Hexagon           = 3,
    LCCAP_Octagon           = 4,
    LCCAP_Decagon           = 5,
    LCCAP_Arc               = 30,
};

enum class LsUnit
{
    Master      = 0,        
    Uor         = 1,        
    Device      = 2         
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
CLRPUBLIC struct          LsEntry
    {
public:    
    DGNPLATFORM_EXPORT WString                  GetStyleName    ()    const;
    DGNPLATFORM_EXPORT Int32                    GetStyleNumber  ()    const;

    DGNPLATFORM_EXPORT LsLocationType           GetDefinitionLocation  ()    const;

    DGNPLATFORM_EXPORT WString                  GetSourceFileName  ()    const;

};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
struct          LsMapEntry
{
private:
    LsMapEntry ();

public:
    DGNPLATFORM_EXPORT WString                  GetStyleName    ()    const;
    DGNPLATFORM_EXPORT Int32                    GetStyleNumber  ()    const;
    DGNPLATFORM_EXPORT LsEntryCP                GetLineStyleEntry () const;

};

//=======================================================================================
struct          LsMapIterator : std::iterator<std::forward_iterator_tag, const LsMapEntry>
    {
private:
    friend struct LsMap;
    LsMapIterator (LsMapCP map, bool wantBegin);    // ctors are private. Therefore, callers cannot construct an instance. Since we don't define a private copy constructor, callers can make copies. That should be safe, since we don't define a destructor.
    LsMapIterator () {}
private:
    int                 m_index;
    void const*         m_node;
    intptr_t            m_auxData;

public:
    DGNPLATFORM_EXPORT LsMapIteratorR  operator++();                                    
    DGNPLATFORM_EXPORT LsMapEntryCR    operator*() const;                               
                   LsMapEntryCP    operator->() const {return &operator*();}        
    DGNPLATFORM_EXPORT bool            operator==(LsMapIteratorCR rhs) const;           
    DGNPLATFORM_EXPORT bool            operator!=(LsMapIteratorCR rhs) const;           
    };

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
CLRPUBLIC struct          LsMap : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    DGNPLATFORM_EXPORT LsLocationType           GetType                 () const;    
    DGNPLATFORM_EXPORT WString                  GetFileName             () const;    

    DGNPLATFORM_EXPORT LsEntryCP                GetLineStyleEntry   (WCharCP lsName) const;
    DGNPLATFORM_EXPORT LsEntryCP                GetLineStyleEntry   (Int32 styleId) const;

    typedef LsMapIterator const_iterator;
    typedef const_iterator iterator;    

    DGNPLATFORM_EXPORT LsMapIterator            begin () const;
    DGNPLATFORM_EXPORT LsMapIterator            end   () const;
    };

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
struct          LsResourceFileMap : public LsMap
    {

    DGNPLATFORM_EXPORT static LsResourceFileMapPtr  OpenFile                        (LineStyleStatus& status, WCharCP fileName, bool readonly);
    DGNPLATFORM_EXPORT static LineStyleStatus       CreateNewFile                   (WCharCP fileName);

    DGNPLATFORM_EXPORT RscFileHandle                GetRscHandle() const;
    };

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
struct          LsSystemMap : public LsMap, DgnHost::HostObjectBase
{
public:
    DGNPLATFORM_EXPORT static LsSystemMapR      GetSystemMapR           ();
    DGNPLATFORM_EXPORT static LsSystemMapCR     GetSystemMap            ();
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
struct          LsDgnFileMap : public LsMap
{
public:
    DGNPLATFORM_EXPORT DgnFileR         GetDgnFileR     () const;
    DGNPLATFORM_EXPORT DgnFileCR        GetDgnFile      () const;

};
END_BENTLEY_DGNPLATFORM_NAMESPACE