MezzanineEngine March 18, 2012

Mezzanine::ColourValue Class Reference

This is a simple class for holding 4 reals representing the colour any give object or lightsource can have. More...

#include <colourvalue.h>

List of all members.

Public Member Functions

 ColourValue (Real Red=1.0, Real Green=1.0, Real Blue=1.0, Real Alpha=1.0)
 4 Reals constructor.
 ColourValue (const Ogre::ColourValue &OgreValues)
 Ogre constructor.
 ColourValue (const ColourValue &OtherColour)
 Copy Constructor.
 ~ColourValue ()
 Class destructor.
Ogre::ColourValue GetOgreColourValue () const
 Creates and returns an Ogre ColourValue class with values equal to this one.
bool operator!= (const ColourValue &Colour)
 Inequality Comparison Operator.
void operator= (const ColourValue &OtherColour)
 Assignment operator.
bool operator== (const ColourValue &Colour)
 Equality Comparison Operator.
virtual void ProtoDeSerialize (const xml::Node &OneNode)
 Take the data stored in an XML and overwrite this instance of this object with it.
virtual void ProtoSerialize (xml::Node &CurrentRoot) const
 Convert this class to an xml::Node ready for serialization.

Static Public Member Functions

static ColourValue AliceBlue ()
 Creates a ColourValue representing the colour AliceBlue.
static ColourValue AntiqueWhite ()
 Creates a ColourValue representing the colour AntiqueWhite.
static ColourValue Aqua ()
 Creates a ColourValue representing the colour Aqua.
static ColourValue Aquamarine ()
 Creates a ColourValue representing the colour Aquamarine.
static ColourValue Azure ()
 Creates a ColourValue representing the colour Azure.
static ColourValue Beige ()
 Creates a ColourValue representing the colour Beige.
static ColourValue Bisque ()
 Creates a ColourValue representing the colour Bisque.
static ColourValue Black ()
 Creates a ColourValue representing the colour Black.
static ColourValue Blanchedalmond ()
 Creates a ColourValue representing the colour Blanchedalmond.
static ColourValue Blue ()
 Creates a ColourValue representing the colour Blue.
static ColourValue BlueViolet ()
 Creates a ColourValue representing the colour BlueViolet.
static ColourValue Brown ()
 Creates a ColourValue representing the colour Brown.
static ColourValue BurlyWood ()
 Creates a ColourValue representing the colour BurlyWood.
static ColourValue CadetBlue ()
 Creates a ColourValue representing the colour CadetBlue.
static ColourValue Chartreuse ()
 Creates a ColourValue representing the colour Chartreuse.
static ColourValue Chocolate ()
 Creates a ColourValue representing the colour Chocolate.
static ColourValue Coral ()
 Creates a ColourValue representing the colour Coral.
static ColourValue CornFlowerBlue ()
 Creates a ColourValue representing the colour CornFlowerBlue.
static ColourValue CornSilk ()
 Creates a ColourValue representing the colour CornSilk.
static ColourValue Crimson ()
 Creates a ColourValue representing the colour Crimson.
static ColourValue Cyan ()
 Creates a ColourValue representing the colour Cyan.
static ColourValue DarkBlue ()
 Creates a ColourValue representing the colour DarkBlue.
static ColourValue DarkCyan ()
 Creates a ColourValue representing the colour DarkCyan.
static ColourValue DarkGoldenRod ()
 Creates a ColourValue representing the colour DarkGoldenRod.
static ColourValue DarkGray ()
 Creates a ColourValue representing the colour DarkGray.
static ColourValue DarkGreen ()
 Creates a ColourValue representing the colour DarkGreen.
static ColourValue DarkKhaki ()
 Creates a ColourValue representing the colour DarkKhaki.
static ColourValue DarkMagenta ()
 Creates a ColourValue representing the colour DarkMagenta.
static ColourValue DarkOliveGreen ()
 Creates a ColourValue representing the colour DarkOliveGreen.
static ColourValue DarkOrange ()
 Creates a ColourValue representing the colour DarkOrange.
static ColourValue DarkOrchid ()
 Creates a ColourValue representing the colour DarkOrchid.
static ColourValue DarkRed ()
 Creates a ColourValue representing the colour DarkRed.
static ColourValue DarkSalmon ()
 Creates a ColourValue representing the colour DarkSalmon.
static ColourValue DarkSeaGreen ()
 Creates a ColourValue representing the colour DarkSeaGreen.
static ColourValue DarkSlateBlue ()
 Creates a ColourValue representing the colour DarkSlateBlue.
static ColourValue DarkSlateGray ()
 Creates a ColourValue representing the colour DarkSlateGray.
static ColourValue DarkTurquoise ()
 Creates a ColourValue representing the colour DarkTurquoise.
static ColourValue DarkViolet ()
 Creates a ColourValue representing the colour DarkViolet.
static ColourValue DeepPink ()
 Creates a ColourValue representing the colour DeepPink.
