IPrintDescription.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 (PrintDescriptionRef);

BEGIN_BENTLEY_MSTNPLATFORM_NAMESPACE
BEGIN_PRINT_NAMESPACE

enum class PlotColorMode
    {
    Undefined = -1,         
    Monochrome = 0,         
    Grayscale = 1,          
    TrueColor = 2,          
    };

enum class PlotAutoAlignMode
    {
    None = 0,               
    XAxis = 1,              
    YAxis = 2,              
    };

enum class PropPubMethod
    {
    None = 0,               
    All = 1,                
    PropFilterFile = 2      
    };

/*=================================================================================**/
struct PlotFlags
    {
    unsigned int plotFence:1;

    unsigned int plotBorder:1;

    unsigned int plotBrokenAssocSymb:1;

    unsigned int useViewBackgroundColorForRender:1;

    unsigned int applyColorModeToRaster:1;

    unsigned int printPoints:1;

    unsigned int reserved:26;
    };

/*=================================================================================**/
struct LevelOverrideInfo
    {
    WString     LevelNameRegex;     
    WString     FileNameRegex;      
    bool        IsOn;               
    };

typedef bvector<LevelOverrideInfo> LevelOverrideList;

/*=================================================================================**/
struct ReferenceOverrideInfo
    {
    WString     FileNameRegex;      
    bool        IsOn;               
    };

typedef bvector<ReferenceOverrideInfo> ReferenceOverrideList;


/*=================================================================================**/
bsiInterface IPrintDefinition
{
virtual void SetPlotter (IPlotterP plotter, bool preserveLayout, bool identicalPlotters) = 0;

virtual IPlotterP GetPlotter() = 0;

virtual IPlotterCP GetPlotterCP() const = 0;

virtual void GetPaperSource (WStringR value) const = 0;

virtual StatusInt SetPaperSource (WCharCP value) = 0;

virtual PlotPropertyMapCR CustomPropertiesCR() const = 0;

virtual PlotPropertyMapR CustomProperties() = 0;
};

