IPrinterDriver.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 <Mstn\Plot\PlotApi.h>

MSTNPLATFORM_PRINT_TYPEDEFS (IPlotDPoints);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotPolygonSetParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotPathParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotClipParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotTextParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotBorderTextParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPlotRasterParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IDriverPreBeginPlotParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IDriverBeginPlotParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IDriverEndPlotParam);
MSTNPLATFORM_PRINT_TYPEDEFS (IPrinterDriverOutputPath);
MSTNPLATFORM_PRINT_TYPEDEFS (IPrinterDriverOutputRaster);
MSTNPLATFORM_PRINT_TYPEDEFS (IPrinterDriverOutputText);
MSTNPLATFORM_PRINT_TYPEDEFS (IPrinterDriverOutputVector);

BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
BEGIN_PRINT_NAMESPACE

enum class PlotPathOperator
    {
    Undefined = 0,      
    MoveTo = 'm',       
    LineTo = 'l',       
    BezierTo = 'c',     
    };

enum class PlotRasterFormat
    {
    BitMap = 1,         
    ByteMap = 3,        
    RGBSeparate = 5,    
    RGBA = 7            
    };

enum class PlotRasterTransparency
    {
    None = 0,           
    Color = 1,          
    Mask = 2            
    };

/*=================================================================================**/
bsiInterface IPlotDPoints
{
virtual int GetNumPoints() const = 0;

virtual DPoint2dCP GetDPoints() const = 0;
};

/*=================================================================================**/
bsiInterface IPlotPolygonSetParam
{
virtual int GetNumPolygons() = 0;

virtual int GetTotalNumPoints() = 0;

virtual IPlotDPointsP GetPolygon (int polygonIndex) = 0;

virtual bool IsTextGlyph() const = 0;

virtual bool GetIsTextBoundaryColorValid() = 0;

virtual UInt32 GetTextBoundaryColor() = 0;
};

/*=================================================================================**/
bsiInterface IPlotPathParam
{
virtual int GetNumOperators() = 0;

virtual PlotPathOperator GetNextOperator (IPlotDPointsP* operatorVerticesP) = 0;

virtual void ResetCurrentOperator() = 0;

virtual bool IsFilled() = 0;

virtual bool ContainsCurves() = 0;

virtual bool ContainsDisconnects() = 0;

virtual int GetTotalNumPoints() = 0;

virtual DPoint2dCP GetTotalDPoints() = 0;

virtual CharCP GetOperators() = 0;

virtual bool IsTextGlyph() const = 0;

virtual bool GetIsTextBoundaryColorValid() = 0;

virtual UInt32 GetTextBoundaryColor() = 0;
};

/*=================================================================================**/
bsiInterface IPlotClipParam : IPlotPolygonSetParam
{
virtual bool GetIsPlotBorder() const = 0;

virtual int GetBorderWidth() const = 0;

virtual DRange2d ComputeRange() const = 0;
};

/*=================================================================================**/
bsiInterface IPlotBorderTextParam
{
virtual WCharCP GetString() const = 0;

virtual bool GetIsLicenseLabelNeeded() const = 0;

virtual int GetBorderWidth() const = 0;

virtual RgbaColorDef GetBorderColor() const = 0;

virtual RgbaColorDef GetBackgroundColor() const = 0;
};

/*=================================================================================**/
bsiInterface IPlotRasterParam
{
virtual PlotRasterFormat GetFormat() = 0;

virtual byte* GetImage() = 0;

virtual int GetPaletteSize() = 0;

virtual byte* GetRedMap() = 0;

virtual byte* GetGreenMap() = 0;

virtual byte* GetBlueMap() = 0;

virtual Point2dCR GetImageSize() = 0;

virtual DRange2dCR GetImageRect() = 0;

virtual DRange2dCR GetPlotterRect() = 0;

virtual bool GetIsGrayscale() = 0;

virtual PlotRasterTransparency GetTransparencyMode() = 0;

virtual int GetTransparentIndex() = 0;

virtual RgbColorDef GetTransparentColor() = 0;

virtual UShort** GetTransparentMask() = 0;

virtual double GetGlobalTransparency() = 0;
};

/*=================================================================================**/
bsiInterface IDriverPreBeginPlotParam
{
virtual IPrintEngineP GetPrintEngine() = 0;
};

/*=================================================================================**/
bsiInterface IDriverBeginPlotParam
{
virtual IPrintEngineP GetPrintEngine() = 0;
};

/*=================================================================================**/
bsiInterface IDriverEndPlotParam
{
virtual IPrintEngineP GetPrintEngine() = 0;

virtual bool IsSuccess() const = 0;
};


/*=================================================================================**/
bsiInterface IPrinterDriverBase
{
virtual StatusInt DriverPreLoad() = 0;

virtual StatusInt DriverLoad (IPlotterP plotter) = 0;

virtual void DriverUnload() = 0;

virtual StatusInt DriverPreBeginPlot (IDriverPreBeginPlotParamP param) = 0;

virtual StatusInt DriverBeginPlot (IDriverBeginPlotParamP param) = 0;

virtual StatusInt DriverEndPlot (IDriverEndPlotParamP param) = 0;

virtual bool CheckStop() = 0;

virtual void PushClip (IPlotClipParamP param) = 0;

virtual void PopClip() = 0;

virtual void BorderText (IPlotBorderTextParamP param) = 0;
};

/*=================================================================================**/
bsiInterface IPrinterDriverOutputVector
{
virtual void SetColor (RgbaColorDef color) = 0;

virtual void SetWidth (int widthDots) = 0;

virtual void SetLineStyleIndex (int lineStyleIndex) = 0;

virtual void SetLineJoin (PlotLineJoin lineJoin) = 0;

virtual void SetLineCap (PlotLineCap lineCap) = 0;

virtual void OutputLinestring (IPlotDPointsP param) = 0;

virtual void OutputPolygonSet (IPlotPolygonSetParamP param) = 0;
};

/*=================================================================================**/
bsiInterface IPrinterDriverOutputPath : IPrinterDriverOutputVector
{
virtual void OutputPath (IPlotPathParamP param) = 0;
};

/*=================================================================================**/
bsiInterface IPrinterDriverOutputRaster
{
virtual void OutputRaster (IPlotRasterParamP param) = 0;
};

/*---------------------------------------------------------------------------------*/
DLLEXPORT void mdlPlot_registerIPrinterDriver (IPrinterDriverBaseP printerDriver);


END_PRINT_NAMESPACE
END_BENTLEY_MSTNPLATFORM_NAMESPACE