cvrColors.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */



/**
 * \file   cvrColors.h
 *         This file contains some more symbolic color definitions,
 *         like orange, pink, red, green, blue, etc.
 * \author Jochen Wickel
 * \date   12.11.01
 *
 * $Id: cvrColors.h,v 1.5 2007/04/16 16:36:30 alvarado Exp $
 */

#ifndef _CVR_COLORS_H_
#define _CVR_COLORS_H_

#include "cvrRGBAPixel.h"
#include "cvrMath.h"

namespace cvr {

  /**
   * @name Color Constants.
   *
   * These color constants are defined in the file cvrColors.h.
   *
   * Note that the color names are all own
   * creations, they are not correlated to any official naming
   * standards at all.
   */
  //@{

  // primary and secondary color constants

  /**
   * Constant for the color black.
   */
  static const rgbaPixel Black(0,0,0);

  /**
   * Constant for the color read.
   */
  static const rgbaPixel Red(255,0,0);

  /**
   * Constant for the color green.
   */
  static const rgbaPixel Green(0,255,0);

  /**
   * Constant for the color blue.
   */
  static const rgbaPixel Blue(0,0,255);

  /**
   * Constant for the color yellow.
   */
  static const rgbaPixel Yellow(255,255,0);

  /**
   * Constant for the color magenta.
   */
  static const rgbaPixel Magenta(255,0,255);

  /**
   * Constant for the color cyan.
   */
  static const rgbaPixel Cyan(0,255,255);

  /**
   * Constant for the color white.
   */
  static const rgbaPixel White(255,255,255);

  // darker primary colors

  /**
   * Constant for dark red
   */
  static const rgbaPixel DarkRed(127,0,0);

  /**
   * Constant for dark green
   */
  static const rgbaPixel DarkGreen(0,127,0);

  /**
   * Constant for dark blue
   */
  static const rgbaPixel DarkBlue(0,0,127);

  // darker secondary colors

  /**
   * constant for the color dark yellow
   */
  static const rgbaPixel DarkYellow(127,127,0);

  /**
   * constant for some kind of dark cyan.
   */
  static const rgbaPixel DarkCyan(0,127,127);

  /**
   * constant for some kind of dark magenta.
   */
  static const rgbaPixel DarkMagenta(127,0,127);

  // brighter primary colors

  /**
   * constant for a kind of bright green.
   */
  static const rgbaPixel BrightGreen(0,255,127);

  /**
   * constant for a kind of bright green.
   */
  static const rgbaPixel BrightBlue(0,127,255);

  /**
   * constant for a kind of bright red.
   */
  static const rgbaPixel BrightRed(255,127,64);

  // brighter secondary colors

  /**
   * constant for some kind of bright magenta.
   */
  static const rgbaPixel BrightMagenta(255,127,255);

  /**
   * constant for some kind of bright yellow.
   */
  static const rgbaPixel BrightYellow(255,255,127);

  /**
   * constant for some kind of bright cyan.
   */
  static const rgbaPixel BrightCyan(127,255,255);


  // other colors

  /**
   * constant for the color orange.
   */
  static const rgbaPixel DarkOrange(192,64,0);

  /**
   * constant for the color fusia.
   */
  static const rgbaPixel Fusia(255,0,127);

  /**
   * constant for the color pink.
   */
  static const rgbaPixel Pink(255,127,127);

  /**
   * constant for another kind of bright green.
   */
  static const rgbaPixel LawnGreen(127,255,0);

  /**
   * constant for some kind of lemon color
   */
  static const rgbaPixel Lemon(127,255,127);

  /**
   * constant for a light blue.
   */
  static const rgbaPixel LightBlue(0,127,255);

  /**
   * constant for a light blue.
   */
  static const rgbaPixel DarkViolet(127,0,255);

  /**
   * constant for the color violet.
   */
  static const rgbaPixel Violet(127,127,255);

  /**
   * Function for scaling a color's intensity.
   * @param src rgbaPixel of the original color
   * @param f factor by which to multiply the R, G and B values. Warning:
   * Saturation effects might lead to strange results.
   * @return rgbaPixel where R, G and B have the given value <code>t</code>.
   */
  inline rgbaPixel scale(const rgbaPixel& src, double f) {
    return rgbaPixel(static_cast<ubyte>(within(src.getRed() *f,0.0,255.0)),
                     static_cast<ubyte>(within(src.getGreen()*f,0.0,255.0)),
                     static_cast<ubyte>(within(src.getBlue() *f,0.0,255.0)));
  }

  /**
   * Function for darkening a color.
   * @param src rgbaPixel of the original color
   * @param f factor which tells how much darker the new color should be.
   * Example: 0.2 means: Make the color 20% darker. 0 means:
   * leave the original, 1.0 means: make it black
   * @return rgbaPixel where R, G and B have the given value <code>t</code>.
   */
  inline rgbaPixel darker(const rgbaPixel& src, double f=0.5) {
    return scale(src,(1.0-f));
  }

  /**
   * Function for brightening a color.
   * @param src rgbaPixel of the original color
   * @param f factor which tells how much darker the new color should be.
   * Example: 0.2 means: Make the color 20% brighter. 0 means:
   * leave the original, 1.0 means: make it twice as bright. Warning:
   * Saturation effects might lead to strange results.
   * @return rgbaPixel where R, G and B have the given value <code>t</code>.
   */
  inline rgbaPixel brighter(const rgbaPixel& src, double f=0.5) {
    return scale(src,(1.0+f));
  }


  /**
   * function for returning a grey value.
   * @param t grey value must be between 0 and 255
   * @return rgbaPixel where R, G and B have the given value <code>t</code>.
   */
  inline rgbaPixel grey(int t) {
    return rgbaPixel(t,t,t);
  }

  /**
   * function for returning a gray value.
   * @param t grey value must be between 0 and 255
   * @return rgbaPixel where R, G and B have the given value <code>t</code>.
   */
  inline rgbaPixel gray(int t) {
    return rgbaPixel(t,t,t);
  }

  /**
   * function for returning a grey value.
   * @param t grey value must be between 0 and 1
   * @return rgbaPixel where R, G and B have the given value <code>t*255</code>.
   */
  inline rgbaPixel grey(double t) {
    return rgbaPixel(int(t*255),int(t*255),int(t*255.0));
  }

  /**
   * function for returning a gray value.
   * @param t grey value must be between 0 and 1
   * @return rgbaPixel where R, G and B have the given value <code>t*255</code>.
   */
  inline rgbaPixel gray(double t) {
    return rgbaPixel(int(t*255),int(t*255),int(t*255.0));
  }

  /**
   * Definition for a 100% bright grey, i.e. White
   */
  static const rgbaPixel Grey100(255,255,255);

  /**
   * Definition for a 75% bright grey, i.e. bright grey
   */
  static const rgbaPixel Grey75(191,191,191);

  /**
   * Definition for a 50% bright grey, i.e. medium grey
   */
  static const rgbaPixel Grey50(127,127,127);

  /**
   * Definition for a 25% bright grey, i.e. dark grey
   */
  static const rgbaPixel Grey25(63,63,63);

  /**
   * Definition for a 0% bright grey, i.e. Black
   */
  static const rgbaPixel Grey0(0,0,0);

}

#endif