DgnViewport.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    <Bentley/WString.h>
#include    <Geom/IntegerTypes/BSIRect.h>
#include    "IViewOutput.h"
#include    "DisplayStyleManager.h"
#include    "ColorUtil.h"
#include    "ViewInfo.h"


BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
/*=================================================================================**/
struct FitViewParams
{
    ViewportP       m_viewport;
    RotMatrixCP     m_rMatrix;
    DgnModelP       m_modelIfNoViewport;
    DgnModelRefListP m_fitList;
    bool            m_fitRasterRefs;
    bool            m_rasterElementsOnly;
    bool            m_includeTransients;
    bool            m_useScanRange;
    bool            m_fitMinDepth;
    bool            m_fitMaxDepth;
    bool            m_onlyInFitList;
    bool            m_ignoreCallouts;
    bool            m_unused2;

    enum FitModes
        {
        FITMODE_All        = 0,
        FITMODE_Active     = 1,
        FITMODE_Reference  = 2,
        FITMODE_Raster     = 3,
        };

    FitViewParams (ViewportP vp)
        {
        m_viewport = vp;
        m_rMatrix  = NULL;
        m_modelIfNoViewport = NULL;
        m_fitList = NULL;
        m_fitRasterRefs = m_rasterElementsOnly = m_includeTransients = m_useScanRange = m_fitMinDepth  = m_fitMaxDepth = m_onlyInFitList = false;
        m_unused2 = m_ignoreCallouts = false;
        }

    DGNPLATFORM_EXPORT void SetupFitList(FitModes fitModes);
};

/*=================================================================================**/
enum class ViewportResizeMode
    {
    KeepCurrent      = 0,

    RelativeRect     = 1,

    AspectRatio      = 2,

    Size             = 3,

    SizeAndPosition  = 4,
    };

/*=================================================================================**/
struct ApplyViewOptions
{
private:
    ViewportResizeMode  m_resizeMode;
    bool                m_applyVolume;
    bool                m_applyAttributes;
    bool                m_applyLevels;
    bool                m_applyRefLevels;
    bool                m_applyClipVolume;
    bool                m_applyModel;
    bool                m_createNamedViewDisplayableForClipping;
    bool                m_applyClipWithoutBoundary;
    bool                m_applyRightIsoCameraPosition;
    bool                m_applyAnnotationAttachment;
    int                 m_annotationAttachmentDrawingIndex;
    UInt32              m_reservedInts[8];
    bool                m_reservedBools[8];

public:
    DGNPLATFORM_EXPORT      ApplyViewOptions (bool initFromActive);
    ViewportResizeMode  GetViewportResizeMode () const                        { return m_resizeMode; }                              
    bool                GetApplyVolume () const                               { return m_applyVolume; }                             
    bool                GetApplyAttributes () const                           { return m_applyAttributes; }                         
    bool                GetApplyLevels () const                               { return m_applyLevels; }                             
    bool                GetApplyRefLevels () const                            { return m_applyRefLevels; }                          
    bool                GetApplyClipVolume () const                           { return m_applyClipVolume; }                         
    bool                GetApplyModel () const                                { return m_applyModel; }                              
    bool                GetCreateNamedViewDisplayableForClipping () const     { return m_createNamedViewDisplayableForClipping; }   
    bool                GetApplyClipWithoutBoundary () const                  { return m_applyClipWithoutBoundary; }                
    bool                GetApplyRightIsoCameraPosition () const               { return m_applyRightIsoCameraPosition; }             
    bool                GetApplyAnnotationAttachment() const                  { return m_applyAnnotationAttachment; }               
    int                 GetAnnotationAttachmentDrawingIndex() const           { return m_annotationAttachmentDrawingIndex; }        

    void                SetViewportResizeMode (ViewportResizeMode mode)       { m_resizeMode = mode; }

    void                SetApplyVolume (bool state)                           { m_applyVolume  = state; }

    void                SetApplyAttributes (bool state)                       { m_applyAttributes = state; }

    void                SetApplyLevels (bool state)                           { m_applyLevels = state; }

    void                SetApplyRefLevels (bool state)                        { m_applyRefLevels = state; }

    void                SetApplyClipVolume (bool state)                       { m_applyClipVolume = state; if (m_applyClipVolume) m_applyClipWithoutBoundary = false; }

    void                SetApplyModel (bool state)                            { m_applyModel = state; }

