IRasterAttachment.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/Handler.h> 
#include <DgnPlatform/DgnPlatform.h>
#include <DgnPlatform/image.h>
#include <DgnPlatform/DgnFileIO/DgnElements.h>
#include <DgnPlatform/DgnFileIO/UnitDefinition.h>
#include <DgnPlatform/ElementHandle.h>
#include <DgnPlatform/IRasterElementDependency.h>
#include <Bentley/RefCounted.h>

DGNPLATFORM_TYPEDEFS (RasterClip)
DGNPLATFORM_TYPEDEFS (RasterClipCollection)
DGNPLATFORM_TYPEDEFS (RasterClipProperties)
DGNPLATFORM_TYPEDEFS (RasterMaskReference)
DGNPLATFORM_TYPEDEFS (RasterMaskReferenceCollection)
DGNPLATFORM_TYPEDEFS (RasterLayerDisplayOverride)
DGNPLATFORM_TYPEDEFS (RasterLayerDisplayOvrCollection)
DGNPLATFORM_TYPEDEFS (RasterTransparentColorsCollection)



BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE


typedef RefCountedPtr<RasterClip>                       RasterClipPtr;
typedef RefCountedPtr<RasterClipCollection>             RasterClipCollectionPtr;
typedef RefCountedPtr<RasterClipProperties>             RasterClipPropertiesPtr;
typedef RefCountedPtr<RasterMaskReference>              RasterMaskReferencePtr;
typedef RefCountedPtr<RasterLayerDisplayOverride>       RasterLayerDisplayOvrPtr;
typedef RefCountedPtr<RasterTransparentColorsCollection> RasterTransparentColorsCollectionPtr;


 enum RasterDisplayPriorityPlane
    {
    DisplayPriority_BackPlane      = 1, 
    DisplayPriority_DesignPlane    = 2, 
    DisplayPriority_FrontPlane     = 3  
    };

 enum GeoreferencePriority
    {
    GeoreferencePriority_Default           = 0, 
    GeoreferencePriority_Attachment        = 1, 
    GeoreferencePriority_RasterFile        = 2, 
    GeoreferencePriority_SisterFile        = 3  
    };

 enum GeotiffUnitPriority
    {
    GeotiffUnitPriority_PCS_Default  =0, 
    GeotiffUnitPriority_PCS_Linear   =1, 
    GeotiffUnitPriority_Unknown      =2  
    };

   
 enum TransparentColorType
    {
    TransparentColorType_Colordef = 1, 
    TransparentColorType_CubeDef  = 2  
    };

 enum GeoCodingType
    {
    GeoCodingType_None      = 0,      
    GeoCodingType_Type66    = 1       
    };


/*=================================================================================**/
struct RasterClip : public RefCountedBase
    {

public:
    DGNPLATFORM_EXPORT static  RasterClipPtr Create ();

    DGNPLATFORM_EXPORT static  RasterClipPtr Create (ElementHandleCR clipEh);

    DGNPLATFORM_EXPORT static  RasterClipPtr Create (DPoint3dCP points, size_t numVerts, DgnModelRefR modelRef);

    DGNPLATFORM_EXPORT RasterClipPtr Clone() const;

    DGNPLATFORM_EXPORT ElementHandleCR GetClipElement() const;

    DGNPLATFORM_EXPORT void SetClipElement(ElementHandleCR clipEh);

    DGNPLATFORM_EXPORT bool IsValid() const;

    DGNPLATFORM_EXPORT void Invalidate();

    DGNPLATFORM_EXPORT bvector<DPoint3d> const& ComputeStrokePoints(bvector<DPoint3d>& strokePts) const; 

    DGNPLATFORM_EXPORT bool IsEqual (RasterClipCR clip) const;

    };

typedef bvector<RasterClipPtr> RasterClipVector;
/*=================================================================================**/
struct  RasterClipCollection : public RefCountedBase, public RasterClipVector
{
public:

    DGNPLATFORM_EXPORT static  RasterClipCollectionPtr Create ();
}; 

/*=================================================================================**/
struct RasterClipProperties : public RefCountedBase
    {
public:

    DGNPLATFORM_EXPORT static  RasterClipPropertiesPtr Create ();

    DGNPLATFORM_EXPORT RasterClipPropertiesPtr    Clone() const;

    DGNPLATFORM_EXPORT bool         HasBoundary() const;
        
    DGNPLATFORM_EXPORT RasterClipCR GetBoundary() const;

    DGNPLATFORM_EXPORT RasterClipR  GetBoundaryR();

    DGNPLATFORM_EXPORT void         SetBoundary(RasterClipPtr& boundaryP);

    DGNPLATFORM_EXPORT RasterClipCollectionCR   GetMaskCollection() const;

    DGNPLATFORM_EXPORT RasterClipCollectionR    GetMaskCollectionR();

    DGNPLATFORM_EXPORT void                     SetMaskCollection(RasterClipCollectionPtr& clipMasksP);

    };