static ColourValue DeepSkyBlue ()
 Creates a ColourValue representing the colour DeepSkyBlue.
static ColourValue DimGray ()
 Creates a ColourValue representing the colour DimGray.
static ColourValue DodgerBlue ()
 Creates a ColourValue representing the colour DodgerBlue.
static ColourValue FireBrick ()
 Creates a ColourValue representing the colour FireBrick.
static ColourValue FloralWhite ()
 Creates a ColourValue representing the colour FloralWhite.
static ColourValue ForestGreen ()
 Creates a ColourValue representing the colour ForestGreen.
static ColourValue Fuchsia ()
 Creates a ColourValue representing the colour Fuchsia.
static ColourValue Gainsboro ()
 Creates a ColourValue representing the colour Gainsboro.
static ColourValue GhostWhite ()
 Creates a ColourValue representing the colour GhostWhite.
static ColourValue Gold ()
 Creates a ColourValue representing the colour Gold.
static ColourValue GoldenRod ()
 Creates a ColourValue representing the colour GoldenRod.
static ColourValue Gray ()
 Creates a ColourValue representing the colour Gray.
static ColourValue Green ()
 Creates a ColourValue representing the colour Green.
static ColourValue GreenYellow ()
 Creates a ColourValue representing the colour GreenYellow.
static ColourValue HoneyDew ()
 Creates a ColourValue representing the colour HoneyDew.
static ColourValue HotPink ()
 Creates a ColourValue representing the colour HotPink.
static ColourValue IndianRed ()
 Creates a ColourValue representing the colour IndianRed.
static ColourValue Indigo ()
 Creates a ColourValue representing the colour Indigo.
static ColourValue Ivory ()
 Creates a ColourValue representing the colour Ivory.
static ColourValue Khaki ()
 Creates a ColourValue representing the colour Khaki.
static ColourValue Lavender ()
 Creates a ColourValue representing the colour Lavender.
static ColourValue LavenderBlush ()
 Creates a ColourValue representing the colour LavenderBlush.
static ColourValue LawnGreen ()
 Creates a ColourValue representing the colour LawnGreen.
static ColourValue LemonChiffon ()
 Creates a ColourValue representing the colour LemonChiffon.
static ColourValue LightBlue ()
 Creates a ColourValue representing the colour LightBlue.
static ColourValue LightCoral ()
 Creates a ColourValue representing the colour LightCoral.
static ColourValue LightCyan ()
 Creates a ColourValue representing the colour LightCyan.
static ColourValue LightGoldenRodYellow ()
 Creates a ColourValue representing the colour LightGoldenRodYellow.
static ColourValue LightGray ()
 Creates a ColourValue representing the colour LightGray.
static ColourValue LightGreen ()
 Creates a ColourValue representing the colour LightGreen.
static ColourValue LightPink ()
 Creates a ColourValue representing the colour LightPink.
static ColourValue LightSalmon ()
 Creates a ColourValue representing the colour LightSalmon.
static ColourValue LightSeaGreen ()
 Creates a ColourValue representing the colour LightSeaGreen.
static ColourValue LightSkyBlue ()
 Creates a ColourValue representing the colour LightSkyBlue.
static ColourValue LightSlateGray ()
 Creates a ColourValue representing the colour LightSlateGray.
static ColourValue LightSteelBlue ()
 Creates a ColourValue representing the colour LightSteelBlue.
static ColourValue LightYellow ()
 Creates a ColourValue representing the colour LightYellow.
static ColourValue Lime ()
 Creates a ColourValue representing the colour Lime.
static ColourValue LimeGreen ()
 Creates a ColourValue representing the colour LimeGreen.
static ColourValue Linen ()
 Creates a ColourValue representing the colour Linen.
static ColourValue Magenta ()
 Creates a ColourValue representing the colour Magenta.
static ColourValue Maroon ()
 Creates a ColourValue representing the colour Maroon.
static ColourValue MediumAquamarine ()
 Creates a ColourValue representing the colour MediumAquamarine.
static ColourValue MediumBlue ()
 Creates a ColourValue representing the colour MediumBlue.
static ColourValue MediumOrchid ()
 Creates a ColourValue representing the colour MediumOrchid.
static ColourValue MediumPurple ()
 Creates a ColourValue representing the colour MediumPurple.
static ColourValue MediumSeaGreen ()
 Creates a ColourValue representing the colour MediumSeaGreen.
static ColourValue MediumSlateBlue ()
 Creates a ColourValue representing the colour MediumSlateBlue.
static ColourValue MediumSpringGreen ()
 Creates a ColourValue representing the colour MediumSpringGreen.
static ColourValue MediumTurquoise ()
 Creates a ColourValue representing the colour MediumTurquoise.
static ColourValue MediumVioletRed ()
 Creates a ColourValue representing the colour MediumVioletRed.
static ColourValue MidnightBlue ()
 Creates a ColourValue representing the colour MidnightBlue.