    void                SetCreateNamedViewDisplayableForClipping (bool state) { m_createNamedViewDisplayableForClipping = state; }

    void                SetApplyClipWithoutBoundary (bool state)              { m_applyClipWithoutBoundary = state; if (m_applyClipWithoutBoundary) m_applyClipVolume = false; }

    void                SetApplyRightIsoCameraPosition (bool state)           { m_applyRightIsoCameraPosition = state; }

    void                SetApplyAnnotationAttachment (bool state)             { m_applyAnnotationAttachment = state; }

    void                SetAnnotationAttachmentDrawingIndex (int index)       { m_annotationAttachmentDrawingIndex = index; }
    DGNPLATFORM_EXPORT void SetApplyAll (bool state);
};

//=======================================================================================
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct Viewport
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:

DGNPLATFORM_EXPORT IViewDrawP   GetIViewDraw ();

DGNPLATFORM_EXPORT IViewOutputP GetIViewOutput ();

DGNPLATFORM_EXPORT ICachedDrawP GetICachedDraw ();

DGNPLATFORM_EXPORT void         SetNeedsRefresh ();

DGNPLATFORM_EXPORT RotMatrixCP GetRotMatrix () const;

DGNPLATFORM_EXPORT DPoint3dCP GetScale () const;

DGNPLATFORM_EXPORT double GetActiveZRoot () const;

DGNPLATFORM_EXPORT void GetCameraView (CameraParams*) const;

DGNPLATFORM_EXPORT CameraParams const* GetCameraRoot () const;

DGNPLATFORM_EXPORT StatusInt GetCameraTarget (DPoint3dP) const;

DGNPLATFORM_EXPORT StatusInt GetClipBoundElemHandle (EditElementHandleR) const;

DGNPLATFORM_EXPORT StatusInt GetClipMaskElemHandle (EditElementHandleR) const;

DGNPLATFORM_EXPORT ElementRefP GetClipBoundElementRef () const;

DGNPLATFORM_EXPORT ElementRefP GetClipMaskElementRef () const;

DGNPLATFORM_EXPORT void SetTemporaryClipElementRef (ElementRefP element);
DGNPLATFORM_EXPORT void SetTemporaryClipMaskElementRef (ElementRefP element);

DGNPLATFORM_EXPORT DMap4dCP GetRootToViewMap ();

DGNPLATFORM_EXPORT DMap4dCP GetRootToNpcMap ();

DGNPLATFORM_EXPORT DMap4dCP GetActiveToRootMap () const;

DGNPLATFORM_EXPORT int GetIndexedLineWidth (int index) const;

DGNPLATFORM_EXPORT UInt32 GetIndexedLinePattern (int index) const;



DGNPLATFORM_EXPORT UInt32 GetBackgroundColor () const;

DGNPLATFORM_EXPORT UInt32 GetContrastToBackgroundColor () const;

DGNPLATFORM_EXPORT UInt32 AdjustColorForContrast (UInt32 thisColor, UInt32 againstColor) const;

DGNPLATFORM_EXPORT static UInt32 MakeTrgbColor (int red, int green, int blue, int transparency);

DGNPLATFORM_EXPORT static UInt32 MakeColorTransparency (UInt32 color, int transparency);

DGNPLATFORM_EXPORT static UInt32 MakeTransparentIfOpaque (UInt32 color, int transparency);

DGNPLATFORM_EXPORT void ResynchColorMap ();

DGNPLATFORM_EXPORT UInt32 GetHiliteColor () const;

DGNPLATFORM_EXPORT UInt32 GetHiliteColor (DisplayPathCP path) const;

DGNPLATFORM_EXPORT void SetSymbologyRgb (UInt32 lineColorTBGR, UInt32 fillColorTBGR, int lineWidth, int lineCodeIndex);


DGNPLATFORM_EXPORT void GetViewBox (DPoint3dP pts, DgnCoordSystem sys, bool adjustedBox) const;

DGNPLATFORM_EXPORT void GetViewRect (BSIRect& rect) const;

DGNPLATFORM_EXPORT void GetViewCorners (DPoint3dR low, DPoint3dR high) const;

DGNPLATFORM_EXPORT void NpcToView (DPoint3dP viewPts, DPoint3dCP npcPts, int nPts) const;

DGNPLATFORM_EXPORT void ViewToNpc (DPoint3dP npcPts, DPoint3dCP viewPts, int nPts) const;

