FxView.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPragmaPush.h"
 
#include <DbObjectId.h>
#include "DDKERNEL.h"
#include "FxPicture.h"
 
#include <Gi/GiCommonDraw.h>
#include <Ge/GeExtents3d.h>
#include <Ge/GeBoundBlock3d.h>
#include <DbViewport.h>
 
#include <vector>
 
class OdEdCommandContext;
class CFxGsNode;
class CFxSelectionSet;
class CFxViewDrawContext;
class CFxVectorizeDevice;
class CFxView;
class CFxViewReactor;
class CFxViewDrawInfo;
 
class QPainterPath;
class OdDbViewport;
 
using ViewportKey = size_t;
static constexpr ViewportKey NullViewportKey = 0;

class DDKERNEL_API CFxViewportSnapShot
{
public:
    CFxViewportSnapShot();

    bool InitializeFromView( const CFxView* pView );

    bool InitializeFromViewInfo( const CFxViewDrawInfo* pViewInfo );

    void ApplyToView( CFxView* pView );

    const OdGePoint3d& GetPosition() const
    {
        return m_position;
    }

    const OdGePoint3d& GetTarget() const
    {
        return m_target;
    }

    const OdGeVector3d& GetEyeVector() const
    {
        return m_eyeVector;
    }

    const OdGeVector3d& GetUpVector() const
    {
        return m_upVector;
    }

    double GetFieldWidth() const
    {
        return m_fieldWidth;
    }

    double GetFieldHeight() const
    {
        return m_fieldHeight;
    }

    double GetPixelWidth() const
    {
        return m_dPixelWidth;
    }

    double GetPixelHeight() const
    {
        return m_dPixelHeight;
    }

    double GetFocalLength() const
    {
        return m_focalLength;
    }

    const OdGeMatrix3d& GetWorldToEyeMatrix() const
    {
        return m_WorldToEye;
    }
 
    const OdGsDCRectDouble& GetVisibleRect() const
    {
        return m_VisibleRect;
    }

    static bool IsViewSettingsValid( const OdGsView* pView );

    static bool IsViewSettingsValid( const OdDbViewport* pViewport );

    static bool IsViewExtentsValid( const OdGeExtents3d& extents );
 
/*
    static bool IsViewSettingsValid(
        const OdGePoint3d& position,
        const OdGePoint3d& target,
        const OdGeVector3d& upVector,
        double fieldWidth,
        double fieldHeight );
*/
    OdGePoint2d GetNumPixelsInUnitSquare( 
        double iWidthInPixels, 
        double iHeighInPixels,  
        const OdGePoint3d& point, 
        bool bUsePerspective) const;
 
    bool operator == ( const CFxViewportSnapShot& other ) const;
 
    bool operator != ( const CFxViewportSnapShot& other ) const;
 
private:
    OdGePoint3d     m_position;
    OdGePoint3d     m_target;
    OdGeVector3d    m_eyeVector;
    OdGeVector3d    m_upVector;
    double          m_fieldWidth;
    double          m_fieldHeight;
    double          m_focalLength;
 
    double          m_dPixelWidth;
    double          m_dPixelHeight;
 
    OdGeMatrix3d    m_WorldToEye;
 
    OdGsDCRectDouble   m_VisibleRect;
    static bool     m_bEvent;
};
 
typedef std::vector<CFxViewportSnapShot> VIEWPORTDATA_VECTOR;

class DDKERNEL_API CFxView : public OdGsView
{
public:

    CFxView();

    ~CFxView() override;
 
    ODRX_DECLARE_MEMBERS( CFxView );

    virtual const CFxVectorizeDevice* GetFxVectorizeDevice() const = 0;

    virtual CFxVectorizeDevice* GetFxVectorizeDevice() = 0;

    virtual const QPainterPath& GetViewportInternalRegion() const = 0;

    virtual const QPainterPath& GetViewportExternalRegion() const = 0;

    virtual const OdGePoint3dArray& GetViewportInternalRegionWCS() const = 0;

    virtual const OdGePoint3dArray& GetViewportExternalRegionWCS() const = 0;

    virtual bool IsOverall() const = 0;

    virtual bool IsPaperSpaceOverall() const = 0;

    virtual bool IsActive() const = 0;

    virtual bool SetPreviousData() = 0;

    virtual void StartTransaction() = 0;

    virtual void EndTransaction( bool bAnimate = false ) = 0;

    virtual bool InsideTransaction() const = 0;

    virtual int PointToWCS( const OdGsDCPoint& pointSCS, const OdGePlane& plane, OdGePoint3d& pointWCS ) const = 0;
    virtual int PointToWCS( const CFxPointF& pointSCS, const OdGePlane& plane, OdGePoint3d& pointWCS ) const = 0;