/*=================================================================================**/
CLRPUBLIC struct  RasterTransparentColorsCollection : public RefCountedBase
    {
    public:
        typedef _RasterTransparentColorDef  RasterTransparentColorDef;
        typedef _RGBTransparentColorDef     RasterRGBTransparentColorDef;

        typedef union transparentColors
            {
            RasterTransparentColorDef        index[MAX_CONTTONE_TRANSPARENTCOLOR];
            RasterRGBTransparentColorDef     rgb[MAX_RGB_TRANSPARENTCOLOR];
            } RasterTransparentColorsUnion;

    public:

        DGNPLATFORM_EXPORT static RasterTransparentColorsCollectionPtr Create();

        DGNPLATFORM_EXPORT static RasterTransparentColorsCollectionPtr Create(TransparentColorType colorType,long count,RasterTransparentColorsUnion const & transparentColor);

        DGNPLATFORM_EXPORT RasterTransparentColorsCollectionPtr Clone();

        DGNPLATFORM_EXPORT void                    Init(TransparentColorType colorType);

        DGNPLATFORM_EXPORT void                    Init(TransparentColorType colorType,long count,RasterTransparentColorsUnion const & transparentColor);

        DGNPLATFORM_EXPORT TransparentColorType    GetColorType() const;

        DGNPLATFORM_EXPORT void                    SetColorType(TransparentColorType colorType);


        DGNPLATFORM_EXPORT long                    GetCount() const;

        DGNPLATFORM_EXPORT void                    SetCount(long count);

        DGNPLATFORM_EXPORT size_t                            GetMaxRgbTransparentColor() const;

        DGNPLATFORM_EXPORT RasterRGBTransparentColorDef const& GetRgbTransparentColor(unsigned long index) const;

        DGNPLATFORM_EXPORT void                              SetRgbTransparentColor(unsigned long index,RasterRGBTransparentColorDef& value);

        DGNPLATFORM_EXPORT void                              AddRgbTransparentColor(const RgbColorDef & colorMin, const RgbColorDef & colorMax,UInt8 transparency);    

        DGNPLATFORM_EXPORT size_t                            GetMaxTransparentColor() const;

        DGNPLATFORM_EXPORT RasterTransparentColorDef const& GetTransparentColor(unsigned long index) const;

        DGNPLATFORM_EXPORT void                              SetTransparentColor(unsigned long index,RasterTransparentColorDef& value);

        DGNPLATFORM_EXPORT void                              AddTransparentColor(UInt8 index,UInt8 transparency);

        DGNPLATFORM_EXPORT RasterTransparentColorsUnion const&    GetTransparentColor() const;

        DGNPLATFORM_EXPORT bool           IsEqual(RasterTransparentColorsCollectionCR transColors) const;
    }; 


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

    DGNPLATFORM_EXPORT static bool IsValidTransform(TransformCR matrix);

    DGNPLATFORM_EXPORT static bool IsTransform3D (TransformCR matrix);

    DGNPLATFORM_EXPORT static StatusInt ColorIndexFromRgbInModel (UInt32& index, DgnModelRefR modelRef, RgbColorDef const& rgbColor);

    DGNPLATFORM_EXPORT static StatusInt RgbFromColorIndexInModel (RgbColorDef& color, DgnModelRefR modelRef, UInt32 rawIndex);

    DGNPLATFORM_EXPORT static WString GetSearchPath (DgnModelRefP modelRef);
    
    DGNPLATFORM_EXPORT DgnDocumentMonikerPtr GetAttachMoniker (ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT WString GetAttachDescription(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT WString GetLogicalName(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetSnappableState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetLockedState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetViewIndependentState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetOpenReadWrite(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT GeoreferencePriority GetGeoreferencePriority(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetGCSInheritedFromModelState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT BentleyStatus GetTransform(ElementHandleCR eh, TransformR matrix) const;

    DGNPLATFORM_EXPORT UInt32 GetPageNumber(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT ImageColorMode GetColorMode(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT DPoint2d GetExtent(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT DPoint2d GetScanningResolution(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetViewState(ElementHandleCR eh,int viewNumber) const;

    DGNPLATFORM_EXPORT bool GetInvertState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetPrintState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetClipState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetTransparencyState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetBinaryPrintInvertState(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT RasterDisplayPriorityPlane GetDisplayPriorityPlane(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT long GetLayer(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT double GetViewGamma(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT double GetPrintGamma(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT UInt32 GetTintColor(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT UInt32 GetForegroundColor(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT UInt32 GetBackgroundColor(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT char GetContrast(ElementHandleCR eh) const; // CHAR_OK

    DGNPLATFORM_EXPORT char GetBrightness(ElementHandleCR eh) const; // CHAR_OK

    DGNPLATFORM_EXPORT UInt8 GetImageTransparencyLevel(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT RasterTransparentColorsCollectionPtr GetTransparentColors(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT UnitDefinitionCR GetGeotiffUnit(ElementHandleCR eh, UnitDefinitionR GeotiffUnit) const;

    DGNPLATFORM_EXPORT double GetGeotiffDefaultUnitFactor(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT bool GetGeotiffUnitUseUOR(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT GeotiffUnitPriority GetGeotiffUnitPriority(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT UnitDefinitionCR  GetWorldFileUnit(ElementHandleCR eh, UnitDefinitionR WorldFileUnit) const;

    DGNPLATFORM_EXPORT double GetWorldFileDefaultUnitFactor(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT ElementHandle GetGeocoding(ElementHandleCR eh) const;

    DGNPLATFORM_EXPORT RasterClipPropertiesPtr GetClipProperties(ElementHandleCR eh) const;

}; //IRasterAttachmentQuery

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

    DGNPLATFORM_EXPORT static BentleyStatus CreateRasterAttachment (EditElementHandleR eeh, ElementHandleCP templateEh, DgnDocumentMonikerCR moniker, 
                                                                    TransformCR matrix, DPoint2dCR extentInUOR, DgnModelRefR modelRef);

    DGNPLATFORM_EXPORT bool SetAttachMoniker (EditElementHandleR eeh, DgnDocumentMonikerCR moniker);

    DGNPLATFORM_EXPORT static bool SetAttachMoniker0 (EditElementHandleR eeh, DgnDocumentMonikerCR moniker);

    DGNPLATFORM_EXPORT bool SetAttachDescription(EditElementHandleR eeh,WCharCP description);

    DGNPLATFORM_EXPORT bool SetLogicalName(EditElementHandleR eeh,WCharCP logicalName);

    DGNPLATFORM_EXPORT bool SetSnappableState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetLockedState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetViewIndependentState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetOpenReadWrite(EditElementHandleR eeh, bool isWritable);

    DGNPLATFORM_EXPORT bool SetGeoreferencePriority(EditElementHandleR eeh, GeoreferencePriority priority);

    DGNPLATFORM_EXPORT bool SetGCSInheritedFromModelState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetTransform(EditElementHandleR eeh, TransformCR matrix);

    DGNPLATFORM_EXPORT bool SetPageNumber(EditElementHandleR eeh,UInt32 page);

    DGNPLATFORM_EXPORT bool SetColorMode(EditElementHandleR eeh,ImageColorMode colorMode);

    DGNPLATFORM_EXPORT bool SetScanningResolution(EditElementHandleR eeh,DPoint2dCR scanningResolutionDPI);

    DGNPLATFORM_EXPORT bool SetViewState(EditElementHandleR eeh,int viewNumber,bool state);

    DGNPLATFORM_EXPORT bool SetInvertState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetPrintState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetClipState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetTransparencyState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetBinaryPrintInvertState(EditElementHandleR eeh, bool state);

    DGNPLATFORM_EXPORT bool SetDisplayPriorityPlane(EditElementHandleR eeh, RasterDisplayPriorityPlane plane);

    DGNPLATFORM_EXPORT bool SetLayer(EditElementHandleR eeh, long layer);

    DGNPLATFORM_EXPORT bool SetViewGamma(EditElementHandleR eeh, double gamma);

    DGNPLATFORM_EXPORT bool SetPrintGamma(EditElementHandleR eeh, double gamma);

    DGNPLATFORM_EXPORT bool SetTintColor(EditElementHandleR eeh, UInt32 rawColorIndex);

    DGNPLATFORM_EXPORT bool SetForegroundColor(EditElementHandleR eeh, UInt32 rawColorIndex);

    DGNPLATFORM_EXPORT bool SetBackgroundColor(EditElementHandleR eeh, UInt32 rawColorIndex);

    DGNPLATFORM_EXPORT bool SetContrast(EditElementHandleR eeh, char contrast);  // CHAR_OK

    DGNPLATFORM_EXPORT bool SetBrightness(EditElementHandleR eeh, char brightness); // CHAR_OK

    DGNPLATFORM_EXPORT bool SetImageTransparencyLevel(EditElementHandleR eeh,UInt8 transparency);

    DGNPLATFORM_EXPORT bool SetTransparentColors(EditElementHandleR eeh,RasterTransparentColorsCollectionCR rasterTransparentColors);

    DGNPLATFORM_EXPORT bool SetGeotiffUnit(EditElementHandleR eeh, UnitDefinitionCR GeotiffUnit);

    DGNPLATFORM_EXPORT bool SetGeotiffDefaultUnitFactor(EditElementHandleR eeh, double factor);

    DGNPLATFORM_EXPORT bool SetGeotiffUnitUseUOR(EditElementHandleR eeh,bool useUOR);

    DGNPLATFORM_EXPORT bool SetGeotiffUnitPriority(EditElementHandleR eeh,GeotiffUnitPriority priority);

    DGNPLATFORM_EXPORT bool SetWorldFileUnit(EditElementHandleR eeh, UnitDefinitionCR WorldFileUnit);

    DGNPLATFORM_EXPORT bool SetWorldFileDefaultUnitFactor(EditElementHandleR eeh, double factor);

    DGNPLATFORM_EXPORT bool SetGeocoding(EditElementHandleR eeh, ElementHandleCR geocoding);

    DGNPLATFORM_EXPORT bool SetClipProperties(EditElementHandleR eeh, RasterClipPropertiesCR clipProperties);

}; //IRasterAttachmentEdit


END_BENTLEY_DGNPLATFORM_NAMESPACE