include/opencascade/Graphic3d_Texture2D.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_Texture2D_HeaderFile
0018 #define _Graphic3d_Texture2D_HeaderFile
0019
0020 #include <Graphic3d_NameOfTexture2D.hxx>
0021 #include <Graphic3d_TextureMap.hxx>
0022
0023 //! This abstract class for managing 2D textures
0024 class Graphic3d_Texture2D : public Graphic3d_TextureMap
0025 {
0026   DEFINE_STANDARD_RTTIEXT(Graphic3d_Texture2D, Graphic3d_TextureMap)
0027 public:
0028   //! Returns the number of predefined textures.
0029   Standard_EXPORT static int NumberOfTextures();
0030
0031   //! Returns the name of the predefined texture of rank <aRank>
0032   Standard_EXPORT static TCollection_AsciiString TextureName(const int theRank);
0033
0034 public:
0035   //! Creates a texture from a file.
0036   //! MipMaps levels will be automatically generated if needed.
0037   Standard_EXPORT Graphic3d_Texture2D(const TCollection_AsciiString& theFileName);
0038
0039   //! Creates a texture from a predefined texture name set.
0040   //! MipMaps levels will be automatically generated if needed.
0041   Standard_EXPORT Graphic3d_Texture2D(const Graphic3d_NameOfTexture2D theNOT);
0042
0043   //! Creates a texture from the pixmap.
0044   //! MipMaps levels will be automatically generated if needed.
0045   Standard_EXPORT Graphic3d_Texture2D(const occ::handle<Image_PixMap>& thePixMap);
0046
0047   //! Returns the name of the predefined textures or NOT_2D_UNKNOWN
0048   //! when the name is given as a filename.
0049   Standard_EXPORT Graphic3d_NameOfTexture2D Name() const;
0050
0051   //! Assign new image to the texture.
0052   //! Note that this method does not invalidate already uploaded resources - consider calling
0053   //! ::UpdateRevision() if needed.
0054   Standard_EXPORT void SetImage(const occ::handle<Image_PixMap>& thePixMap);
0055
0056 protected:
0057   Standard_EXPORT Graphic3d_Texture2D(const TCollection_AsciiString& theFileName,
0058                                       const Graphic3d_TypeOfTexture  theType);
0059
0060   Standard_EXPORT Graphic3d_Texture2D(const Graphic3d_NameOfTexture2D theName,
0061                                       const Graphic3d_TypeOfTexture   theType);
0062
0063   Standard_EXPORT Graphic3d_Texture2D(const occ::handle<Image_PixMap>& thePixMap,
0064                                       const Graphic3d_TypeOfTexture    theType);
0065
0066 protected:
0067   Graphic3d_NameOfTexture2D myName;
0068 };
0069
0070 #endif // _Graphic3d_Texture2D_HeaderFile