0024637: Visualization - clean up implementation of rendering in immediate mode
[occt.git] / src / AIS / AIS_TexturedShape.hxx
1 // Created on: 2001-07-02
2 // Created by: Mathias BOSSHARD
3 // Copyright (c) 2001-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _AIS_TexturedShape_HeaderFile
17 #define _AIS_TexturedShape_HeaderFile
18
19 #include <AIS_Shape.hxx>
20 #include <gp_Pnt2d.hxx>
21 #include <Graphic3d_NameOfTexture2D.hxx>
22 #include <Image_PixMap.hxx>
23 #include <Standard_DefineHandle.hxx>
24 #include <TCollection_AsciiString.hxx>
25 #include <Graphic3d_AspectFillArea3d.hxx>
26 #include <Graphic3d_Texture2Dmanual.hxx>
27 #include <Prs3d_Presentation.hxx>
28 #include <PrsMgr_PresentationManager3d.hxx>
29
30 class Graphic3d_AspectFillArea3d;
31 class Graphic3d_Texture2Dmanual;
32
33 //! This class allows to map textures on shapes.
34 //! Presentations modes AIS_WireFrame (0) and AIS_Shaded (1) behave in the same manner as in AIS_Shape,
35 //! whilst new modes 2 (bounding box) and 3 (texture mapping) extends it functionality.
36 //!
37 //! The texture itself is parametrized in (0,1)x(0,1).
38 //! Each face of a shape located in UV space is provided with these parameters:
39 //! - Umin - starting position in U
40 //! - Umax - ending   position in U
41 //! - Vmin - starting position in V
42 //! - Vmax - ending   position in V
43 //! Each face is triangulated and a texel is assigned to each node.
44 //! Facets are then filled using a linear interpolation of texture between each 'three texels'.
45 //! User can act on:
46 //! - the number of occurrences of the texture on the face
47 //! - the position of the origin of the texture
48 //! - the scale factor of the texture
49 class AIS_TexturedShape : public AIS_Shape
50 {
51
52 public: //! @name main methods
53
54   //! Initializes the textured shape.
55   Standard_EXPORT AIS_TexturedShape (const TopoDS_Shape& theShape);
56
57   //! Sets the texture source. <theTextureFileName> can specify path to texture image or one of the standard predefined textures.
58   //! The accepted file types are those used in Image_AlienPixMap with extensions such as rgb, png, jpg and more.
59   //! To specify the standard predefined texture, the <theTextureFileName> should contain integer - the Graphic3d_NameOfTexture2D enumeration index.
60   //! Setting texture source using this method resets the source pixmap (if was set previously).
61   Standard_EXPORT virtual void SetTextureFileName (const TCollection_AsciiString& theTextureFileName);
62
63   //! Sets the texture source. <theTexturePixMap> specifies image data.
64   //! Please note that the data should be in Bottom-Up order, the flag of Image_PixMap::IsTopDown() will be ignored by graphic driver.
65   //! Setting texture source using this method resets the source by filename (if was set previously).
66   Standard_EXPORT virtual void SetTexturePixMap (const Image_PixMap_Handle& theTexturePixMap);
67
68   //! @return flag to control texture mapping (for presentation mode 3)
69   Standard_Boolean TextureMapState() const { return myToMapTexture; }
70
71   //! Enables texture mapping
72   Standard_EXPORT void SetTextureMapOn();
73
74   //! Disables texture mapping
75   Standard_EXPORT void SetTextureMapOff();
76
77   //! @return path to the texture file
78   Standard_CString TextureFile() const { return myTextureFile.ToCString(); }
79
80   //! @return the source pixmap for texture map
81   const Handle(Image_PixMap)& TexturePixMap() const { return myTexturePixMap; }
82
83 public: //! @name methods to alter texture mapping properties
84
85   //! Use this method to display the textured shape without recomputing the whole presentation.
86   //! Use this method when ONLY the texture content has been changed.
87   //! If other parameters (ie: scale factors, texture origin, texture repeat...) have changed, the whole presentation has to be recomputed:
88   //! @code
89   //! if (myShape->DisplayMode() == 3)
90   //! {
91   //!   myAISContext->RecomputePrsOnly (myShape);
92   //! }
93   //! else
94   //! {
95   //!   myAISContext->SetDisplayMode (myShape, 3, Standard_False);
96   //!   myAISContext->Display        (myShape, Standard_True);
97   //! }
98   //! @endcode
99   Standard_EXPORT void UpdateAttributes();
100
101   //! Enables texture modulation
102   Standard_EXPORT void EnableTextureModulate();
103
104   //! Disables texture modulation
105   Standard_EXPORT void DisableTextureModulate();
106
107   //! @return texture repeat flag
108   Standard_Boolean TextureRepeat() const { return myToRepeat; }
109
110   //! @return texture repeat U value
111   Standard_Real URepeat() const { return myUVRepeat.X(); }
112
113   //! @return texture repeat V value
114   Standard_Real VRepeat() const { return myUVRepeat.Y(); }
115
116   //! Sets the number of occurrences of the texture on each face. The texture itself is parameterized in (0,1) by (0,1).
117   //! Each face of the shape to be textured is parameterized in UV space (Umin,Umax) by (Vmin,Vmax).
118   //! If RepeatYN is set to false, texture coordinates are clamped in the range (0,1)x(0,1) of the face.
119   Standard_EXPORT void SetTextureRepeat (const Standard_Boolean theToRepeat,
120                                          const Standard_Real    theURepeat = 1.0,
121                                          const Standard_Real    theVRepeat = 1.0);
122
123   //! @return true if texture UV origin has been modified
124   Standard_Boolean TextureOrigin() const { return myIsCustomOrigin; }
125
126   //! @return texture origin U position (0.0 by default)
127   Standard_Real TextureUOrigin() const { return myUVOrigin.X(); }
128
129   //! @return texture origin V position (0.0 by default)
130   Standard_Real TextureVOrigin() const { return myUVOrigin.Y(); }
131
132   //! Use this method to change the origin of the texture. The texel (0,0) will be mapped to the surface (UOrigin,VOrigin)
133   Standard_EXPORT void SetTextureOrigin (const Standard_Boolean theToSetTextureOrigin,
134                                          const Standard_Real    theUOrigin = 0.0,
135                                          const Standard_Real    theVOrigin = 0.0);
136
137   //! @return true if scale factor should be applied to texture mapping
138   Standard_Boolean TextureScale() const { return myToScale; }
139
140   //! @return scale factor for U coordinate (1.0 by default)
141   Standard_Real TextureScaleU() const { return myUVScale.X(); }
142
143   //! @return scale factor for V coordinate (1.0 by default)
144   Standard_Real TextureScaleV() const { return myUVScale.Y(); }
145
146   //! Use this method to scale the texture (percent of the face).
147   //! You can specify a scale factor for both U and V.
148   //! Example: if you set ScaleU and ScaleV to 0.5 and you enable texture repeat,
149   //!          the texture will appear twice on the face in each direction.
150   Standard_EXPORT void SetTextureScale (const Standard_Boolean theToSetTextureScale,
151                                         const Standard_Real    theScaleU = 1.0,
152                                         const Standard_Real    theScaleV = 1.0);
153
154   //! @return true if displaying of triangles is requested
155   Standard_Boolean ShowTriangles() const { return myToShowTriangles; }
156
157   //! Use this method to show the triangulation of the shape (for debugging etc.).
158   Standard_EXPORT void ShowTriangles (const Standard_Boolean theToShowTriangles = Standard_False);
159
160   //! @return true if texture color modulation is turned on
161   Standard_Boolean TextureModulate() const { return myModulate; }
162
163 protected: //! @name overridden methods
164
165   //! Compute presentation with texture mapping support.
166   Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& thePrsMgr,
167                                         const Handle(Prs3d_Presentation)&           thePrs,
168                                         const Standard_Integer                      theMode);
169
170   Standard_EXPORT void updateAttributes (const Handle(Prs3d_Presentation)& thePrs);
171
172 protected: //! @name presentation fields
173
174   Handle(Graphic3d_Texture2Dmanual)  myTexture;
175   Handle(Graphic3d_AspectFillArea3d) myAspect;
176
177 protected: //! @name texture source fields
178
179   Handle(Image_PixMap)               myTexturePixMap;
180   TCollection_AsciiString            myTextureFile;
181   Graphic3d_NameOfTexture2D          myPredefTexture;
182
183 protected: //! @name texture mapping properties
184
185   Standard_Boolean                   myToMapTexture;
186   Standard_Boolean                   myModulate;
187   gp_Pnt2d                           myUVOrigin;
188   Standard_Boolean                   myIsCustomOrigin;
189   gp_Pnt2d                           myUVRepeat;
190   Standard_Boolean                   myToRepeat;
191   gp_Pnt2d                           myUVScale;
192   Standard_Boolean                   myToScale;
193   Standard_Boolean                   myToShowTriangles;
194
195 public:
196
197   DEFINE_STANDARD_RTTI (AIS_TexturedShape)
198
199 };
200
201 DEFINE_STANDARD_HANDLE (AIS_TexturedShape, AIS_Shape)
202
203 #endif // _AIS_TexturedShape_HeaderFile