    virtual int PointToWCSOnUCS( const OdGsDCPoint& pointSCS, OdGePoint3d& pointWCS ) const = 0;

    virtual int PointToWCSOnUCS( const OdGePoint3d& pointSCS, OdGePoint3d& pointWCS ) const = 0;

    virtual int PointToWCSOnUCS( const OdGePoint2d& pointSCS, OdGePoint3d& pointWCS ) const = 0;

    virtual void PointToSCS( const OdGePoint3d& pointWCS, OdGsDCPoint& pointSCS ) const = 0;

    virtual void PointToSCS( const OdGePoint3d& pointWCS, CFxPoint& pointSCS ) const = 0;

    virtual void PointToSCS( const OdGePoint3d& pointWCS, CFxPointF& pointSCS ) const = 0;

    virtual int PointToView( const OdGsDCPoint& pointSCS, OdGePoint2d& viewPt ) const = 0;

    virtual int PointToView( const OdGePoint2d& pointSCS, OdGePoint2d& viewPt ) const = 0;

    virtual OdGeMatrix3d EyeToPaperSpace() const = 0;
 
    static OdGeMatrix3d EyeToPaperSpace( OdDbObjectId idViewport );

    virtual OdGeMatrix3d PaperSpaceToEye() const = 0;
 
    static OdGeMatrix3d PaperSpaceToEye( OdDbObjectId idViewport );

    static OdGeMatrix3d WorldToView( OdDbObjectId id );

    virtual ViewportKey GetVpNum() const = 0;

    virtual OdInt16 GetCadWindowId() const = 0;

    virtual const CFxViewportSnapShot* GetPreviousViewSettings() const = 0;

    virtual void AddViewReactor( CFxViewReactor* pReactor ) = 0;

    virtual void RemoveViewReactor( CFxViewReactor* pReactor ) = 0;

    virtual void SetElevation( double dElev ) = 0;

    virtual double Elevation() const = 0;

    virtual bool IsRectangular() const = 0;

    virtual bool ViewExtentsWCS( OdGeBoundBlock3d& extents ) const = 0;

    virtual bool ZoomExtentsWCS( const OdGeBoundBlock3d* pExtents ) = 0;

    virtual void EnterDragMode() = 0;

    virtual bool IsDragging() const = 0;

    virtual void LeaveDragMode() = 0;

    virtual OdGeExtents3d GetRealExtents(volatile bool *abortFlag = 0) const = 0;

    virtual bool GetGeomExtents( OdGeBoundBlock3d& bounds, volatile bool *abortFlag = 0 ) const = 0;

    virtual void SetPanMode( bool bVal ) = 0;
 
    virtual bool IsPanMode() const = 0;

    virtual void SetZoomMode( bool bVal ) = 0;
 
    virtual bool IsZoomMode() const = 0;

    virtual void SetOrbitMode( bool bVal ) = 0;
 
    virtual bool IsOrbitMode() const = 0;
 
    virtual bool IsPreviousVectorizationAborted() const = 0;
    virtual OdGeVector3d viewDir() const = 0;

    virtual double focalLength() const = 0;

    virtual OdGeMatrix3d getWorldToEyeTransform() const = 0;

    virtual OdGeMatrix3d getEyeToWorldTransform() const = 0;

    virtual OdGeMatrix3d getEyeToScreenMatrix() const = 0;

    virtual double GetDeviation(const OdGiDeviationType deviationType, const OdGePoint3d& pointOnCurve) const = 0;

    virtual void screenRect(OdGsDCPoint &lowerLeft, OdGsDCPoint &upperRight) const = 0;

    virtual void screenRect(OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const = 0;

    virtual OdGsDCRectDouble visibleScreenRect() const = 0;

    virtual OdGsDCRectDouble visibleScreenRectInViewCoordinates() const = 0;

    virtual double screenWidth() const = 0;

    virtual double screenHeight() const = 0;

    virtual double visibleWidth() const = 0;

    virtual double visibleHeight() const = 0;

    virtual OdDbStub*     viewportObjectId() const = 0;

    virtual OdGeMatrix3d GetCorrectionScreenMatrix() const = 0;

    virtual size_t numDrawables() const = 0;

    virtual OdGiDrawablePtr drawableAt( size_t iIndex ) const = 0;

    virtual bool IsFieldAspectMaintained() const = 0;

    virtual void SetFieldAspectMaintained(bool) = 0;
};
 
class OdDbPlotSettings;

extern DDKERNEL_API void GetPaperProperties( OdDbPlotSettings* pLayout, OdGePoint3dArray& points, OdGePoint3dArray& margins );
 
extern DDKERNEL_API CFxView* GetActiveFxView( OdEdCommandContext* pCmdCtx );
 
#include "FxPragmaPop.h"