// Created on: 2013-10-02
// Created by: Denis BOGOLEPOV
// Copyright (c) 2013 OPEN CASCADE SAS
//
// The content of this file is subject to the Open CASCADE Technology Public
// License Version 6.5 (the "License"). You may not use the content of this file
// except in compliance with the License. Please obtain a copy of the License
// at http://www.opencascade.org and read it completely before using this file.
//
// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
//
// The Original Code and all software distributed under the License is
// distributed on an "AS IS" basis, without warranty of any kind, and the
// Initial Developer hereby disclaims all such warranties, including without
// limitation, any warranties of merchantability, fitness for a particular
// purpose or non-infringement. Please see the License for the specific terms
// and conditions governing the rights and limitations under the License.

#ifndef _OpenGl_State_HeaderFile
#define _OpenGl_State_HeaderFile

#include <Graphic3d_SetOfHClipPlane.hxx>

#include <InterfaceGraphic_tgl_all.hxx>

#include <OpenGl_Element.hxx>
#include <OpenGl_Light.hxx>

//! Defines interface for OpenGL state.
class OpenGl_StateInterface
{
public:

  //! Creates new OCCT state.
  OpenGl_StateInterface();

  //! Returns current state index.
  Standard_Size Index() const;

  //! Updates current state.
  void Update();

  //! Reverts current state.
  void Revert();

protected:

  Standard_Size myIndex; //!< Current state index

};

//! Defines state of OCCT projection transformation.
class OpenGl_ProjectionState : public OpenGl_StateInterface
{
public:

  //! Creates uninitialized projection state.
  OpenGl_ProjectionState();

  //! Sets new projection matrix.
  void Set (const Tmatrix3& theProjectionMatrix);

  //! Returns current projection matrix.
  const Tmatrix3& ProjectionMatrix() const;

  //! Returns inverse of current projection matrix.
  const Tmatrix3& ProjectionMatrixInverse() const;

private:

  Tmatrix3         myProjectionMatrix;        //!< OCCT projection matrix
  mutable Tmatrix3 myProjectionMatrixInverse; //!< Inverse of OCCT projection matrix
  bool             myInverseNeedUpdate;       //!< Is inversed matrix outdated?

};

//! Defines state of OCCT model-world transformation.
class OpenGl_ModelWorldState : public OpenGl_StateInterface
{
public:

  //! Creates uninitialized model-world state.
  OpenGl_ModelWorldState();

  //! Sets new model-world matrix.
  void Set (const Tmatrix3& theModelWorldMatrix);

  //! Returns current model-world matrix.
  const Tmatrix3& ModelWorldMatrix() const;

  //! Returns inverse of current model-world matrix.
  const Tmatrix3& ModelWorldMatrixInverse() const;

private:

  Tmatrix3         myModelWorldMatrix;        //!< OCCT model-world matrix
  mutable Tmatrix3 myModelWorldMatrixInverse; //!< Inverse of OCCT model-world matrix
  bool             myInverseNeedUpdate;       //!< Is inversed matrix outdated?
  
};

//! Defines state of OCCT world-view transformation.
class OpenGl_WorldViewState : public OpenGl_StateInterface
{
public:

  //! Creates uninitialized world-view state.
  OpenGl_WorldViewState();
  
  //! Sets new world-view matrix.
  void Set (const Tmatrix3& theWorldViewMatrix);

  //! Returns current world-view matrix.
  const Tmatrix3& WorldViewMatrix() const;

  //! Returns inverse of current world-view matrix.
  const Tmatrix3& WorldViewMatrixInverse() const;

private:

  Tmatrix3         myWorldViewMatrix;        //!< OCCT world-view matrix
  mutable Tmatrix3 myWorldViewMatrixInverse; //!< Inverse of OCCT world-view matrix
  bool             myInverseNeedUpdate;      //!< Is inversed matrix outdated?

};

//! Defines state of OCCT light sources.
class OpenGl_LightSourceState : public OpenGl_StateInterface
{
public:

  //! Creates uninitialized state of light sources.
  OpenGl_LightSourceState();

  //! Sets new light sources.
  void Set (const OpenGl_ListOfLight* theLightSources);

  //! Returns current list of light sources.
  const OpenGl_ListOfLight* LightSources() const;

private:

  const OpenGl_ListOfLight* myLightSources; //!< List of OCCT light sources

};

//! Defines generic state of OCCT material properties.
class OpenGl_MaterialState : public OpenGl_StateInterface
{
public:

  //! Creates new material state.
  OpenGl_MaterialState (const OpenGl_Element* theAspect = NULL);
  
  //! Sets new material aspect.
  void Set (const OpenGl_Element* theAspect);

  //! Returns material aspect.
  const OpenGl_Element* Aspect() const;

private:

  const OpenGl_Element* myAspect; //!< OCCT material aspect

};

//! Defines generic state of OCCT clipping state.
class OpenGl_ClippingState : public OpenGl_StateInterface
{
public:

  //! Creates new clipping state.
  OpenGl_ClippingState();

};

#endif // _OpenGl_State_HeaderFile