2004-02-10 02:11:28 +01:00
/****************************************************************************
* VCGLib o o *
* Visual and Computer Graphics Library o o *
* _ O _ *
* Copyright ( C ) 2004 \ / ) \ / *
* Visual Computing Lab / \ / | *
* ISTI - Italian National Research Council | *
* \ *
* All rights reserved . *
* *
* This program is free software ; you can redistribute it and / or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation ; either version 2 of the License , or *
* ( at your option ) any later version . *
* *
* This program is distributed in the hope that it will be useful , *
* but WITHOUT ANY WARRANTY ; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the *
* GNU General Public License ( http : //www.gnu.org/licenses/gpl.txt) *
* for more details . *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/****************************************************************************
History
$ Log : not supported by cvs2svn $
2005-06-24 14:21:48 +02:00
Revision 1.12 2005 / 04 / 14 11 : 35 : 09 ponchio
* * * empty log message * * *
2005-04-14 13:35:09 +02:00
Revision 1.11 2004 / 09 / 09 12 : 51 : 28 fasano
corrected ColorRamp code ( template specialization )
2004-09-09 14:51:28 +02:00
Revision 1.10 2004 / 09 / 09 08 : 39 : 33 cignoni
added a ' template < > ' to the specialized constructors from a enum
2004-09-09 10:39:33 +02:00
Revision 1.9 2004 / 09 / 03 13 : 58 : 48 fasano
Corretto errore sintattico nelle specializzazioni parziali ( float e char ) di due costruttori di Color4
2004-09-03 15:58:48 +02:00
Revision 1.8 2004 / 07 / 15 11 : 01 : 43 ganovelli
added inclusion of point3 . h
2004-07-15 13:01:43 +02:00
Revision 1.7 2004 / 06 / 24 07 : 55 : 50 cignoni
Now color ramp can do reverse color ramp
2004-06-24 09:55:50 +02:00
Revision 1.6 2004 / 05 / 26 15 : 10 : 29 cignoni
Corrected bug in setgrayshade
2004-05-26 17:10:29 +02:00
Revision 1.5 2004 / 05 / 07 12 : 46 : 55 cignoni
added ifdef for gcc [ Bug c + + / 14479 ]
2004-05-07 14:46:55 +02:00
Revision 1.4 2004 / 05 / 07 10 : 06 : 55 cignoni
Corrected template specialization syntax for gcc compiling
2004-05-07 12:06:55 +02:00
Revision 1.3 2004 / 03 / 10 21 : 38 : 40 cignoni
Written some documentation and added to the space module
2004-03-10 22:38:40 +01:00
Revision 1.2 2004 / 03 / 10 00 : 35 : 01 cignoni
Removed a wrong ( ? ) copy constructor
2004-03-10 01:35:01 +01:00
Revision 1.1 2004 / 02 / 10 01 : 11 : 28 cignoni
Edited Comments and GPL license
2004-02-10 02:11:28 +01:00
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# ifndef __VCGLIB_COLOR4
# define __VCGLIB_COLOR4
2004-07-15 13:01:43 +02:00
# include <vcg/space/point3.h>
2004-02-10 02:11:28 +01:00
# include <vcg/space/point4.h>
namespace vcg {
2004-03-10 22:38:40 +01:00
/** \addtogroup space */
/*@{*/
/**
The templated class for representing 4 entity color .
The class is templated over the ScalarType . class that is used to represent color with float or with unsigned chars . All the usual
operator overloading ( * + - . . . ) is present .
*/
2004-02-10 02:11:28 +01:00
template < class T >
class Color4 : public Point4 < T >
{
public :
/// Constant for storing standard colors.
/// Each color is stored in a simple in so that the bit pattern match with the one of Color4b.
enum ColorConstant {
Black = 0xff000000 ,
Gray = 0xff808080 ,
White = 0xffffffff ,
Red = 0xff0000ff ,
Green = 0xff00ff00 ,
Blue = 0xffff0000 ,
Cyan = 0xffffff00 ,
Yellow = 0xff00ffff ,
Magenta = 0xffff00ff ,
LightGray = 0xffc0c0c0 ,
LightRed = 0xff8080ff ,
LightGreen = 0xff80ff80 ,
LightBlue = 0xffff8080 ,
DarkGray = 0xff404040 ,
DarkRed = 0xff000040 ,
DarkGreen = 0xff004000 ,
2004-05-07 12:06:55 +02:00
DarkBlue = 0xff400000
2004-02-10 02:11:28 +01:00
} ;
inline Color4 ( const T nx , const T ny , const T nz , const T nw ) : Point4 < T > ( nx , ny , nz , nw ) { } ;
2004-03-10 01:35:01 +01:00
// inline Color4 ( Color4 &c) :Point4<T>(c) {};
2004-02-10 02:11:28 +01:00
inline Color4 ( ) { } ;
inline Color4 ( ColorConstant cc ) ;
2004-03-10 01:35:01 +01:00
template < class Q >
2004-02-10 02:11:28 +01:00
inline void Import ( const Color4 < Q > & b )
{
2005-04-14 13:35:09 +02:00
Point4 < T > : : _v [ 0 ] = T ( b [ 0 ] ) ;
Point4 < T > : : _v [ 1 ] = T ( b [ 1 ] ) ;
Point4 < T > : : _v [ 2 ] = T ( b [ 2 ] ) ;
Point4 < T > : : _v [ 3 ] = T ( b [ 3 ] ) ;
2004-02-10 02:11:28 +01:00
}
2004-05-07 12:06:55 +02:00
//inline void Import(const Color4<float> &b);
//inline void Import(const Color4<unsigned char> &b);
2004-02-10 02:11:28 +01:00
inline void lerp ( const Color4 & c0 , const Color4 & c1 , const float x ) ;
inline void lerp ( const Color4 & c0 , const Color4 & c1 , const Color4 & c2 , const Point3f & ip ) ;
2004-06-24 09:55:50 +02:00
/// given a float and a range set the corresponding color in the well known red->green->blue color ramp. To reverse the direction of the ramp just swap minf and maxf.
2004-02-10 02:11:28 +01:00
inline void ColorRamp ( const float & minf , const float & maxf , float v ) ;
inline void SetRGB ( unsigned char r , unsigned char g , unsigned char b )
{
2005-04-14 13:35:09 +02:00
Point4 < T > : : _v [ 0 ] = r ;
Point4 < T > : : _v [ 1 ] = g ;
Point4 < T > : : _v [ 2 ] = b ;
Point4 < T > : : _v [ 3 ] = 0 ;
2004-02-10 02:11:28 +01:00
}
void SetHSVColor ( float h , float s , float v ) {
float r , g , b ;
if ( s = = 0.0 ) { // gray color
r = g = b = v ;
2005-04-14 13:35:09 +02:00
Point4 < T > : : _v [ 0 ] = ( unsigned char ) ( 255 * r ) ;
Point4 < T > : : _v [ 1 ] = ( unsigned char ) ( 255 * g ) ;
Point4 < T > : : _v [ 2 ] = ( unsigned char ) ( 255 * b ) ;
Point4 < T > : : _v [ 3 ] = 255 ;
2004-02-10 02:11:28 +01:00
return ;
}
if ( h = = 1.0 ) h = 0.0 ;
int i = int ( floor ( h * 6.0 ) ) ;
float f = float ( h * 6.0f - floor ( h * 6.0f ) ) ;
float p = v * ( 1.0f - s ) ;
float q = v * ( 1.0f - s * f ) ;
float t = v * ( 1.0f - s * ( 1.0f - f ) ) ;
switch ( i ) {
case 0 : r = v ; g = t ; b = p ; break ;
case 1 : r = q ; g = v ; b = p ; break ;
case 2 : r = p ; g = v ; b = t ; break ;
case 3 : r = p ; g = q ; b = v ; break ;
case 4 : r = t ; g = p ; b = v ; break ;
case 5 : r = v ; g = p ; b = q ; break ;
}
2005-04-14 13:35:09 +02:00
Point4 < T > : : _v [ 0 ] = ( unsigned char ) ( 255 * r ) ;
Point4 < T > : : _v [ 1 ] = ( unsigned char ) ( 255 * g ) ;
Point4 < T > : : _v [ 2 ] = ( unsigned char ) ( 255 * b ) ;
Point4 < T > : : _v [ 3 ] = 255 ;
2004-02-10 02:11:28 +01:00
// _v[0]=r*256;_v[1]=g*256;_v[2]=b*256;
}
inline static Color4 GrayShade ( float f )
{
2004-05-26 17:10:29 +02:00
return Color4 ( f , f , f , 1 ) ;
2004-02-10 02:11:28 +01:00
}
inline void SetGrayShade ( float f )
{
2004-05-26 17:10:29 +02:00
Import ( Color4 < float > ( f , f , f , 1 ) ) ;
2004-02-10 02:11:28 +01:00
}
2004-03-10 22:38:40 +01:00
/** Given an integer returns a well ordering of colors
2004-02-10 02:11:28 +01:00
// so that every color differs as much as possible form the previous one
// params:
// n is the maximum expected value (max of the range)
// v is the requested position
2004-03-10 22:38:40 +01:00
*/
2004-02-10 02:11:28 +01:00
inline static Color4 Scatter ( int n , int a , float Sat = .3f , float Val = .9f )
{
int b , k , m = n ;
int r = n ;
for ( b = 0 , k = 1 ; k < n ; k < < = 1 )
if ( a < < 1 > = m ) {
if ( b = = 0 ) r = k ;
b + = k ;
a - = ( m + 1 ) > > 1 ;
m > > = 1 ;
}
else m = ( m + 1 ) > > 1 ;
if ( r > n - b ) r = n - b ;
//TRACE("Scatter range 0..%i, in %i out %i\n",n,a,b);
Color4 rc ;
rc . SetHSVColor ( float ( b ) / float ( n ) , Sat , Val ) ;
return rc ;
}
} ;
template < class T >
inline void Color4 < T > : : lerp ( const Color4 < T > & c0 , const Color4 < T > & c1 , const float x )
{
assert ( x > = 0 ) ;
assert ( x < = 1 ) ;
2005-04-14 13:35:09 +02:00
Point4 < T > : : _v [ 0 ] = ( T ) ( c1 . _v [ 0 ] * x + c0 . _v [ 0 ] * ( 1.0f - x ) ) ;
Point4 < T > : : _v [ 1 ] = ( T ) ( c1 . _v [ 1 ] * x + c0 . _v [ 1 ] * ( 1.0f - x ) ) ;
Point4 < T > : : _v [ 2 ] = ( T ) ( c1 . _v [ 2 ] * x + c0 . _v [ 2 ] * ( 1.0f - x ) ) ;
Point4 < T > : : _v [ 3 ] = ( T ) ( c1 . _v [ 3 ] * x + c0 . _v [ 3 ] * ( 1.0f - x ) ) ;
2004-02-10 02:11:28 +01:00
}
template < class T >
inline void Color4 < T > : : lerp ( const Color4 < T > & c0 , const Color4 < T > & c1 , const Color4 < T > & c2 , const Point3f & ip )
{
assert ( fabs ( ip [ 0 ] + ip [ 1 ] + ip [ 2 ] - 1 ) < 0.00001 ) ;
2005-06-24 14:21:48 +02:00
Point4 < T > : : _v [ 0 ] = ( T ) ( c0 [ 0 ] * ip [ 0 ] + c1 [ 0 ] * ip [ 1 ] + c2 [ 0 ] * ip [ 2 ] ) ;
Point4 < T > : : _v [ 1 ] = ( T ) ( c0 [ 1 ] * ip [ 0 ] + c1 [ 1 ] * ip [ 1 ] + c2 [ 1 ] * ip [ 2 ] ) ;
Point4 < T > : : _v [ 2 ] = ( T ) ( c0 [ 2 ] * ip [ 0 ] + c1 [ 2 ] * ip [ 1 ] + c2 [ 2 ] * ip [ 2 ] ) ;
Point4 < T > : : _v [ 3 ] = ( T ) ( c0 [ 3 ] * ip [ 0 ] + c1 [ 3 ] * ip [ 1 ] + c2 [ 3 ] * ip [ 2 ] ) ;
2004-02-10 02:11:28 +01:00
}
template < class T >
inline void Color4 < T > : : ColorRamp ( const float & minf , const float & maxf , float v )
{
2004-06-24 09:55:50 +02:00
if ( minf > maxf ) { ColorRamp ( maxf , minf , maxf + ( minf - v ) ) ; return ; }
2004-09-09 14:51:28 +02:00
if ( v < minf ) { * this = Color4 < T > ( Color4 < T > : : Red ) ; return ; }
2004-02-10 02:11:28 +01:00
float step = ( maxf - minf ) / 4 ;
v - = minf ;
2004-09-09 14:51:28 +02:00
if ( v < step ) { lerp ( Color4 < T > ( Color4 < T > : : Red ) , Color4 < T > ( Color4 < T > : : Yellow ) , v / step ) ; return ; }
2004-02-10 02:11:28 +01:00
v - = step ;
2004-09-09 14:51:28 +02:00
if ( v < step ) { lerp ( Color4 < T > ( Color4 < T > : : Yellow ) , Color4 < T > ( Color4 < T > : : Green ) , v / step ) ; return ; }
2004-02-10 02:11:28 +01:00
v - = step ;
2004-09-09 14:51:28 +02:00
if ( v < step ) { lerp ( Color4 < T > ( Color4 < T > : : Green ) , Color4 < T > ( Color4 < T > : : Cyan ) , v / step ) ; return ; }
2004-02-10 02:11:28 +01:00
v - = step ;
2004-09-09 14:51:28 +02:00
if ( v < step ) { lerp ( Color4 < T > ( Color4 < T > : : Cyan ) , Color4 < T > ( Color4 < T > : : Blue ) , v / step ) ; return ; }
2004-02-10 02:11:28 +01:00
2004-09-09 14:51:28 +02:00
* this = Color4 < T > ( Color4 < T > : : Blue ) ;
2004-02-10 02:11:28 +01:00
}
2004-05-07 14:46:55 +02:00
# if !defined(__GNUC__)
2004-05-07 12:06:55 +02:00
template < >
2004-05-07 14:46:55 +02:00
# endif
template < >
2004-02-10 02:11:28 +01:00
inline void Color4 < float > : : Import ( const Color4 < unsigned char > & b )
{
2005-04-14 13:35:09 +02:00
this - > _v [ 0 ] = b [ 0 ] / 255.0f ;
this - > _v [ 1 ] = b [ 1 ] / 255.0f ;
this - > _v [ 2 ] = b [ 2 ] / 255.0f ;
this - > _v [ 3 ] = b [ 3 ] / 255.0f ;
2004-02-10 02:11:28 +01:00
}
2004-05-07 14:46:55 +02:00
# if !defined(__GNUC__)
template < > // [Bug c++/14479] enum definition in template class with template methods causes error.
# endif
2004-05-07 12:06:55 +02:00
template < >
2004-02-10 02:11:28 +01:00
inline void Color4 < unsigned char > : : Import ( const Color4 < float > & b )
{
2005-04-14 13:35:09 +02:00
this - > _v [ 0 ] = ( unsigned char ) ( b [ 0 ] * 255.0f ) ;
this - > _v [ 1 ] = ( unsigned char ) ( b [ 1 ] * 255.0f ) ;
this - > _v [ 2 ] = ( unsigned char ) ( b [ 2 ] * 255.0f ) ;
this - > _v [ 3 ] = ( unsigned char ) ( b [ 3 ] * 255.0f ) ;
2004-02-10 02:11:28 +01:00
}
//template <class T,class S>
//inline void Color4<T>::Import(const Color4<S> &b)
//{
// _v[0] = T(b[0]);
// _v[1] = T(b[1]);
// _v[2] = T(b[2]);
// _v[3] = T(b[3]);
//}
//
2004-09-09 10:39:33 +02:00
template < >
2004-09-03 15:58:48 +02:00
inline Color4 < unsigned char > : : Color4 ( Color4 < unsigned char > : : ColorConstant cc )
2004-02-10 02:11:28 +01:00
{
* ( ( int * ) this ) = cc ;
}
2004-09-09 10:39:33 +02:00
template < >
2004-09-03 15:58:48 +02:00
inline Color4 < float > : : Color4 ( Color4 < float > : : ColorConstant cc )
2004-02-10 02:11:28 +01:00
{
Import ( Color4 < unsigned char > ( ( Color4 < unsigned char > : : ColorConstant ) cc ) ) ;
}
typedef Color4 < unsigned char > Color4b ;
typedef Color4 < float > Color4f ;
2004-03-10 22:38:40 +01:00
/*@}*/
2004-02-10 02:11:28 +01:00
} // end of NameSpace
2004-03-10 01:35:01 +01:00
# endif