openscenegraph
Vec3ub
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_VEC3UB
15#define OSG_VEC3UB 1
16
17namespace osg {
18
19/** General purpose float triple.
20 * Uses include representation of color coordinates.
21 * No support yet added for float * Vec3ub - is it necessary?
22 * Need to define a non-member non-friend operator* etc.
23 * Vec3ub * float is okay
24*/
25class Vec3ub
26{
27 public:
28
29 /** Data type of vector components.*/
30 typedef unsigned char value_type;
31
32 /** Number of vector components. */
33 enum { num_components = 3 };
34
35 value_type _v[3];
36
37 /** Constructor that sets all components of the vector to zero */
38 Vec3ub() { _v[0]=0; _v[1]=0; _v[2]=0; }
39
40 Vec3ub(value_type r, value_type g, value_type b) { _v[0]=r; _v[1]=g; _v[2]=b; }
41
42 inline bool operator == (const Vec3ub& v) const { return _v[0]==v._v[0] && _v[1]==v._v[1] && _v[2]==v._v[2]; }
43
44 inline bool operator != (const Vec3ub& v) const { return _v[0]!=v._v[0] || _v[1]!=v._v[1] || _v[2]!=v._v[2]; }
45
46 inline bool operator < (const Vec3ub& v) const
47 {
48 if (_v[0]<v._v[0]) return true;
49 else if (_v[0]>v._v[0]) return false;
50 else if (_v[1]<v._v[1]) return true;
51 else if (_v[1]>v._v[1]) return false;
52 else return (_v[2]<v._v[2]);
53 }
54
55 inline value_type* ptr() { return _v; }
56 inline const value_type* ptr() const { return _v; }
57
58 inline void set(value_type r, value_type g, value_type b)
59 {
60 _v[0]=r; _v[1]=g; _v[2]=b;
61 }
62
63 inline void set( const Vec3ub& rhs)
64 {
65 _v[0]=rhs._v[0]; _v[1]=rhs._v[1]; _v[2]=rhs._v[2];
66 }
67
68 inline value_type& operator [] (unsigned int i) { return _v[i]; }
69 inline value_type operator [] (unsigned int i) const { return _v[i]; }
70
71 inline value_type& x() { return _v[0]; }
72 inline value_type& y() { return _v[1]; }
73 inline value_type& z() { return _v[2]; }
74
75 inline value_type x() const { return _v[0]; }
76 inline value_type y() const { return _v[1]; }
77 inline value_type z() const { return _v[2]; }
78
79 inline value_type& r() { return _v[0]; }
80 inline value_type& g() { return _v[1]; }
81 inline value_type& b() { return _v[2]; }
82
83 inline value_type r() const { return _v[0]; }
84 inline value_type g() const { return _v[1]; }
85 inline value_type b() const { return _v[2]; }
86
87 /** Multiply by scalar. */
88 inline Vec3ub operator * (float rhs) const
89 {
90 Vec3ub col(*this);
91 col *= rhs;
92 return col;
93 }
94
95 /** Unary multiply by scalar. */
96 inline Vec3ub& operator *= (float rhs)
97 {
98 _v[0]=(value_type)((float)_v[0]*rhs);
99 _v[1]=(value_type)((float)_v[1]*rhs);
100 _v[2]=(value_type)((float)_v[2]*rhs);
101 return *this;
102 }
103
104 /** Divide by scalar. */
105 inline Vec3ub operator / (float rhs) const
106 {
107 Vec3ub col(*this);
108 col /= rhs;
109 return col;
110 }
111
112 /** Unary divide by scalar. */
113 inline Vec3ub& operator /= (float rhs)
114 {
115 float div = 1.0f/rhs;
116 *this *= div;
117 return *this;
118 }
119
120 /** Binary vector add. */
121 inline Vec3ub operator + (const Vec3ub& rhs) const
122 {
123 return Vec3ub(_v[0]+rhs._v[0], _v[1]+rhs._v[1],
124 _v[2]+rhs._v[2]);
125 }
126
127 /** Unary vector add. Slightly more efficient because no temporary
128 * intermediate object.
129 */
130 inline Vec3ub& operator += (const Vec3ub& rhs)
131 {
132 _v[0] += rhs._v[0];
133 _v[1] += rhs._v[1];
134 _v[2] += rhs._v[2];
135 return *this;
136 }
137
138 /** Binary vector subtract. */
139 inline Vec3ub operator - (const Vec3ub& rhs) const
140 {
141 return Vec3ub(_v[0]-rhs._v[0], _v[1]-rhs._v[1],
142 _v[2]-rhs._v[2]);
143 }
144
145 /** Unary vector subtract. */
146 inline Vec3ub& operator -= (const Vec3ub& rhs)
147 {
148 _v[0]-=rhs._v[0];
149 _v[1]-=rhs._v[1];
150 _v[2]-=rhs._v[2];
151 return *this;
152 }
153
154}; // end of class Vec3ub
155
156/** multiply by vector components. */
157inline Vec3ub componentMultiply(const Vec3ub& lhs, const Vec3ub& rhs)
158{
159 return Vec3ub(lhs[0]*rhs[0], lhs[1]*rhs[1], lhs[2]*rhs[2]);
160}
161
162/** divide rhs components by rhs vector components. */
163inline Vec3ub componentDivide(const Vec3ub& lhs, const Vec3ub& rhs)
164{
165 return Vec3ub(lhs[0]/rhs[0], lhs[1]/rhs[1], lhs[2]/rhs[2]);
166}
167
168} // end of namespace osg
169
170#endif