static ColourValue MintCream ()
 Creates a ColourValue representing the colour MintCream.
static ColourValue MistyRose ()
 Creates a ColourValue representing the colour MistyRose.
static ColourValue Moccasin ()
 Creates a ColourValue representing the colour Moccasin.
static ColourValue NavajoWhite ()
 Creates a ColourValue representing the colour NavajoWhite.
static ColourValue Navy ()
 Creates a ColourValue representing the colour Navy.
static ColourValue OldLace ()
 Creates a ColourValue representing the colour OldLace.
static ColourValue Olive ()
 Creates a ColourValue representing the colour Olive.
static ColourValue OliveDrab ()
 Creates a ColourValue representing the colour OliveDrab.
static ColourValue Orange ()
 Creates a ColourValue representing the colour Orange.
static ColourValue OrangeRed ()
 Creates a ColourValue representing the colour OrangeRed.
static ColourValue Orchid ()
 Creates a ColourValue representing the colour Orchid.
static ColourValue PaleGoldenRod ()
 Creates a ColourValue representing the colour PaleGoldenRod.
static ColourValue PaleGreen ()
 Creates a ColourValue representing the colour PaleGreen.
static ColourValue PaleTurquoise ()
 Creates a ColourValue representing the colour PaleTurquoise.
static ColourValue PaleVioletRed ()
 Creates a ColourValue representing the colour PaleVioletRed.
static ColourValue PapayaWhip ()
 Creates a ColourValue representing the colour PapayaWhip.
static ColourValue PeachPuff ()
 Creates a ColourValue representing the colour PeachPuff.
static ColourValue Peru ()
 Creates a ColourValue representing the colour Peru.
static ColourValue Pink ()
 Creates a ColourValue representing the colour Pink.
static ColourValue Plum ()
 Creates a ColourValue representing the colour Plum.
static ColourValue PowderBlue ()
 Creates a ColourValue representing the colour PowderBlue.
static ColourValue Purple ()
 Creates a ColourValue representing the colour Purple.
static ColourValue Red ()
 Creates a ColourValue representing the colour Red.
static ColourValue RosyBrown ()
 Creates a ColourValue representing the colour RosyBrown.
static ColourValue RoyalBlue ()
 Creates a ColourValue representing the colour RoyalBlue.
static ColourValue SaddleBrown ()
 Creates a ColourValue representing the colour SaddleBrown.
static ColourValue Salmon ()
 Creates a ColourValue representing the colour Salmon.
static ColourValue SandyBrown ()
 Creates a ColourValue representing the colour SandyBrown.
static ColourValue SeaGreen ()
 Creates a ColourValue representing the colour SeaGreen.
static ColourValue SeaShell ()
 Creates a ColourValue representing the colour SeaShell.
static String SerializableName ()
 Get the name of the the XML tag this class will leave behind as its instances are serialized.
static ColourValue Sienna ()
 Creates a ColourValue representing the colour Sienna.
static ColourValue Silver ()
 Creates a ColourValue representing the colour Silver.
static ColourValue SkyBlue ()
 Creates a ColourValue representing the colour SkyBlue.
static ColourValue SlateBlue ()
 Creates a ColourValue representing the colour SlateBlue.
static ColourValue SlateGray ()
 Creates a ColourValue representing the colour SlateGray.
static ColourValue Snow ()
 Creates a ColourValue representing the colour Snow.
static ColourValue SpringGreen ()
 Creates a ColourValue representing the colour SpringGreen.
static ColourValue SteelBlue ()
 Creates a ColourValue representing the colour SteelBlue.
static ColourValue Tan ()
 Creates a ColourValue representing the colour Tan.
static ColourValue Teal ()
 Creates a ColourValue representing the colour Teal.
static ColourValue Thistle ()
 Creates a ColourValue representing the colour Thistle.
static ColourValue Tomato ()
 Creates a ColourValue representing the colour Tomato.
static ColourValue Transparent ()
 Creates a ColourValue representing no colour.
static ColourValue Turquoise ()
 Creates a ColourValue representing the colour Turquoise.
static ColourValue Violet ()
 Creates a ColourValue representing the colour Violet.
static ColourValue Wheat ()
 Creates a ColourValue representing the colour Wheat.
static ColourValue White ()
 Creates a ColourValue representing the colour White.
static ColourValue WhiteSmoke ()
 Creates a ColourValue representing the colour WhiteSmoke.
static ColourValue Yellow ()
 Creates a ColourValue representing the colour Yellow.
static ColourValue YellowGreen ()
 Creates a ColourValue representing the colour YellowGreen.

Public Attributes

Real A
 Value from 0.0 to 1.0 representing the transparency of the colours. 1.0 is opaque and 0.0 is clear.
Real B
 Value from 0.0 to 1.0 representing the amount of blue present in the colour. 1.0 if very blue, 0.0 is no blue.
Real G
 Value from 0.0 to 1.0 representing the amount of green present in the colour. 1.0 if very green, 0.0 is no green.