DGNPLATFORM_EXPORT void NpcToRoot (DPoint3dP rootPts, DPoint3dCP npcPts, int nPts) const;

DGNPLATFORM_EXPORT void RootToNpc (DPoint3dP npcPts, DPoint3dCP rootPts, int nPts) const;

DGNPLATFORM_EXPORT void RootToView (DPoint4dP viewPts, DPoint3dCP rootPts, int nPts) const;

DGNPLATFORM_EXPORT void ViewToRoot (DPoint3dP rootPts, DPoint4dCP viewPts, int nPts) const;

DGNPLATFORM_EXPORT void RootToView (DPoint3dP viewPts, DPoint3dCP rootPts, int nPts) const;

DGNPLATFORM_EXPORT void RootToView2d (DPoint2dP viewPts, DPoint3dCP rootPts, int nPts) const;

DGNPLATFORM_EXPORT void ViewToRoot (DPoint3dP rootPts, DPoint3dCP viewPts, int nPts) const;

DGNPLATFORM_EXPORT void ActiveToView (DPoint3dP viewPts, DPoint3dCP activePts, int nPts) const;

DGNPLATFORM_EXPORT void ViewToActive (DPoint3dP activePts, DPoint3dCP viewPts, int nPts) const;

DGNPLATFORM_EXPORT void ActiveToRoot (DPoint3dP rootPts, DPoint3dCP activePts, int nPts) const;

DGNPLATFORM_EXPORT void RootToActive (DPoint3dP activePts, DPoint3dCP rootPts, int nPts) const;

DGNPLATFORM_EXPORT void ActiveToRoot (RotMatrixR rootRMatrix, RotMatrixCR activeRMatrix) const;

DGNPLATFORM_EXPORT void RootToActive (RotMatrixR activeRMatrix, RotMatrixCR rootRMatrix) const;

DGNPLATFORM_EXPORT void ViewToScreen (DPoint3dP screenPts, DPoint3dCP viewPts, int nPts) const;

DGNPLATFORM_EXPORT void ScreenToView (DPoint3dP viewPts, DPoint3dCP screenPts, int nPts) const;

DGNPLATFORM_EXPORT void SetMinimumLOD (double minLOD);


DGNPLATFORM_EXPORT bool IsActive () const;

DGNPLATFORM_EXPORT bool IsCameraOn () const;

DGNPLATFORM_EXPORT bool IsGridOn () const;

DGNPLATFORM_EXPORT bool Is3dModel () const;

DGNPLATFORM_EXPORT bool IsSheetView () const;

DGNPLATFORM_EXPORT DgnModelP GetRootModel () const;

DGNPLATFORM_EXPORT DgnModelRefP GetTargetModel () const;

DGNPLATFORM_EXPORT ViewInfoCP GetViewInfoCP () const;

DGNPLATFORM_EXPORT ViewInfoP GetViewInfoP ();

DGNPLATFORM_EXPORT void GetViewName (WStringR name);

DGNPLATFORM_EXPORT int GetViewNumber () const;

DGNPLATFORM_EXPORT int GetScreenNumber () const;

DGNPLATFORM_EXPORT DPoint3dCP GetViewOrigin () const;

DGNPLATFORM_EXPORT DPoint3dCP GetViewDelta () const;

DGNPLATFORM_EXPORT ViewFlagsCP GetViewFlags () const;

DGNPLATFORM_EXPORT double GetPixelSizeAtPoint (DPoint3dCP rootPt, DgnCoordSystem coordSys = DgnCoordSystem::Root) const;


DGNPLATFORM_EXPORT StatusInt Scroll (Point2dCP viewDist);

DGNPLATFORM_EXPORT StatusInt Zoom (DPoint3dCP newCenterRoot, double factor, bool normalizeCamera);

DGNPLATFORM_EXPORT StatusInt SetupFromFrustum (DPoint3dCP frustPts);

DGNPLATFORM_EXPORT BentleyStatus SynchWithViewInfo (bool saveInUndo, bool updateViewTitle);

DGNPLATFORM_EXPORT StatusInt ComputeFittedElementRange (DRange3dR range, IElementSetR elements, RotMatrixCP rMatrix);

DGNPLATFORM_EXPORT StatusInt   ComputeDisplayedModelRefRange (DRange3dR range, DgnModelRefP modelRef, bool includeChildren, FitViewParams& fitParams);


};



END_BENTLEY_DGNPLATFORM_NAMESPACE