openscenegraph
TexMat
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_TEXMAT
15#define OSG_TEXMAT 1
16
17#include <osg/StateAttribute>
18#include <osg/Matrix>
19
20namespace osg {
21
22/** A texture matrix state class that encapsulates OpenGL texture matrix
23 * functionality. */
24class OSG_EXPORT TexMat : public StateAttribute
25{
26 public :
27
28 TexMat();
29
30 TexMat(const Matrix& matrix):_matrix(matrix),_scaleByTextureRectangleSize(false) {}
31
32 /** Copy constructor using CopyOp to manage deep vs shallow copy. */
33 TexMat(const TexMat& texmat,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
34 StateAttribute(texmat,copyop),
35 _matrix(texmat._matrix),
36 _scaleByTextureRectangleSize(texmat._scaleByTextureRectangleSize) {}
37
38 META_StateAttribute(osg, TexMat, TEXMAT);
39
40 virtual bool isTextureAttribute() const { return true; }
41
42 /** Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. */
43 virtual int compare(const StateAttribute& sa) const
44 {
45 // Check for equal types, then create the rhs variable
46 // used by the COMPARE_StateAttribute_Parameter macros below.
47 COMPARE_StateAttribute_Types(TexMat,sa)
48
49 // Compare each parameter in turn against the rhs.
50 COMPARE_StateAttribute_Parameter(_matrix)
51
52 return 0; // Passed all the above comparison macros, so must be equal.
53 }
54
55 /** Set the texture matrix */
56 inline void setMatrix(const Matrix& matrix) { _matrix = matrix; }
57
58 /** Get the texture matrix */
59 inline Matrix& getMatrix() { return _matrix; }
60
61 /** Get the const texture matrix */
62 inline const Matrix& getMatrix() const { return _matrix; }
63
64 /** Switch on/off the post scaling of the TexMat matrix by the size of the last applied texture rectangle.
65 * Use a TexMat alongside a TextureRectangle with this scaling applied allows one to treat a TextureRectnagles texture coordinate
66 * range as if it were the usual non dimensional 0.0 to 1.0 range.
67 * Note, the TexMat matrix itself is not modified by the post scaling, its purely an operation passed to OpenGL to do the post scaling once the
68 * the TexMat matrix has been loaded.*/
69 void setScaleByTextureRectangleSize(bool flag) { _scaleByTextureRectangleSize = flag; }
70
71 /** Get whether the post scaling of the TexMat matrix, by the size of the last applied texture rectangle, is switched on/off.*/
72 bool getScaleByTextureRectangleSize() const { return _scaleByTextureRectangleSize; }
73
74 /** Apply texture matrix to OpenGL state. */
75 virtual void apply(State& state) const;
76
77 protected:
78
79 virtual ~TexMat( void );
80
81 Matrix _matrix;
82 bool _scaleByTextureRectangleSize;
83
84};
85
86}
87
88
89#endif