Real R
 Value from 0.0 to 1.0 representing the amount of red present in the colour. 1.0 if very red, 0.0 is no red.

Detailed Description

This is a simple class for holding 4 reals representing the colour any give object or lightsource can have.

Definition at line 59 of file colourvalue.h.


Constructor & Destructor Documentation

Mezzanine::ColourValue::ColourValue ( Real  Red = 1.0,
Real  Green = 1.0,
Real  Blue = 1.0,
Real  Alpha = 1.0 
)

4 Reals constructor.

This constructor allows you to set any values, if unset, they default to 1.0.

Parameters:
RedReal representing the amount of red present in the colour.
GreenReal representing the amount of green present in the colour.
BlueReal representing the amount of blue present in the colour.
AlphaReal representing the transparency of the colours.

Definition at line 60 of file colourvalue.cpp.

Mezzanine::ColourValue::ColourValue ( const Ogre::ColourValue &  OgreValues)

Ogre constructor.

Internal use only. Constructs a colourvalue class from an ogre colourvalue.

Parameters:
OgreValuesThe Ogre ColourValue class to base this class on.

Definition at line 68 of file colourvalue.cpp.

Mezzanine::ColourValue::ColourValue ( const ColourValue OtherColour)

Copy Constructor.

Parameters:
OtherColour

Definition at line 76 of file colourvalue.cpp.


Member Function Documentation

ColourValue Mezzanine::ColourValue::AliceBlue ( ) [static]

Creates a ColourValue representing the colour AliceBlue.

Returns:
Returns the created ColourValue.

Definition at line 115 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::AntiqueWhite ( ) [static]

Creates a ColourValue representing the colour AntiqueWhite.

Returns:
Returns the created ColourValue.

Definition at line 118 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Aqua ( ) [static]

Creates a ColourValue representing the colour Aqua.

Returns:
Returns the created ColourValue.

Definition at line 121 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Aquamarine ( ) [static]

Creates a ColourValue representing the colour Aquamarine.

Returns:
Returns the created ColourValue.

Definition at line 124 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Azure ( ) [static]

Creates a ColourValue representing the colour Azure.

Returns:
Returns the created ColourValue.

Definition at line 127 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Beige ( ) [static]

Creates a ColourValue representing the colour Beige.

Returns:
Returns the created ColourValue.

Definition at line 130 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Bisque ( ) [static]

Creates a ColourValue representing the colour Bisque.

Returns:
Returns the created ColourValue.

Definition at line 133 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Black ( ) [static]

Creates a ColourValue representing the colour Black.

Returns:
Returns the created ColourValue.

Definition at line 136 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Blanchedalmond ( ) [static]

Creates a ColourValue representing the colour Blanchedalmond.

Returns:
Returns the created ColourValue.

Definition at line 139 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Blue ( ) [static]

Creates a ColourValue representing the colour Blue.

Returns:
Returns the created ColourValue.

Definition at line 142 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::BlueViolet ( ) [static]

Creates a ColourValue representing the colour BlueViolet.

Returns:
Returns the created ColourValue.

Definition at line 145 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Brown ( ) [static]

Creates a ColourValue representing the colour Brown.

Returns:
Returns the created ColourValue.

Definition at line 148 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::BurlyWood ( ) [static]

Creates a ColourValue representing the colour BurlyWood.

Returns:
Returns the created ColourValue.

Definition at line 151 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CadetBlue ( ) [static]

Creates a ColourValue representing the colour CadetBlue.

Returns:
Returns the created ColourValue.

Definition at line 154 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Chartreuse ( ) [static]

Creates a ColourValue representing the colour Chartreuse.

Returns:
Returns the created ColourValue.

Definition at line 157 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Chocolate ( ) [static]

Creates a ColourValue representing the colour Chocolate.

Returns:
Returns the created ColourValue.

Definition at line 160 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Coral ( ) [static]

Creates a ColourValue representing the colour Coral.

Returns:
Returns the created ColourValue.

Definition at line 163 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CornFlowerBlue ( ) [static]

Creates a ColourValue representing the colour CornFlowerBlue.

Returns:
Returns the created ColourValue.

Definition at line 166 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CornSilk ( ) [static]

Creates a ColourValue representing the colour CornSilk.

Returns:
Returns the created ColourValue.

Definition at line 169 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Crimson ( ) [static]

Creates a ColourValue representing the colour Crimson.

Returns:
Returns the created ColourValue.

Definition at line 172 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Cyan ( ) [static]

Creates a ColourValue representing the colour Cyan.

Returns:
Returns the created ColourValue.

Definition at line 175 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkBlue ( ) [static]

Creates a ColourValue representing the colour DarkBlue.

Returns:
Returns the created ColourValue.

Definition at line 178 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkCyan ( ) [static]

Creates a ColourValue representing the colour DarkCyan.

Returns:
Returns the created ColourValue.

Definition at line 181 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGoldenRod ( ) [static]

