color.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1999 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: gdbColor.h,v $ $Revision: 1.9 $ $State: Exp $
*********************************************************************/
#ifndef color_H_
#define color_H_

// \file gdbColor.h
// \brief Contains the DtColor class declaration.

#include "geometry/geometryDefines.h"
#include <stdio.h>
#include <iostream>
#include <vlutil/vlString.h>
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlUtil.h>


//
// DtColor represents a color assigned to a polygon, or
// pixel element.
class DT_DLL_geometry DtColor
{
public:
   // default constructor
   DtColor();

   // additional constructor
   DtColor(DtU8 red, DtU8 green, DtU8 blue, DtU8 alpha);

   // destructor
   virtual ~DtColor();

   // copy constructor
   DtColor(const DtColor& orig);

   // assignment operator
   DtColor& operator=(const DtColor& orig);

   // set specified colors -- mutator function
   virtual void setColors(DtU8 red, DtU8 green, DtU8 blue, DtU8 alpha);

   // accessor functions
   virtual DtU8 red() const;
   virtual DtU8 green() const;
   virtual DtU8 blue() const;
   virtual DtU8 alpha() const;

   // comparison function
   virtual int operator==(const DtColor& other)const;

   // help function for debugging
   virtual void dump() const;

   // input/output functions
   virtual bool readFrom(FILE* fp);
   virtual bool writeTo(FILE* fp);

#ifndef NO_VRLINK
   virtual DtString string() const;
#endif

protected:

   DtU8 myRed;   
   DtU8 myGreen;
   DtU8 myBlue;
   DtU8 myAlpha;

};

inline DtU8 DtColor::red() const
{
   return myRed;
}

inline DtU8 DtColor::green() const
{
   return myGreen;
}

inline DtU8 DtColor::blue() const
{
   return myBlue;
}

inline DtU8 DtColor::alpha() const
{
   return myAlpha;
}

DT_DLL_geometry std::ostream& operator<<(std::ostream& os, const DtColor& color);
DT_DLL_geometry std::istream& operator>>(std::istream& is, DtColor& color);

#endif