include/opencascade/Graphic3d_ZLayerId.hxx

0001 // Created on: 2014-12-30
0002 // Created by: Kirill Gavrilov
0003 // Copyright (c) 2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _Graphic3d_ZLayerId_HeaderFile
0017 #define _Graphic3d_ZLayerId_HeaderFile
0018
0019 #include <Standard_Integer.hxx>
0020
0021 typedef Standard_Integer Graphic3d_ZLayerId;
0022
0023 //! This enumeration defines the list of predefined layers, which can not be removed (but settings can be overridden).
0024 //! Custom layers might be added with positive index (>= 1) if standard list is insufficient for application needs;
0025 //! these layers will be displayed on top of predefined ones.
0026 enum
0027 {
0028   Graphic3d_ZLayerId_UNKNOWN = -1, //!< identifier for invalid ZLayer
0029   Graphic3d_ZLayerId_Default =  0, //!< default Z-layer for main presentations
0030   Graphic3d_ZLayerId_Top     = -2, //!< overlay for 3D presentations which inherits Depth from previous ZLayer
0031   Graphic3d_ZLayerId_Topmost = -3, //!< overlay for 3D presentations with independent Depth
0032   Graphic3d_ZLayerId_TopOSD  = -4, //!< overlay for 2D presentations (On-Screen-Display)
0033   Graphic3d_ZLayerId_BotOSD  = -5  //!< underlay for 2D presentations (On-Screen-Display)
0034 };
0035
0036 #endif // _Graphic3d_ZLayerId_HeaderFile