Creates a ColourValue representing the colour DarkGoldenRod.

Returns:
Returns the created ColourValue.

Definition at line 184 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGray ( ) [static]

Creates a ColourValue representing the colour DarkGray.

Returns:
Returns the created ColourValue.

Definition at line 187 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGreen ( ) [static]

Creates a ColourValue representing the colour DarkGreen.

Returns:
Returns the created ColourValue.

Definition at line 190 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkKhaki ( ) [static]

Creates a ColourValue representing the colour DarkKhaki.

Returns:
Returns the created ColourValue.

Definition at line 193 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkMagenta ( ) [static]

Creates a ColourValue representing the colour DarkMagenta.

Returns:
Returns the created ColourValue.

Definition at line 196 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOliveGreen ( ) [static]

Creates a ColourValue representing the colour DarkOliveGreen.

Returns:
Returns the created ColourValue.

Definition at line 199 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOrange ( ) [static]

Creates a ColourValue representing the colour DarkOrange.

Returns:
Returns the created ColourValue.

Definition at line 202 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOrchid ( ) [static]

Creates a ColourValue representing the colour DarkOrchid.

Returns:
Returns the created ColourValue.

Definition at line 205 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkRed ( ) [static]

Creates a ColourValue representing the colour DarkRed.

Returns:
Returns the created ColourValue.

Definition at line 208 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSalmon ( ) [static]

Creates a ColourValue representing the colour DarkSalmon.

Returns:
Returns the created ColourValue.

Definition at line 211 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSeaGreen ( ) [static]

Creates a ColourValue representing the colour DarkSeaGreen.

Returns:
Returns the created ColourValue.

Definition at line 214 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSlateBlue ( ) [static]

Creates a ColourValue representing the colour DarkSlateBlue.

Returns:
Returns the created ColourValue.

Definition at line 217 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSlateGray ( ) [static]

Creates a ColourValue representing the colour DarkSlateGray.

Returns:
Returns the created ColourValue.

Definition at line 220 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkTurquoise ( ) [static]

Creates a ColourValue representing the colour DarkTurquoise.

Returns:
Returns the created ColourValue.

Definition at line 223 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkViolet ( ) [static]

Creates a ColourValue representing the colour DarkViolet.

Returns:
Returns the created ColourValue.

Definition at line 226 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DeepPink ( ) [static]

Creates a ColourValue representing the colour DeepPink.

Returns:
Returns the created ColourValue.

Definition at line 229 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DeepSkyBlue ( ) [static]

Creates a ColourValue representing the colour DeepSkyBlue.

Returns:
Returns the created ColourValue.

Definition at line 232 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DimGray ( ) [static]

Creates a ColourValue representing the colour DimGray.

Returns:
Returns the created ColourValue.

Definition at line 235 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DodgerBlue ( ) [static]

Creates a ColourValue representing the colour DodgerBlue.

Returns:
Returns the created ColourValue.

Definition at line 238 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::FireBrick ( ) [static]

Creates a ColourValue representing the colour FireBrick.

Returns:
Returns the created ColourValue.

Definition at line 241 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::FloralWhite ( ) [static]

Creates a ColourValue representing the colour FloralWhite.

Returns:
Returns the created ColourValue.

Definition at line 244 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::ForestGreen ( ) [static]

Creates a ColourValue representing the colour ForestGreen.

Returns:
Returns the created ColourValue.

Definition at line 247 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Fuchsia ( ) [static]

Creates a ColourValue representing the colour Fuchsia.

Returns:
Returns the created ColourValue.

Definition at line 250 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gainsboro ( ) [static]

Creates a ColourValue representing the colour Gainsboro.

Returns:
Returns the created ColourValue.

Definition at line 253 of file colourvalue.cpp.

Ogre::ColourValue Mezzanine::ColourValue::GetOgreColourValue ( ) const

Creates and returns an Ogre ColourValue class with values equal to this one.

This function is intended for internal use only.

Returns:
Returns an Ogre ColourValue class that has values equal to this one.

Definition at line 88 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GhostWhite ( ) [static]

Creates a ColourValue representing the colour GhostWhite.

Returns:
Returns the created ColourValue.

Definition at line 256 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gold ( ) [static]

Creates a ColourValue representing the colour Gold.

Returns:
Returns the created ColourValue.

Definition at line 259 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GoldenRod ( ) [static]

Creates a ColourValue representing the colour GoldenRod.

Returns:
Returns the created ColourValue.

Definition at line 262 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gray ( ) [static]

Creates a ColourValue representing the colour Gray.

Returns:
Returns the created ColourValue.

Definition at line 265 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Green ( ) [static]

Creates a ColourValue representing the colour Green.

Returns:
Returns the created ColourValue.

Definition at line 268 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GreenYellow ( ) [static]

Creates a ColourValue representing the colour GreenYellow.

Returns:
Returns the created ColourValue.

Definition at line 271 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::HoneyDew ( ) [static]

