0027860: Visualization - clean up Transformation Persistence API
[occt.git] / src / Graphic3d / Graphic3d_Texture2D.hxx
CommitLineData
42cf5bc1 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_Texture2D_HeaderFile
18#define _Graphic3d_Texture2D_HeaderFile
19
42cf5bc1 20#include <Graphic3d_NameOfTexture2D.hxx>
21#include <Graphic3d_TextureMap.hxx>
42cf5bc1 22
23//! This abstract class for managing 2D textures
24class Graphic3d_Texture2D : public Graphic3d_TextureMap
25{
d2edda76 26 DEFINE_STANDARD_RTTIEXT(Graphic3d_Texture2D, Graphic3d_TextureMap)
42cf5bc1 27public:
28
42cf5bc1 29 //! Returns the number of predefined textures.
30 Standard_EXPORT static Standard_Integer NumberOfTextures();
42cf5bc1 31
32 //! Returns the name of the predefined texture of rank <aRank>
33 Standard_EXPORT static TCollection_AsciiString TextureName (const Standard_Integer theRank);
34
d2edda76 35public:
36
37 //! Returns the name of the predefined textures or NOT_2D_UNKNOWN
38 //! when the name is given as a filename.
39 Standard_EXPORT Graphic3d_NameOfTexture2D Name() const;
42cf5bc1 40
d2edda76 41 //! Assign new image to the texture.
42 //! Note that this method does not invalidate already uploaded resources - consider calling ::UpdateRevision() if needed.
43 Standard_EXPORT void SetImage (const Handle(Image_PixMap)& thePixMap);
42cf5bc1 44
d2edda76 45 //! Return true if mip-maps should be used.
46 Standard_Boolean HasMipMaps() const { return myType == Graphic3d_TOT_2D_MIPMAP; }
42cf5bc1 47
d2edda76 48 //! Set if mip-maps should be used (generated if needed).
49 //! Note that this method should be called before loading / using the texture.
50 void SetMipMaps (const Standard_Boolean theToUse) { myType = theToUse ? Graphic3d_TOT_2D_MIPMAP : Graphic3d_TOT_2D; }
42cf5bc1 51
52protected:
42cf5bc1 53
54 Standard_EXPORT Graphic3d_Texture2D(const TCollection_AsciiString& theFileName, const Graphic3d_TypeOfTexture theType);
55
56 Standard_EXPORT Graphic3d_Texture2D(const Graphic3d_NameOfTexture2D theName, const Graphic3d_TypeOfTexture theType);
57
a13f2dc4 58 Standard_EXPORT Graphic3d_Texture2D(const Handle(Image_PixMap)& thePixMap, const Graphic3d_TypeOfTexture theType);
42cf5bc1 59
d2edda76 60protected:
42cf5bc1 61
62 Graphic3d_NameOfTexture2D myName;
63
42cf5bc1 64};
65
d2edda76 66DEFINE_STANDARD_HANDLE(Graphic3d_Texture2D, Graphic3d_TextureMap)
42cf5bc1 67
68#endif // _Graphic3d_Texture2D_HeaderFile