/*=================================================================================**/
bsiInterface IPrintDescription : IPrintDefinition
{
virtual StatusInt InitializeFromTCB (WCharCP pltcfgLfs) = 0;

virtual StatusInt InitializeFromTCB (IPlotterP plotter) = 0;

virtual StatusInt InitializeFromIniFile (WCharCP iniFileLfs) = 0;

virtual StatusInt UpdateFromTCB() = 0;

virtual void UpdateAfterPrinterChange (bool preserveRasterQuality) = 0;

virtual void UpdateAfterDeviceInfoChange() = 0;

virtual bool GetIsSilentMode() const = 0;

virtual void SetIsSilentMode (bool value) = 0;

virtual void GetSystemPrinterName (WStringR name) const = 0;

virtual StatusInt SelectSystemPrinter (WCharCP printerName) = 0;

virtual PlotDestination GetPlotDestination() const = 0;

virtual void SetPlotDestination (PlotDestination destination) = 0;

virtual int GetNumCopies() const = 0;

virtual void SetNumCopies (int numCopies) = 0;

virtual StatusInt Print() const = 0;

virtual StatusInt Print (WCharCP outFile) const = 0;

virtual StatusInt Print (WCharCP outFile, PlotPropertyMapCR printSetProps, PlotPropertyMapCR printDefProps) const = 0;

virtual PlotAreaMode GetPlotArea() const = 0;

virtual StatusInt SetPlotArea (PlotAreaMode plotArea) = 0;

virtual int GetViewIndex() const = 0;

virtual StatusInt SetViewIndex (int viewIndex) = 0;

virtual StatusInt EvaluateFenceFromTCB (bool* plotPolyChangedP) const = 0;

virtual StatusInt SetFenceFromTCB() = 0;

virtual StatusInt SetFenceFromFitRange (bool fitAll) = 0;

virtual void GetViewDependentFence (int* numPointsP, DPoint2dP pointsP) const = 0;

virtual StatusInt SetViewDependentFence (int numPoints, DPoint2dCP points) = 0;

virtual void GetViewIndependentFence (int* numPointsP, DPoint3dP pointsP) const = 0;

virtual StatusInt SetViewIndependentFence (int numPoints, DPoint3dCP points) = 0;

virtual void GetViewIndependentWorkingFence (int* numPointsP, DPoint3dP pointsP) const = 0;

virtual bool IsFenceDefined() const = 0;

virtual bool IsSheetDefined() const = 0;

virtual PlotUnits GetUnits() const = 0;

virtual void SetUnits (PlotUnits units) = 0;

virtual IPlotterFormP GetForm() = 0;

virtual IPlotterFormCP GetFormCP() const = 0;

virtual StatusInt SetFormName (WCharCP value) = 0;

virtual void SetFormSizeX (double x) = 0;

virtual void SetFormSizeY (double y) = 0;

virtual void GetPaperDimensions (DPoint2dP printableSize, DPoint2dP totalSize) const = 0;

virtual PlotOrientation GetPaperOrientation() const = 0;

virtual void SetPaperOrientation (PlotOrientation orientation) = 0;

virtual void Maximize() = 0;

virtual double GetScaleRatio() const = 0;

virtual double GetScaleMU() const = 0;

virtual double GetScalePU() const = 0;

virtual void SetScaleRatio (double value) = 0;

virtual void SetScale (double scaleMasterUnits, double scalePaperUnits) = 0;

virtual double GetPlotSizeX() const = 0;

virtual double GetPlotSizeY() const = 0;

virtual void SetPlotSizeX (double x) = 0;

virtual void SetPlotSizeY (double y) = 0;

virtual double GetOriginX() const = 0;

virtual double GetOriginY() const = 0;

virtual void SetOriginX (double x) = 0;

virtual void SetOriginY (double y) = 0;

virtual bool GetMirrorAboutX() const = 0;

virtual bool GetMirrorAboutY() const = 0;

virtual void SetMirrorAboutX (bool isMirroredAboutX) = 0;

virtual void SetMirrorAboutY (bool isMirroredAboutY) = 0;

virtual double GetPlotRotation() const = 0;

virtual void SetPlotRotation (double angleRads) = 0;

virtual void RotateForBestFit (bool allowOrientationChange) = 0;

virtual bool IsPlotRotationOrthogonal() const = 0;

virtual bool IsPlotRotation90or270() const = 0;

virtual DPoint2d GetPlotRescale() const = 0;

virtual void SetPlotRescale (DPoint2d plotRescale) = 0;

virtual bool GetAutoCenterMode() const = 0;

virtual void SetAutoCenterMode (bool autoCenter) = 0;

virtual PlotAutoAlignMode GetAutoFenceAlignMode() const = 0;

virtual void SetAutoFenceAlignMode (PlotAutoAlignMode autoFenceAlignMode) = 0;

virtual void GetBorderComment (WStringR comment) const = 0;

virtual void SetBorderComment (WCharCP comment) = 0;

virtual PlotFileSpecCR GetPenTableFspec() const = 0;

virtual void SetPenTableFspec (PlotFileSpecCR value) = 0;

virtual PlotFileSpecCR GetDesignScriptFspec() const = 0;

virtual void SetDesignScriptFspec (PlotFileSpecCR value) = 0;

virtual PlotFileSpecCR GetPropertyFilterFspec() const = 0;

virtual void SetPropertyFilterFspec (PlotFileSpecCR value) = 0;

virtual ViewFlagsCR GetViewFlags() const = 0;

virtual void SetViewFlags (ViewFlagsCR viewFlags) = 0;

virtual PlotFlagsCR GetPlotFlags() const = 0;

virtual void SetPlotFlags (PlotFlagsCR plotFlags) = 0;

virtual void GetMasterModelName (WStringR modelName) const = 0;

virtual void GetViewGroupName (WStringR viewGroupName) const = 0;

virtual PlotColorMode GetColorMode() const = 0;

virtual void SetColorMode (PlotColorMode colorMode) = 0;

virtual LevelOverrideList& LevelOverrides() = 0;

virtual ReferenceOverrideList& ReferenceOverrides() = 0;

virtual PropPubMethod GetPropPubMethod() const = 0;

virtual void SetPropPubMethod (PropPubMethod value) = 0;

virtual bool IsRasterized() const = 0;

virtual void SetRasterized (bool isRasterized) = 0;

virtual bool GetIsPrintTo3D() const = 0;

virtual void SetIsPrintTo3D (bool isPrintTo3D) = 0;

virtual bool GetIsFullSheet() const = 0;

virtual void SetIsFullSheet (bool value) = 0;

virtual PlotRasterOptionsCR GetRasterOptions() const = 0;

virtual void SetRasterOptions (PlotRasterOptionsCR rasterOptions) = 0;

virtual bool IsRendered() const = 0;

virtual bool IsDefaultToRasterizedMode() const = 0;

virtual bool IsRasterizedDisabled() const = 0;

virtual bool IsColorModeDisabled() const = 0;

virtual bool IsMirrorDisabled() const = 0;

virtual bool IsNonOrthoPlotRotationDisabled() const = 0;

virtual bool IsPrintFenceBoundaryDisabled() const = 0;

virtual bool IsPrintTo3DDisabled() const = 0;
};

typedef RefCountedPtr<PrintDescriptionRef> PrintDescriptionPtr;

/*=================================================================================**/
struct PrintDescriptionRef : RefCountedBase
    {
private:
    IPrintDescriptionP m_printDesc;

public:
    PrintDescriptionRef();
    ~PrintDescriptionRef();

    IPrintDescriptionP GetP() { return m_printDesc; }
    IPrintDescriptionCP GetCP() const { return m_printDesc; }

    operator IPrintDescriptionP() { return GetP(); }
    operator IPrintDescriptionCP() const { return GetCP(); }

    DLLEXPORT static PrintDescriptionPtr Create();

    DLLEXPORT PrintDescriptionPtr Copy (bool copyPlotter);
    };


END_PRINT_NAMESPACE
END_BENTLEY_MSTNPLATFORM_NAMESPACE