Creates a ColourValue representing the colour HoneyDew.

Returns:
Returns the created ColourValue.

Definition at line 274 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::HotPink ( ) [static]

Creates a ColourValue representing the colour HotPink.

Returns:
Returns the created ColourValue.

Definition at line 277 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::IndianRed ( ) [static]

Creates a ColourValue representing the colour IndianRed.

Returns:
Returns the created ColourValue.

Definition at line 280 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Indigo ( ) [static]

Creates a ColourValue representing the colour Indigo.

Returns:
Returns the created ColourValue.

Definition at line 283 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Ivory ( ) [static]

Creates a ColourValue representing the colour Ivory.

Returns:
Returns the created ColourValue.

Definition at line 286 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Khaki ( ) [static]

Creates a ColourValue representing the colour Khaki.

Returns:
Returns the created ColourValue.

Definition at line 289 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Lavender ( ) [static]

Creates a ColourValue representing the colour Lavender.

Returns:
Returns the created ColourValue.

Definition at line 292 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LavenderBlush ( ) [static]

Creates a ColourValue representing the colour LavenderBlush.

Returns:
Returns the created ColourValue.

Definition at line 295 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LawnGreen ( ) [static]

Creates a ColourValue representing the colour LawnGreen.

Returns:
Returns the created ColourValue.

Definition at line 298 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LemonChiffon ( ) [static]

Creates a ColourValue representing the colour LemonChiffon.

Returns:
Returns the created ColourValue.

Definition at line 301 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightBlue ( ) [static]

Creates a ColourValue representing the colour LightBlue.

Returns:
Returns the created ColourValue.

Definition at line 304 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightCoral ( ) [static]

Creates a ColourValue representing the colour LightCoral.

Returns:
Returns the created ColourValue.

Definition at line 307 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightCyan ( ) [static]

Creates a ColourValue representing the colour LightCyan.

Returns:
Returns the created ColourValue.

Definition at line 310 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGoldenRodYellow ( ) [static]

Creates a ColourValue representing the colour LightGoldenRodYellow.

Returns:
Returns the created ColourValue.

Definition at line 313 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGray ( ) [static]

Creates a ColourValue representing the colour LightGray.

Returns:
Returns the created ColourValue.

Definition at line 316 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGreen ( ) [static]

Creates a ColourValue representing the colour LightGreen.

Returns:
Returns the created ColourValue.

Definition at line 319 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightPink ( ) [static]

Creates a ColourValue representing the colour LightPink.

Returns:
Returns the created ColourValue.

Definition at line 322 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSalmon ( ) [static]

Creates a ColourValue representing the colour LightSalmon.

Returns:
Returns the created ColourValue.

Definition at line 325 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSeaGreen ( ) [static]

Creates a ColourValue representing the colour LightSeaGreen.

Returns:
Returns the created ColourValue.

Definition at line 328 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSkyBlue ( ) [static]

Creates a ColourValue representing the colour LightSkyBlue.

Returns:
Returns the created ColourValue.

Definition at line 331 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSlateGray ( ) [static]

Creates a ColourValue representing the colour LightSlateGray.

Returns:
Returns the created ColourValue.

Definition at line 334 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSteelBlue ( ) [static]

Creates a ColourValue representing the colour LightSteelBlue.

Returns:
Returns the created ColourValue.

Definition at line 337 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightYellow ( ) [static]

Creates a ColourValue representing the colour LightYellow.

Returns:
Returns the created ColourValue.

Definition at line 340 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Lime ( ) [static]

Creates a ColourValue representing the colour Lime.

Returns:
Returns the created ColourValue.

Definition at line 343 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LimeGreen ( ) [static]

Creates a ColourValue representing the colour LimeGreen.

Returns:
Returns the created ColourValue.

Definition at line 346 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Linen ( ) [static]

Creates a ColourValue representing the colour Linen.

Returns:
Returns the created ColourValue.

Definition at line 349 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Magenta ( ) [static]

Creates a ColourValue representing the colour Magenta.

Returns:
Returns the created ColourValue.

Definition at line 352 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Maroon ( ) [static]

Creates a ColourValue representing the colour Maroon.

Returns:
Returns the created ColourValue.

Definition at line 355 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumAquamarine ( ) [static]

Creates a ColourValue representing the colour MediumAquamarine.

Returns:
Returns the created ColourValue.

Definition at line 358 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumBlue ( ) [static]

Creates a ColourValue representing the colour MediumBlue.

Returns:
Returns the created ColourValue.

Definition at line 361 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumOrchid ( ) [static]

Creates a ColourValue representing the colour MediumOrchid.

Returns:
Returns the created ColourValue.

Definition at line 364 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumPurple ( ) [static]

Creates a ColourValue representing the colour MediumPurple.

Returns:
Returns the created ColourValue.

Definition at line 367 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSeaGreen ( ) [static]

Creates a ColourValue representing the colour MediumSeaGreen.

