AreaPattern.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

#define  PATTERN_ID                 32040       // Pattern linkage ID 
#define  PATTERN_CONTROL            "Pattern Control Element"

#define  MAX_DWG_HATCH_LINES            50
#define  MAX_DWG_EXPANDEDHATCH_LINES    400
#define  MAX_DWG_HATCH_LINE_DASHES      20

#if !defined(__midl) // For a MIDL compile, all we care about are the values of the #define constants.

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
struct DwgHatchDefLine
{
double          angle;
DPoint2d        through;
DPoint2d        offset;
short           nDashes;
double          dashes[MAX_DWG_HATCH_LINE_DASHES];
};

struct DwgHatchDef
{
short           nDefLines;
double          pixelSize;
short           islandStyle;
};

enum PatternParamsCompareFlags
    {
    PATTERNPARAMSCOMPAREFLAGS_RMatrix           = 0x0001,
    PATTERNPARAMSCOMPAREFLAGS_Offset            = 0x0002,
    PATTERNPARAMSCOMPAREFLAGS_Default           = 0x0004,
    PATTERNPARAMSCOMPAREFLAGS_Origin            = 0x0010,
    PATTERNPARAMSCOMPAREFLAGS_Symbology         = 0x0020,
    PATTERNPARAMSCOMPAREFLAGS_Mline             = 0x0040,
    PATTERNPARAMSCOMPAREFLAGS_Tolerance         = 0x0080,
    PATTERNPARAMSCOMPAREFLAGS_HoleStyle         = 0x0100,
    PATTERNPARAMSCOMPAREFLAGS_DwgHatch          = 0x0200,
    PATTERNPARAMSCOMPAREFLAGS_AnnotationScale   = 0x0400,
    PATTERNPARAMSCOMPAREFLAGS_All               = 0xffff,
    };

enum class PatternParamsHoleStyleType
{
    Normal        = 0,        
    Parity        = 1,        
};

enum class PatternParamsModifierFlags
{
    None                     = 0,        
    Space1                   = 0x0001,   
    Angle1                   = 0x0002,   
    Space2                   = 0x0004,   
    Angle2                   = 0x0008,   
    Scale                    = 0x0010,   
    Cell                     = 0x0020,   
    Tolerance                = 0x0040,   
    Style                    = 0x0080,   
    Weight                   = 0x0100,   
    Color                    = 0x0200,   
    Snap                     = 0x0400,   
    RotMatrix                = 0x0800,   
    Offset                   = 0x1000,   
    HoleStyle                = 0x2000,   
    DwgHatchDef              = 0x4000,   
    Multiline                = 0x8000,   
    Origin                   = 0x10000,  
    PixelSize                = 0x20000,  
    IslandStyle              = 0x40000,  
    TrueScale                = 0x80000,  
    RawDwgLoops              = 0x100000, 
    DwgHatchOrigin           = 0x200000, 
    AnnotationScale          = 0x400000, 
};

ENUM_IS_FLAGS(PatternParamsModifierFlags)


enum PatternPlacementTypes
{
    PATTERN_HATCH                   = 0x0,
    PATTERN_CROSSHATCH              = 0x1,
    PATTERN_AREA                    = 0x2,
};


// For in-memory use only! 
struct PatternParams : RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT static PatternParamsPtr Create ();

DGNPLATFORM_EXPORT static PatternParamsPtr CreateFromExisting (PatternParamsCR existing);

DGNPLATFORM_EXPORT void Copy (PatternParamsCR existing);

DGNPLATFORM_EXPORT bool IsEqual (PatternParamsCR params, PatternParamsCompareFlags compareFlags=PATTERNPARAMSCOMPAREFLAGS_Default);

DGNPLATFORM_EXPORT PatternParamsModifierFlags GetModifiers () const;

DGNPLATFORM_EXPORT RotMatrixCR GetOrientation () const;

DGNPLATFORM_EXPORT DPoint3dCR GetOffset () const;

DGNPLATFORM_EXPORT double GetPrimarySpacing () const;

DGNPLATFORM_EXPORT double GetPrimaryAngle () const;

DGNPLATFORM_EXPORT double GetSecondarySpacing () const;

DGNPLATFORM_EXPORT double GetSecondaryAngle () const;

DGNPLATFORM_EXPORT double GetScale () const;

DGNPLATFORM_EXPORT double GetTolerance () const;

DGNPLATFORM_EXPORT WCharCP GetCellName () const;

DGNPLATFORM_EXPORT ElementId GetCellId () const;

DGNPLATFORM_EXPORT Int32 GetMinLine () const;

DGNPLATFORM_EXPORT Int32 GetMaxLine () const;

DGNPLATFORM_EXPORT UInt32 GetColor () const;

DGNPLATFORM_EXPORT UInt32 GetWeight () const;

DGNPLATFORM_EXPORT Int32 GetStyle () const;

DGNPLATFORM_EXPORT PatternParamsHoleStyleType GetHoleStyle () const;

DGNPLATFORM_EXPORT DwgHatchDefCR GetDwgHatchDef () const;

DGNPLATFORM_EXPORT DPoint3dCR GetOrigin () const;

DGNPLATFORM_EXPORT double GetAnnotationScale () const;

DGNPLATFORM_EXPORT void SetModifiers (PatternParamsModifierFlags);

DGNPLATFORM_EXPORT void SetOrientation (RotMatrixCR);

DGNPLATFORM_EXPORT void SetOffset (DPoint3dCR);

DGNPLATFORM_EXPORT void SetPrimarySpacing (double);

DGNPLATFORM_EXPORT void SetPrimaryAngle (double);

DGNPLATFORM_EXPORT void SetSecondarySpacing (double);

DGNPLATFORM_EXPORT void SetSecondaryAngle (double);

DGNPLATFORM_EXPORT void SetScale (double);

DGNPLATFORM_EXPORT void SetTolerance (double);

DGNPLATFORM_EXPORT void SetCellName (WCharCP);

DGNPLATFORM_EXPORT void SetCellId (ElementId);

DGNPLATFORM_EXPORT void SetMinLine (Int32);

DGNPLATFORM_EXPORT void SetMaxLine (Int32);

DGNPLATFORM_EXPORT void SetColor (UInt32);

DGNPLATFORM_EXPORT void SetWeight (UInt32);

DGNPLATFORM_EXPORT void SetStyle (Int32);

DGNPLATFORM_EXPORT void SetHoleStyle (PatternParamsHoleStyleType);

DGNPLATFORM_EXPORT void SetDwgHatchDef (DwgHatchDefCR);

DGNPLATFORM_EXPORT void SetOrigin (DPoint3dCR);

DGNPLATFORM_EXPORT void SetAnnotationScale (double);

}; // PatternParams

#endif // !defined(__midl)

END_BENTLEY_DGNPLATFORM_NAMESPACE