OCCT

// Created on: 2015-12-15
// 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_ViewClipRange_HeaderFile
#define _SelectMgr_ViewClipRange_HeaderFile

#include <Bnd_Range.hxx>
#include <Standard_TypeDef.hxx>
#include <Standard_OStream.hxx>
#include <Standard_Dump.hxx>
#include <NCollection_LinearVector.hxx>

class gp_Ax1;
class Graphic3d_SequenceOfHClipPlane;

//! Class for handling depth clipping range.
//! It is used to perform checks in case if global (for the whole view)
//! clipping planes are defined inside of SelectMgr_RectangularFrustum class methods.
class SelectMgr_ViewClipRange
{
public:
  //! Creates an empty clip range.
  SelectMgr_ViewClipRange() { SetVoid(); }

  //! Check if the given depth is not within clipping range(s),
  //! e.g. TRUE means depth is clipped.
  bool IsClipped(const double theDepth) const
  {
    if (myUnclipRange.IsOut(theDepth))
    {
      return true;
    }
    for (size_t aRangeIter = 0; aRangeIter < myClipRanges.Size(); ++aRangeIter)
    {
      if (!myClipRanges[aRangeIter].IsOut(theDepth))
      {
        return true;
      }
    }
    return false;
  }

  //! Calculates the min not clipped value from the range.
  //! Returns FALSE if the whole range is clipped.
  bool GetNearestDepth(const Bnd_Range& theRange, double& theDepth) const
  {
    if (!myUnclipRange.IsVoid() && myUnclipRange.IsOut(theRange))
    {
      return false;
    }

    Bnd_Range aCommonClipRange;
    theRange.GetMin(theDepth);

    if (!myUnclipRange.IsVoid() && myUnclipRange.IsOut(theDepth))
    {
      myUnclipRange.GetMin(theDepth);
    }

    for (size_t aRangeIter = 0; aRangeIter < myClipRanges.Size(); ++aRangeIter)
    {
      if (!myClipRanges[aRangeIter].IsOut(theDepth))
      {
        aCommonClipRange = myClipRanges[aRangeIter];
        break;
      }
    }

    if (aCommonClipRange.IsVoid())
    {
      return true;
    }

    for (size_t aRangeIter = 0; aRangeIter < myClipRanges.Size(); ++aRangeIter)
    {
      if (!aCommonClipRange.IsOut(myClipRanges[aRangeIter]))
      {
        aCommonClipRange.Add(myClipRanges[aRangeIter]);
      }
    }

    aCommonClipRange.GetMax(theDepth);

    return !theRange.IsOut(theDepth);
  }

public:
  //! Clears clipping range.
  void SetVoid()
  {
    myClipRanges.Clear();
    myUnclipRange = Bnd_Range(RealFirst(), RealLast());
  }

  //! Add clipping planes. Planes and picking ray should be defined in the same coordinate system.
  Standard_EXPORT void AddClippingPlanes(const Graphic3d_SequenceOfHClipPlane& thePlanes,
                                         const gp_Ax1&                         thePickRay);

  //! Returns the main unclipped range; [-inf, inf] by default.
  Bnd_Range& ChangeUnclipRange() { return myUnclipRange; }

  //! Adds a clipping sub-range (for clipping chains).
  void AddClipSubRange(const Bnd_Range& theRange) { myClipRanges.Append(theRange); }

  //! Dumps the content of me into the stream
  Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const;

private:
  NCollection_LinearVector<Bnd_Range> myClipRanges;
  Bnd_Range                           myUnclipRange;
};

#endif // _SelectMgr_ViewClipRange_HeaderFile