Returns:
Returns the created ColourValue.

Definition at line 370 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSlateBlue ( ) [static]

Creates a ColourValue representing the colour MediumSlateBlue.

Returns:
Returns the created ColourValue.

Definition at line 373 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSpringGreen ( ) [static]

Creates a ColourValue representing the colour MediumSpringGreen.

Returns:
Returns the created ColourValue.

Definition at line 376 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumTurquoise ( ) [static]

Creates a ColourValue representing the colour MediumTurquoise.

Returns:
Returns the created ColourValue.

Definition at line 379 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumVioletRed ( ) [static]

Creates a ColourValue representing the colour MediumVioletRed.

Returns:
Returns the created ColourValue.

Definition at line 382 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MidnightBlue ( ) [static]

Creates a ColourValue representing the colour MidnightBlue.

Returns:
Returns the created ColourValue.

Definition at line 385 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MintCream ( ) [static]

Creates a ColourValue representing the colour MintCream.

Returns:
Returns the created ColourValue.

Definition at line 388 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MistyRose ( ) [static]

Creates a ColourValue representing the colour MistyRose.

Returns:
Returns the created ColourValue.

Definition at line 391 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Moccasin ( ) [static]

Creates a ColourValue representing the colour Moccasin.

Returns:
Returns the created ColourValue.

Definition at line 394 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::NavajoWhite ( ) [static]

Creates a ColourValue representing the colour NavajoWhite.

Returns:
Returns the created ColourValue.

Definition at line 397 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Navy ( ) [static]

Creates a ColourValue representing the colour Navy.

Returns:
Returns the created ColourValue.

Definition at line 400 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OldLace ( ) [static]

Creates a ColourValue representing the colour OldLace.

Returns:
Returns the created ColourValue.

Definition at line 403 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Olive ( ) [static]

Creates a ColourValue representing the colour Olive.

Returns:
Returns the created ColourValue.

Definition at line 406 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OliveDrab ( ) [static]

Creates a ColourValue representing the colour OliveDrab.

Returns:
Returns the created ColourValue.

Definition at line 409 of file colourvalue.cpp.

bool Mezzanine::ColourValue::operator!= ( const ColourValue Colour)

Inequality Comparison Operator.

Parameters:
ColourThis is another ColourValue to compare with.
Returns:
False if the colors match perfectly, True otherwise

Definition at line 101 of file colourvalue.cpp.

void Mezzanine::ColourValue::operator= ( const ColourValue OtherColour)

Assignment operator.

Parameters:
OtherColourThe colour values you want to overwrite this colour's values with.

Definition at line 104 of file colourvalue.cpp.

bool Mezzanine::ColourValue::operator== ( const ColourValue Colour)

Equality Comparison Operator.

Parameters:
ColourThis is another ColourValue to compare with.
Returns:
True if the colors match perfectly, false otherwise

Definition at line 98 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Orange ( ) [static]

Creates a ColourValue representing the colour Orange.

Returns:
Returns the created ColourValue.

Definition at line 412 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OrangeRed ( ) [static]

Creates a ColourValue representing the colour OrangeRed.

Returns:
Returns the created ColourValue.

Definition at line 415 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Orchid ( ) [static]

Creates a ColourValue representing the colour Orchid.

Returns:
Returns the created ColourValue.

Definition at line 418 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleGoldenRod ( ) [static]

Creates a ColourValue representing the colour PaleGoldenRod.

Returns:
Returns the created ColourValue.

Definition at line 421 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleGreen ( ) [static]

Creates a ColourValue representing the colour PaleGreen.

Returns:
Returns the created ColourValue.

Definition at line 424 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleTurquoise ( ) [static]

Creates a ColourValue representing the colour PaleTurquoise.

Returns:
Returns the created ColourValue.

Definition at line 427 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleVioletRed ( ) [static]

Creates a ColourValue representing the colour PaleVioletRed.

Returns:
Returns the created ColourValue.

Definition at line 430 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PapayaWhip ( ) [static]

Creates a ColourValue representing the colour PapayaWhip.

Returns:
Returns the created ColourValue.

Definition at line 433 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PeachPuff ( ) [static]

Creates a ColourValue representing the colour PeachPuff.

Returns:
Returns the created ColourValue.

Definition at line 436 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Peru ( ) [static]

Creates a ColourValue representing the colour Peru.

Returns:
Returns the created ColourValue.

Definition at line 439 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Pink ( ) [static]

Creates a ColourValue representing the colour Pink.

Returns:
Returns the created ColourValue.

Definition at line 442 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Plum ( ) [static]

Creates a ColourValue representing the colour Plum.

Returns:
Returns the created ColourValue.

Definition at line 445 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PowderBlue ( ) [static]

Creates a ColourValue representing the colour PowderBlue.

Returns:
Returns the created ColourValue.

Definition at line 448 of file colourvalue.cpp.

