include/opencascade/Graphic3d_TextureEnv.hxx

0001 // Created on: 1997-07-28
0002 // Created by: Pierre CHALAMET
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Graphic3d_TextureEnv_HeaderFile
0018 #define _Graphic3d_TextureEnv_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Graphic3d_NameOfTextureEnv.hxx>
0023 #include <Graphic3d_TextureRoot.hxx>
0024 #include <Standard_Integer.hxx>
0025 class TCollection_AsciiString;
0026
0027 //! This class provides environment texture.
0028 class Graphic3d_TextureEnv : public Graphic3d_TextureRoot
0029 {
0030
0031 public:
0032   //! Creates an environment texture from a file.
0033   Standard_EXPORT Graphic3d_TextureEnv(const TCollection_AsciiString& theFileName);
0034
0035   //! Creates an environment texture from a predefined texture name set.
0036   Standard_EXPORT Graphic3d_TextureEnv(const Graphic3d_NameOfTextureEnv theName);
0037
0038   //! Creates an environment texture from the pixmap.
0039   Standard_EXPORT Graphic3d_TextureEnv(const occ::handle<Image_PixMap>& thePixMap);
0040
0041   //! Returns the name of the predefined textures or NOT_ENV_UNKNOWN
0042   //! when the name is given as a filename.
0043   Standard_EXPORT Graphic3d_NameOfTextureEnv Name() const;
0044
0045   //! Returns the number of predefined textures.
0046   Standard_EXPORT static int NumberOfTextures();
0047
0048   //! Returns the name of the predefined texture of rank <aRank>
0049   Standard_EXPORT static TCollection_AsciiString TextureName(const int theRank);
0050
0051   DEFINE_STANDARD_RTTIEXT(Graphic3d_TextureEnv, Graphic3d_TextureRoot)
0052
0053 private:
0054   Graphic3d_NameOfTextureEnv myName;
0055 };
0056
0057 #endif // _Graphic3d_TextureEnv_HeaderFile