src/Graphic3d/Graphic3d_TextureEnv.hxx

   1 // Created on: 1997-07-28
   2 // Created by: Pierre CHALAMET
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Graphic3d_TextureEnv_HeaderFile
  18 #define _Graphic3d_TextureEnv_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Graphic3d_NameOfTextureEnv.hxx>
  24 #include <Graphic3d_TextureRoot.hxx>
  25 #include <Image_PixMap_Handle.hxx>
  26 #include <Standard_Integer.hxx>
  27 class Standard_OutOfRange;
  28 class TCollection_AsciiString;
  29
  30
  31 class Graphic3d_TextureEnv;
  32 DEFINE_STANDARD_HANDLE(Graphic3d_TextureEnv, Graphic3d_TextureRoot)
  33
  34 //! This class provides environment texture.
  35 class Graphic3d_TextureEnv : public Graphic3d_TextureRoot
  36 {
  37
  38 public:
  39
  40
  41   //! Creates an environment texture from a file.
  42   Standard_EXPORT Graphic3d_TextureEnv(const TCollection_AsciiString& theFileName);
  43
  44   //! Creates an environment texture from a predefined texture name set.
  45   Standard_EXPORT Graphic3d_TextureEnv(const Graphic3d_NameOfTextureEnv theName);
  46
  47   //! Creates an environment texture from the pixmap.
  48   Standard_EXPORT Graphic3d_TextureEnv(const Image_PixMap_Handle& thePixMap);
  49
  50
  51   //! Returns the name of the predefined textures or NOT_ENV_UNKNOWN
  52   //! when the name is given as a filename.
  53   Standard_EXPORT Graphic3d_NameOfTextureEnv Name() const;
  54
  55
  56   //! Returns the number of predefined textures.
  57   Standard_EXPORT static Standard_Integer NumberOfTextures();
  58
  59
  60   //! Returns the name of the predefined texture of rank <aRank>
  61   Standard_EXPORT static TCollection_AsciiString TextureName (const Standard_Integer theRank);
  62
  63
  64
  65
  66   DEFINE_STANDARD_RTTIEXT(Graphic3d_TextureEnv,Graphic3d_TextureRoot)
  67
  68 protected:
  69
  70
  71
  72
  73 private:
  74
  75
  76   Graphic3d_NameOfTextureEnv myName;
  77
  78
  79 };
  80
  81
  82
  83
  84
  85
  86
  87 #endif // _Graphic3d_TextureEnv_HeaderFile