void Mezzanine::ColourValue::ProtoDeSerialize ( const xml::Node OneNode) [virtual]

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters:
OneNodeand xml::Node containing the data.

Definition at line 561 of file colourvalue.cpp.

void Mezzanine::ColourValue::ProtoSerialize ( xml::Node CurrentRoot) const [virtual]

Convert this class to an xml::Node ready for serialization.

Parameters:
CurrentRootThe point in the XML hierarchy that all this quaternion should be appended to.

Definition at line 537 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Purple ( ) [static]

Creates a ColourValue representing the colour Purple.

Returns:
Returns the created ColourValue.

Definition at line 451 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Red ( ) [static]

Creates a ColourValue representing the colour Red.

Returns:
Returns the created ColourValue.

Definition at line 454 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::RosyBrown ( ) [static]

Creates a ColourValue representing the colour RosyBrown.

Returns:
Returns the created ColourValue.

Definition at line 457 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::RoyalBlue ( ) [static]

Creates a ColourValue representing the colour RoyalBlue.

Returns:
Returns the created ColourValue.

Definition at line 460 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SaddleBrown ( ) [static]

Creates a ColourValue representing the colour SaddleBrown.

Returns:
Returns the created ColourValue.

Definition at line 463 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Salmon ( ) [static]

Creates a ColourValue representing the colour Salmon.

Returns:
Returns the created ColourValue.

Definition at line 466 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SandyBrown ( ) [static]

Creates a ColourValue representing the colour SandyBrown.

Returns:
Returns the created ColourValue.

Definition at line 469 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SeaGreen ( ) [static]

Creates a ColourValue representing the colour SeaGreen.

Returns:
Returns the created ColourValue.

Definition at line 472 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SeaShell ( ) [static]

Creates a ColourValue representing the colour SeaShell.

Returns:
Returns the created ColourValue.

Definition at line 475 of file colourvalue.cpp.

String Mezzanine::ColourValue::SerializableName ( ) [static]

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns:
A string containing "ColourValue"

Definition at line 579 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Sienna ( ) [static]

Creates a ColourValue representing the colour Sienna.

Returns:
Returns the created ColourValue.

Definition at line 478 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Silver ( ) [static]

Creates a ColourValue representing the colour Silver.

Returns:
Returns the created ColourValue.

Definition at line 481 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SkyBlue ( ) [static]

Creates a ColourValue representing the colour SkyBlue.

Returns:
Returns the created ColourValue.

Definition at line 484 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SlateBlue ( ) [static]

Creates a ColourValue representing the colour SlateBlue.

Returns:
Returns the created ColourValue.

Definition at line 487 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SlateGray ( ) [static]

Creates a ColourValue representing the colour SlateGray.

Returns:
Returns the created ColourValue.

Definition at line 490 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Snow ( ) [static]

Creates a ColourValue representing the colour Snow.

Returns:
Returns the created ColourValue.

Definition at line 493 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SpringGreen ( ) [static]

Creates a ColourValue representing the colour SpringGreen.

Returns:
Returns the created ColourValue.

Definition at line 496 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SteelBlue ( ) [static]

Creates a ColourValue representing the colour SteelBlue.

Returns:
Returns the created ColourValue.

Definition at line 499 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Tan ( ) [static]

Creates a ColourValue representing the colour Tan.

Returns:
Returns the created ColourValue.

Definition at line 502 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Teal ( ) [static]

Creates a ColourValue representing the colour Teal.

Returns:
Returns the created ColourValue.

Definition at line 505 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Thistle ( ) [static]

Creates a ColourValue representing the colour Thistle.

Returns:
Returns the created ColourValue.

Definition at line 508 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Tomato ( ) [static]

Creates a ColourValue representing the colour Tomato.

Returns:
Returns the created ColourValue.

Definition at line 511 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Transparent ( ) [static]

Creates a ColourValue representing no colour.

Returns:
Returns the created ColourValue.

Definition at line 112 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Turquoise ( ) [static]

Creates a ColourValue representing the colour Turquoise.

Returns:
Returns the created ColourValue.

Definition at line 514 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Violet ( ) [static]

Creates a ColourValue representing the colour Violet.

Returns:
Returns the created ColourValue.

Definition at line 517 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Wheat ( ) [static]

Creates a ColourValue representing the colour Wheat.

Returns:
Returns the created ColourValue.

Definition at line 520 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::White ( ) [static]

Creates a ColourValue representing the colour White.

Returns:
Returns the created ColourValue.

Definition at line 523 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::WhiteSmoke ( ) [static]

Creates a ColourValue representing the colour WhiteSmoke.

Returns:
Returns the created ColourValue.

Definition at line 526 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Yellow ( ) [static]

Creates a ColourValue representing the colour Yellow.

Returns:
Returns the created ColourValue.

Definition at line 529 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::YellowGreen ( ) [static]

Creates a ColourValue representing the colour YellowGreen.

Returns:
Returns the created ColourValue.

Definition at line 532 of file colourvalue.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines