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
0028 class Graphic3d_TextureEnv;
0029 DEFINE_STANDARD_HANDLE(Graphic3d_TextureEnv, Graphic3d_TextureRoot)
0030
0031 //! This class provides environment texture.
0032 class Graphic3d_TextureEnv : public Graphic3d_TextureRoot
0033 {
0034
0035 public:
0036
0037
0038   //! Creates an environment texture from a file.
0039   Standard_EXPORT Graphic3d_TextureEnv(const TCollection_AsciiString& theFileName);
0040
0041   //! Creates an environment texture from a predefined texture name set.
0042   Standard_EXPORT Graphic3d_TextureEnv(const Graphic3d_NameOfTextureEnv theName);
0043
0044   //! Creates an environment texture from the pixmap.
0045   Standard_EXPORT Graphic3d_TextureEnv(const Handle(Image_PixMap)& thePixMap);
0046
0047
0048   //! Returns the name of the predefined textures or NOT_ENV_UNKNOWN
0049   //! when the name is given as a filename.
0050   Standard_EXPORT Graphic3d_NameOfTextureEnv Name() const;
0051
0052
0053   //! Returns the number of predefined textures.
0054   Standard_EXPORT static Standard_Integer NumberOfTextures();
0055
0056
0057   //! Returns the name of the predefined texture of rank <aRank>
0058   Standard_EXPORT static TCollection_AsciiString TextureName (const Standard_Integer theRank);
0059
0060
0061
0062
0063   DEFINE_STANDARD_RTTIEXT(Graphic3d_TextureEnv,Graphic3d_TextureRoot)
0064
0065 protected:
0066
0067
0068
0069
0070 private:
0071
0072
0073   Graphic3d_NameOfTextureEnv myName;
0074
0075
0076 };
0077
0078
0079
0080
0081
0082
0083
0084 #endif // _Graphic3d_TextureEnv_HeaderFile