0027536: Visualization - incorrect behavior of zoom persisted objects

[occt.git] / src / SelectMgr / SelectMgr_FrustumBuilder.hxx

// Created on: 2014-11-24
// Created by: Varvara POSKONINA
// Copyright (c) 2005-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _SelectMgr_FrustumBuilder_HeaderFile
#define _SelectMgr_FrustumBuilder_HeaderFile

#include <Standard_Type.hxx>

#include <Graphic3d_Camera.hxx>
#include <Graphic3d_WorldViewProjState.hxx>
#include <Precision.hxx>
#include <SelectMgr_VectorTypes.hxx>

//! The purpose of this class is to provide unified interface for building
//! selecting frustum depending on current camera projection and orientation
//! matrices, window size and viewport parameters.
class SelectMgr_FrustumBuilder : public Standard_Transient
{
public:
  //! Creates new frustum builder with empty matrices
  SelectMgr_FrustumBuilder();

  //! Stores current world view transformation matrix
  Standard_EXPORT void SetWorldViewMatrix (const Graphic3d_Mat4d& theWorldViewMatrix);

  //! @return current world view transformation matrix
  Standard_EXPORT const Graphic3d_Mat4d& WorldViewMatrix() const;

  //! Stores current projection matrix
  Standard_EXPORT void SetProjectionMatrix (const Graphic3d_Mat4d& theProjection);

  //! @return current projection matrix
  Standard_EXPORT const Graphic3d_Mat4d& ProjectionMatrix() const;

  //! Stores current world view projection matrix state for the orientation and projection matrices
  Standard_EXPORT void SetWorldViewProjState (const Graphic3d_WorldViewProjState& theState);

  //! @return current world view projection state
  Standard_EXPORT const Graphic3d_WorldViewProjState& WorldViewProjState() const;

  //! Stores current window width and height
  Standard_EXPORT void SetWindowSize (const Standard_Integer theWidth,
                                      const Standard_Integer theHeight);

  //! Stores current viewport coordinates
  Standard_EXPORT void SetViewport (const Standard_Real theX,
                                    const Standard_Real theY,
                                    const Standard_Real theWidth,
                                    const Standard_Real theHeight);

  Standard_EXPORT void InvalidateViewport();

  Standard_EXPORT void WindowSize (Standard_Integer& theWidth,
                                   Standard_Integer& theHeight);

  //! Calculates signed distance between plane with equation
  //! theEq and point thePnt
  Standard_EXPORT Standard_Real SignedPlanePntDist (const SelectMgr_Vec3& theEq,
                                                    const SelectMgr_Vec3& thePnt) const;

  //! Projects 2d screen point onto view frustum plane:
  //! theZ = 0 - near plane,
  //! theZ = 1 - far plane
  Standard_EXPORT gp_Pnt ProjectPntOnViewPlane (const Standard_Real& theX,
                                                const Standard_Real& theY,
                                                const Standard_Real& theZ) const;

  DEFINE_STANDARD_RTTIEXT(SelectMgr_FrustumBuilder,Standard_Transient)

private:

  //! Unprojects point from NDC coords to 3d world space
  gp_Pnt unProject (const gp_Pnt& thePnt) const;

private:

  Graphic3d_Mat4d                   myWorldView;
  Graphic3d_Mat4d                   myProjection;
  Graphic3d_WorldViewProjState      myWorldViewProjState;
  Standard_Integer                  myWidth;
  Standard_Integer                  myHeight;
  NCollection_Vec4<Standard_Real>   myViewport;
  Standard_Boolean                  myIsViewportSet;
};

DEFINE_STANDARD_HANDLE(SelectMgr_FrustumBuilder, Standard_Transient)

#endif // _SelectMgr_FrustumBuilder_HeaderFile