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

#include <colourvalue.h>

Public Member Functions
	ColourValue (Real Red=1.0, Real Green=1.0, Real Blue=1.0, Real Alpha=1.0)
	4 Reals constructor. More...

	ColourValue (const Ogre::ColourValue &OgreValues)
	Ogre constructor. More...

	ColourValue (const ColourValue &OtherColour)
	Copy Constructor. More...

	ColourValue (const XML::Node &OneNode)
	XML Constructor. More...

	~ColourValue ()
	Class destructor.

ColourValue	Average (const ColourValue &OtherColor) const
	Get the color that is the average of this and another color. More...

Real	GetAlphaChannel () const
	Retrieve the Alpha color component. More...

Real	GetBlueChannel () const
	Retrieve the Blue color component. More...

Real	GetGreenChannel () const
	Retrieve the Green color component. More...

Ogre::ColourValue	GetOgreColourValue () const
	Creates and returns an Ogre ColourValue class with values equal to this one. More...

Real	GetRedChannel () const
	Retrieve the Red color component. More...

Boole	operator!= (const ColourValue &Colour) const
	Inequality Comparison Operator. More...

ColourValue	operator* (const Real Scalar)
	Scalar Multiplication Operator. More...

ColourValue	operator* (const ColourValue &Colour)
	Multiplication Operator. More...

ColourValue &	operator*= (const ColourValue &Colour)
	Multiplication Operator. More...

ColourValue	operator+ (const ColourValue &Colour)
	Addition Operator. More...

ColourValue &	operator+= (const ColourValue &Colour)
	Addition Operator. More...

ColourValue	operator- (const ColourValue &Colour)
	Subtraction Operator. More...

ColourValue &	operator-= (const ColourValue &Colour)
	Subtraction Operator. More...

void	operator= (const ColourValue &OtherColour)
	Assignment operator. More...

Boole	operator== (const ColourValue &Colour) const
	Equality Comparison Operator. More...

void	ProtoDeSerialize (const XML::Node &OneNode)
	Take the data stored in an XML and overwrite this instance of this object with it. More...

void	ProtoSerialize (XML::Node &CurrentRoot) const
	Convert this class to an XML::Node ready for serialization. More...

void	SetAlphaChannel (const Real Alpha)
	Set the Alpha component of this color. More...

void	SetBlueChannel (const Real Blue)
	Set the Blue component of this color. More...

void	SetGreenChannel (const Real Green)
	Set the Green component of this color. More...

void	SetRedChannel (const Real Red)
	Set the Red component of this color. More...

void	SetValues (const Real Red, const Real Green, const Real Blue, const Real Alpha)
	Sets each of the colour channels. More...

Static Public Member Functions
static ColourValue	AliceBlue ()
	Creates a ColourValue representing the colour AliceBlue. More...

static ColourValue	AntiqueWhite ()
	Creates a ColourValue representing the colour AntiqueWhite. More...

static ColourValue	Aqua ()
	Creates a ColourValue representing the colour Aqua. More...

static ColourValue	Aquamarine ()
	Creates a ColourValue representing the colour Aquamarine. More...

static ColourValue	Azure ()
	Creates a ColourValue representing the colour Azure. More...

static ColourValue	Beige ()
	Creates a ColourValue representing the colour Beige. More...

static ColourValue	Bisque ()
	Creates a ColourValue representing the colour Bisque. More...

static ColourValue	Black ()
	Creates a ColourValue representing the colour Black. More...

static ColourValue	Blanchedalmond ()
	Creates a ColourValue representing the colour Blanchedalmond. More...

static ColourValue	Blue ()
	Creates a ColourValue representing the colour Blue. More...

static ColourValue	BlueViolet ()
	Creates a ColourValue representing the colour BlueViolet. More...

static ColourValue	Brown ()
	Creates a ColourValue representing the colour Brown. More...

static ColourValue	BurlyWood ()
	Creates a ColourValue representing the colour BurlyWood. More...

static ColourValue	CadetBlue ()
	Creates a ColourValue representing the colour CadetBlue. More...

static ColourValue	Chartreuse ()
	Creates a ColourValue representing the colour Chartreuse. More...

static ColourValue	Chocolate ()
	Creates a ColourValue representing the colour Chocolate. More...

static ColourValue	Coral ()
	Creates a ColourValue representing the colour Coral. More...

static ColourValue	CornFlowerBlue ()
	Creates a ColourValue representing the colour CornFlowerBlue. More...

static ColourValue	CornSilk ()
	Creates a ColourValue representing the colour CornSilk. More...

static ColourValue	Crimson ()
	Creates a ColourValue representing the colour Crimson. More...

static ColourValue	Cyan ()
	Creates a ColourValue representing the colour Cyan. More...

static ColourValue	DarkBlue ()
	Creates a ColourValue representing the colour DarkBlue. More...

static ColourValue	DarkCyan ()
	Creates a ColourValue representing the colour DarkCyan. More...

static ColourValue	DarkGoldenRod ()
	Creates a ColourValue representing the colour DarkGoldenRod. More...

static ColourValue	DarkGray ()
	Creates a ColourValue representing the colour DarkGray. More...

static ColourValue	DarkGreen ()
	Creates a ColourValue representing the colour DarkGreen. More...

static ColourValue	DarkKhaki ()
	Creates a ColourValue representing the colour DarkKhaki. More...

static ColourValue	DarkMagenta ()
	Creates a ColourValue representing the colour DarkMagenta. More...

static ColourValue	DarkOliveGreen ()
	Creates a ColourValue representing the colour DarkOliveGreen. More...

static ColourValue	DarkOrange ()
	Creates a ColourValue representing the colour DarkOrange. More...

static ColourValue	DarkOrchid ()
	Creates a ColourValue representing the colour DarkOrchid. More...

static ColourValue	DarkRed ()
	Creates a ColourValue representing the colour DarkRed. More...

static ColourValue	DarkSalmon ()
	Creates a ColourValue representing the colour DarkSalmon. More...

static ColourValue	DarkSeaGreen ()
	Creates a ColourValue representing the colour DarkSeaGreen. More...

static ColourValue	DarkSlateBlue ()
	Creates a ColourValue representing the colour DarkSlateBlue. More...

static ColourValue	DarkSlateGray ()
	Creates a ColourValue representing the colour DarkSlateGray. More...

static ColourValue	DarkTurquoise ()
	Creates a ColourValue representing the colour DarkTurquoise. More...

static ColourValue	DarkViolet ()
	Creates a ColourValue representing the colour DarkViolet. More...

static ColourValue	DeepPink ()
	Creates a ColourValue representing the colour DeepPink. More...

static ColourValue	DeepSkyBlue ()
	Creates a ColourValue representing the colour DeepSkyBlue. More...

static ColourValue	DimGray ()
	Creates a ColourValue representing the colour DimGray. More...

static ColourValue	DodgerBlue ()
	Creates a ColourValue representing the colour DodgerBlue. More...

static ColourValue	FireBrick ()
	Creates a ColourValue representing the colour FireBrick. More...

static ColourValue	FloralWhite ()
	Creates a ColourValue representing the colour FloralWhite. More...

static ColourValue	ForestGreen ()
	Creates a ColourValue representing the colour ForestGreen. More...

static ColourValue	Fuchsia ()
	Creates a ColourValue representing the colour Fuchsia. More...

static ColourValue	Gainsboro ()
	Creates a ColourValue representing the colour Gainsboro. More...

static String	GetSerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

static ColourValue	GhostWhite ()
	Creates a ColourValue representing the colour GhostWhite. More...

static ColourValue	Gold ()
	Creates a ColourValue representing the colour Gold. More...

static ColourValue	GoldenRod ()
	Creates a ColourValue representing the colour GoldenRod. More...

static ColourValue	Gray ()
	Creates a ColourValue representing the colour Gray. More...

static ColourValue	Green ()
	Creates a ColourValue representing the colour Green. More...

static ColourValue	GreenYellow ()
	Creates a ColourValue representing the colour GreenYellow. More...

static ColourValue	HoneyDew ()
	Creates a ColourValue representing the colour HoneyDew. More...

static ColourValue	HotPink ()
	Creates a ColourValue representing the colour HotPink. More...

static ColourValue	IndianRed ()
	Creates a ColourValue representing the colour IndianRed. More...

static ColourValue	Indigo ()
	Creates a ColourValue representing the colour Indigo. More...

static ColourValue	Ivory ()
	Creates a ColourValue representing the colour Ivory. More...

static ColourValue	Khaki ()
	Creates a ColourValue representing the colour Khaki. More...

static ColourValue	Lavender ()
	Creates a ColourValue representing the colour Lavender. More...

static ColourValue	LavenderBlush ()
	Creates a ColourValue representing the colour LavenderBlush. More...

static ColourValue	LawnGreen ()
	Creates a ColourValue representing the colour LawnGreen. More...

static ColourValue	LemonChiffon ()
	Creates a ColourValue representing the colour LemonChiffon. More...

static ColourValue	LightBlue ()
	Creates a ColourValue representing the colour LightBlue. More...

static ColourValue	LightCoral ()
	Creates a ColourValue representing the colour LightCoral. More...

static ColourValue	LightCyan ()
	Creates a ColourValue representing the colour LightCyan. More...

static ColourValue	LightGoldenRodYellow ()
	Creates a ColourValue representing the colour LightGoldenRodYellow. More...

static ColourValue	LightGray ()
	Creates a ColourValue representing the colour LightGray. More...

static ColourValue	LightGreen ()
	Creates a ColourValue representing the colour LightGreen. More...

static ColourValue	LightPink ()
	Creates a ColourValue representing the colour LightPink. More...

static ColourValue	LightSalmon ()
	Creates a ColourValue representing the colour LightSalmon. More...

static ColourValue	LightSeaGreen ()
	Creates a ColourValue representing the colour LightSeaGreen. More...

static ColourValue	LightSkyBlue ()
	Creates a ColourValue representing the colour LightSkyBlue. More...

static ColourValue	LightSlateGray ()
	Creates a ColourValue representing the colour LightSlateGray. More...

static ColourValue	LightSteelBlue ()
	Creates a ColourValue representing the colour LightSteelBlue. More...

static ColourValue	LightYellow ()
	Creates a ColourValue representing the colour LightYellow. More...

static ColourValue	Lime ()
	Creates a ColourValue representing the colour Lime. More...

static ColourValue	LimeGreen ()
	Creates a ColourValue representing the colour LimeGreen. More...

static ColourValue	Linen ()
	Creates a ColourValue representing the colour Linen. More...

static ColourValue	Magenta ()
	Creates a ColourValue representing the colour Magenta. More...

static ColourValue	Maroon ()
	Creates a ColourValue representing the colour Maroon. More...

static ColourValue	MediumAquamarine ()
	Creates a ColourValue representing the colour MediumAquamarine. More...

static ColourValue	MediumBlue ()
	Creates a ColourValue representing the colour MediumBlue. More...

static ColourValue	MediumOrchid ()
	Creates a ColourValue representing the colour MediumOrchid. More...

static ColourValue	MediumPurple ()
	Creates a ColourValue representing the colour MediumPurple. More...

static ColourValue	MediumSeaGreen ()
	Creates a ColourValue representing the colour MediumSeaGreen. More...

static ColourValue	MediumSlateBlue ()
	Creates a ColourValue representing the colour MediumSlateBlue. More...

static ColourValue	MediumSpringGreen ()
	Creates a ColourValue representing the colour MediumSpringGreen. More...

static ColourValue	MediumTurquoise ()
	Creates a ColourValue representing the colour MediumTurquoise. More...

static ColourValue	MediumVioletRed ()
	Creates a ColourValue representing the colour MediumVioletRed. More...

static ColourValue	MidnightBlue ()
	Creates a ColourValue representing the colour MidnightBlue. More...

static ColourValue	MintCream ()
	Creates a ColourValue representing the colour MintCream. More...

static ColourValue	MistyRose ()
	Creates a ColourValue representing the colour MistyRose. More...

static ColourValue	Moccasin ()
	Creates a ColourValue representing the colour Moccasin. More...

static ColourValue	NavajoWhite ()
	Creates a ColourValue representing the colour NavajoWhite. More...

static ColourValue	Navy ()
	Creates a ColourValue representing the colour Navy. More...

static ColourValue	OldLace ()
	Creates a ColourValue representing the colour OldLace. More...

static ColourValue	Olive ()
	Creates a ColourValue representing the colour Olive. More...

static ColourValue	OliveDrab ()
	Creates a ColourValue representing the colour OliveDrab. More...

static ColourValue	Orange ()
	Creates a ColourValue representing the colour Orange. More...

static ColourValue	OrangeRed ()
	Creates a ColourValue representing the colour OrangeRed. More...

static ColourValue	Orchid ()
	Creates a ColourValue representing the colour Orchid. More...

static ColourValue	PaleGoldenRod ()
	Creates a ColourValue representing the colour PaleGoldenRod. More...

static ColourValue	PaleGreen ()
	Creates a ColourValue representing the colour PaleGreen. More...

static ColourValue	PaleTurquoise ()
	Creates a ColourValue representing the colour PaleTurquoise. More...

static ColourValue	PaleVioletRed ()
	Creates a ColourValue representing the colour PaleVioletRed. More...

static ColourValue	PapayaWhip ()
	Creates a ColourValue representing the colour PapayaWhip. More...

static ColourValue	PeachPuff ()
	Creates a ColourValue representing the colour PeachPuff. More...

static ColourValue	Peru ()
	Creates a ColourValue representing the colour Peru. More...

static ColourValue	Pink ()
	Creates a ColourValue representing the colour Pink. More...

static ColourValue	Plum ()
	Creates a ColourValue representing the colour Plum. More...

static ColourValue	PowderBlue ()
	Creates a ColourValue representing the colour PowderBlue. More...

static ColourValue	Purple ()
	Creates a ColourValue representing the colour Purple. More...

static ColourValue	Red ()
	Creates a ColourValue representing the colour Red. More...

static ColourValue	RosyBrown ()
	Creates a ColourValue representing the colour RosyBrown. More...

static ColourValue	RoyalBlue ()
	Creates a ColourValue representing the colour RoyalBlue. More...

static ColourValue	SaddleBrown ()
	Creates a ColourValue representing the colour SaddleBrown. More...

static ColourValue	Salmon ()
	Creates a ColourValue representing the colour Salmon. More...

static ColourValue	SandyBrown ()
	Creates a ColourValue representing the colour SandyBrown. More...

static ColourValue	SeaGreen ()
	Creates a ColourValue representing the colour SeaGreen. More...

static ColourValue	SeaShell ()
	Creates a ColourValue representing the colour SeaShell. More...

static ColourValue	Sienna ()
	Creates a ColourValue representing the colour Sienna. More...

static ColourValue	Silver ()
	Creates a ColourValue representing the colour Silver. More...

static ColourValue	SkyBlue ()
	Creates a ColourValue representing the colour SkyBlue. More...

static ColourValue	SlateBlue ()
	Creates a ColourValue representing the colour SlateBlue. More...

static ColourValue	SlateGray ()
	Creates a ColourValue representing the colour SlateGray. More...

static ColourValue	Snow ()
	Creates a ColourValue representing the colour Snow. More...

static ColourValue	SpringGreen ()
	Creates a ColourValue representing the colour SpringGreen. More...

static ColourValue	SteelBlue ()
	Creates a ColourValue representing the colour SteelBlue. More...

static ColourValue	Tan ()
	Creates a ColourValue representing the colour Tan. More...

static ColourValue	Teal ()
	Creates a ColourValue representing the colour Teal. More...

static ColourValue	Thistle ()
	Creates a ColourValue representing the colour Thistle. More...

static ColourValue	Tomato ()
	Creates a ColourValue representing the colour Tomato. More...

static ColourValue	Transparent ()
	Creates a ColourValue representing no colour. More...

static ColourValue	Turquoise ()
	Creates a ColourValue representing the colour Turquoise. More...

static ColourValue	Violet ()
	Creates a ColourValue representing the colour Violet. More...

static ColourValue	Wheat ()
	Creates a ColourValue representing the colour Wheat. More...

static ColourValue	White ()
	Creates a ColourValue representing the colour White. More...

static ColourValue	WhiteSmoke ()
	Creates a ColourValue representing the colour WhiteSmoke. More...

static ColourValue	Yellow ()
	Creates a ColourValue representing the colour Yellow. More...

static ColourValue	YellowGreen ()
	Creates a ColourValue representing the colour YellowGreen. More...

Public Attributes
Real	AlphaChannel
	Value from 0.0 to 1.0 representing the transparency of the colours. 1.0 is opaque and 0.0 is clear. More...

Real	BlueChannel
	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. More...

Real	GreenChannel
	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. More...

Real	RedChannel
	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. More...

Detailed Description

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

Note: Calling the Color helper function from scripting languages without static function support is odd, instead of a scoping operator and underscore is used in the identifier name, for example in Lua use the following syntax: alicedressbeforegunfight=MezzanineSafe.ColourValue_AliceBlue()

Definition at line 64 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

Red	Real representing the amount of red present in the colour.
Green	Real representing the amount of green present in the colour.
Blue	Real representing the amount of blue present in the colour.
Alpha	Real representing the transparency of the colours.

Definition at line 53 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

OgreValues The Ogre ColourValue class to base this class on.

Definition at line 61 of file colourvalue.cpp.

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

Copy Constructor.

Parameters

OtherColour

Definition at line 69 of file colourvalue.cpp.

Mezzanine::ColourValue::ColourValue ( const XML::Node & OneNode )

XML Constructor.

Parameters

OneNode The XML node to deserialize from.

Definition at line 77 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 186 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::AntiqueWhite ( )

static

Creates a ColourValue representing the colour AntiqueWhite.

Returns: Returns the created ColourValue.

Definition at line 189 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Aqua ( )

static

Creates a ColourValue representing the colour Aqua.

Returns: Returns the created ColourValue.

Definition at line 192 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Aquamarine ( )

static

Creates a ColourValue representing the colour Aquamarine.

Returns: Returns the created ColourValue.

Definition at line 195 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Average ( const ColourValue & OtherColor ) const

Get the color that is the average of this and another color.

Parameters

OtherColor The other color to average with.

Returns: A ColourValue with each channel being the arithmetic mean of this and the OtherColor.

Definition at line 131 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Azure ( )

static

Creates a ColourValue representing the colour Azure.

Returns: Returns the created ColourValue.

Definition at line 198 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Beige ( )

static

Creates a ColourValue representing the colour Beige.

Returns: Returns the created ColourValue.

Definition at line 201 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Bisque ( )

static

Creates a ColourValue representing the colour Bisque.

Returns: Returns the created ColourValue.

Definition at line 204 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Black ( )

static

Creates a ColourValue representing the colour Black.

Returns: Returns the created ColourValue.

Definition at line 207 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Blanchedalmond ( )

static

Creates a ColourValue representing the colour Blanchedalmond.

Returns: Returns the created ColourValue.

Definition at line 210 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Blue ( )

static

Creates a ColourValue representing the colour Blue.

Returns: Returns the created ColourValue.

Definition at line 213 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::BlueViolet ( )

static

Creates a ColourValue representing the colour BlueViolet.

Returns: Returns the created ColourValue.

Definition at line 216 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Brown ( )

static

Creates a ColourValue representing the colour Brown.

Returns: Returns the created ColourValue.

Definition at line 219 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::BurlyWood ( )

static

Creates a ColourValue representing the colour BurlyWood.

Returns: Returns the created ColourValue.

Definition at line 222 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CadetBlue ( )

static

Creates a ColourValue representing the colour CadetBlue.

Returns: Returns the created ColourValue.

Definition at line 225 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Chartreuse ( )

static

Creates a ColourValue representing the colour Chartreuse.

Returns: Returns the created ColourValue.

Definition at line 228 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Chocolate ( )

static

Creates a ColourValue representing the colour Chocolate.

Returns: Returns the created ColourValue.

Definition at line 231 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Coral ( )

static

Creates a ColourValue representing the colour Coral.

Returns: Returns the created ColourValue.

Definition at line 234 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CornFlowerBlue ( )

static

Creates a ColourValue representing the colour CornFlowerBlue.

Returns: Returns the created ColourValue.

Definition at line 237 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::CornSilk ( )

static

Creates a ColourValue representing the colour CornSilk.

Returns: Returns the created ColourValue.

Definition at line 240 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Crimson ( )

static

Creates a ColourValue representing the colour Crimson.

Returns: Returns the created ColourValue.

Definition at line 243 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Cyan ( )

static

Creates a ColourValue representing the colour Cyan.

Returns: Returns the created ColourValue.

Definition at line 246 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkBlue ( )

static

Creates a ColourValue representing the colour DarkBlue.

Returns: Returns the created ColourValue.

Definition at line 249 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkCyan ( )

static

Creates a ColourValue representing the colour DarkCyan.

Returns: Returns the created ColourValue.

Definition at line 252 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGoldenRod ( )

static

Creates a ColourValue representing the colour DarkGoldenRod.

Returns: Returns the created ColourValue.

Definition at line 255 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGray ( )

static

Creates a ColourValue representing the colour DarkGray.

Returns: Returns the created ColourValue.

Definition at line 258 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkGreen ( )

static

Creates a ColourValue representing the colour DarkGreen.

Returns: Returns the created ColourValue.

Definition at line 261 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkKhaki ( )

static

Creates a ColourValue representing the colour DarkKhaki.

Returns: Returns the created ColourValue.

Definition at line 264 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkMagenta ( )

static

Creates a ColourValue representing the colour DarkMagenta.

Returns: Returns the created ColourValue.

Definition at line 267 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOliveGreen ( )

static

Creates a ColourValue representing the colour DarkOliveGreen.

Returns: Returns the created ColourValue.

Definition at line 270 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOrange ( )

static

Creates a ColourValue representing the colour DarkOrange.

Returns: Returns the created ColourValue.

Definition at line 273 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkOrchid ( )

static

Creates a ColourValue representing the colour DarkOrchid.

Returns: Returns the created ColourValue.

Definition at line 276 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkRed ( )

static

Creates a ColourValue representing the colour DarkRed.

Returns: Returns the created ColourValue.

Definition at line 279 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSalmon ( )

static

Creates a ColourValue representing the colour DarkSalmon.

Returns: Returns the created ColourValue.

Definition at line 282 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSeaGreen ( )

static

Creates a ColourValue representing the colour DarkSeaGreen.

Returns: Returns the created ColourValue.

Definition at line 285 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSlateBlue ( )

static

Creates a ColourValue representing the colour DarkSlateBlue.

Returns: Returns the created ColourValue.

Definition at line 288 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkSlateGray ( )

static

Creates a ColourValue representing the colour DarkSlateGray.

Returns: Returns the created ColourValue.

Definition at line 291 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkTurquoise ( )

static

Creates a ColourValue representing the colour DarkTurquoise.

Returns: Returns the created ColourValue.

Definition at line 294 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DarkViolet ( )

static

Creates a ColourValue representing the colour DarkViolet.

Returns: Returns the created ColourValue.

Definition at line 297 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DeepPink ( )

static

Creates a ColourValue representing the colour DeepPink.

Returns: Returns the created ColourValue.

Definition at line 300 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DeepSkyBlue ( )

static

Creates a ColourValue representing the colour DeepSkyBlue.

Returns: Returns the created ColourValue.

Definition at line 303 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DimGray ( )

static

Creates a ColourValue representing the colour DimGray.

Returns: Returns the created ColourValue.

Definition at line 306 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::DodgerBlue ( )

static

Creates a ColourValue representing the colour DodgerBlue.

Returns: Returns the created ColourValue.

Definition at line 309 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::FireBrick ( )

static

Creates a ColourValue representing the colour FireBrick.

Returns: Returns the created ColourValue.

Definition at line 312 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::FloralWhite ( )

static

Creates a ColourValue representing the colour FloralWhite.

Returns: Returns the created ColourValue.

Definition at line 315 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::ForestGreen ( )

static

Creates a ColourValue representing the colour ForestGreen.

Returns: Returns the created ColourValue.

Definition at line 318 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Fuchsia ( )

static

Creates a ColourValue representing the colour Fuchsia.

Returns: Returns the created ColourValue.

Definition at line 321 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gainsboro ( )

static

Creates a ColourValue representing the colour Gainsboro.

Returns: Returns the created ColourValue.

Definition at line 324 of file colourvalue.cpp.

Real Mezzanine::ColourValue::GetAlphaChannel ( ) const

Retrieve the Alpha color component.

Returns: A Real between 0 and 1 respresenting, how Transparent this this color is.

Definition at line 120 of file colourvalue.cpp.

Real Mezzanine::ColourValue::GetBlueChannel ( ) const

Retrieve the Blue color component.

Returns: A Real between 0 and 1 respresenting, how Blue this this color is.

Definition at line 114 of file colourvalue.cpp.

Real Mezzanine::ColourValue::GetGreenChannel ( ) const

Retrieve the Green color component.

Returns: A Real between 0 and 1 respresenting, how Green this this color is.

Definition at line 108 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 86 of file colourvalue.cpp.

Real Mezzanine::ColourValue::GetRedChannel ( ) const

Retrieve the Red color component.

Returns: A Real between 0 and 1 respresenting, how Red this this color is.

Definition at line 102 of file colourvalue.cpp.

String Mezzanine::ColourValue::GetSerializableName ( )

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 651 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GhostWhite ( )

static

Creates a ColourValue representing the colour GhostWhite.

Returns: Returns the created ColourValue.

Definition at line 327 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gold ( )

static

Creates a ColourValue representing the colour Gold.

Returns: Returns the created ColourValue.

Definition at line 330 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GoldenRod ( )

static

Creates a ColourValue representing the colour GoldenRod.

Returns: Returns the created ColourValue.

Definition at line 333 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Gray ( )

static

Creates a ColourValue representing the colour Gray.

Returns: Returns the created ColourValue.

Definition at line 336 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Green ( )

static

Creates a ColourValue representing the colour Green.

Returns: Returns the created ColourValue.

Definition at line 339 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::GreenYellow ( )

static

Creates a ColourValue representing the colour GreenYellow.

Returns: Returns the created ColourValue.

Definition at line 342 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::HoneyDew ( )

static

Creates a ColourValue representing the colour HoneyDew.

Returns: Returns the created ColourValue.

Definition at line 345 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::HotPink ( )

static

Creates a ColourValue representing the colour HotPink.

Returns: Returns the created ColourValue.

Definition at line 348 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::IndianRed ( )

static

Creates a ColourValue representing the colour IndianRed.

Returns: Returns the created ColourValue.

Definition at line 351 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Indigo ( )

static

Creates a ColourValue representing the colour Indigo.

Returns: Returns the created ColourValue.

Definition at line 354 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Ivory ( )

static

Creates a ColourValue representing the colour Ivory.

Returns: Returns the created ColourValue.

Definition at line 357 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Khaki ( )

static

Creates a ColourValue representing the colour Khaki.

Returns: Returns the created ColourValue.

Definition at line 360 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Lavender ( )

static

Creates a ColourValue representing the colour Lavender.

Returns: Returns the created ColourValue.

Definition at line 363 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LavenderBlush ( )

static

Creates a ColourValue representing the colour LavenderBlush.

Returns: Returns the created ColourValue.

Definition at line 366 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LawnGreen ( )

static

Creates a ColourValue representing the colour LawnGreen.

Returns: Returns the created ColourValue.

Definition at line 369 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LemonChiffon ( )

static

Creates a ColourValue representing the colour LemonChiffon.

Returns: Returns the created ColourValue.

Definition at line 372 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightBlue ( )

static

Creates a ColourValue representing the colour LightBlue.

Returns: Returns the created ColourValue.

Definition at line 375 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightCoral ( )

static

Creates a ColourValue representing the colour LightCoral.

Returns: Returns the created ColourValue.

Definition at line 378 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightCyan ( )

static

Creates a ColourValue representing the colour LightCyan.

Returns: Returns the created ColourValue.

Definition at line 381 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGoldenRodYellow ( )

static

Creates a ColourValue representing the colour LightGoldenRodYellow.

Returns: Returns the created ColourValue.

Definition at line 384 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGray ( )

static

Creates a ColourValue representing the colour LightGray.

Returns: Returns the created ColourValue.

Definition at line 387 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightGreen ( )

static

Creates a ColourValue representing the colour LightGreen.

Returns: Returns the created ColourValue.

Definition at line 390 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightPink ( )

static

Creates a ColourValue representing the colour LightPink.

Returns: Returns the created ColourValue.

Definition at line 393 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSalmon ( )

static

Creates a ColourValue representing the colour LightSalmon.

Returns: Returns the created ColourValue.

Definition at line 396 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSeaGreen ( )

static

Creates a ColourValue representing the colour LightSeaGreen.

Returns: Returns the created ColourValue.

Definition at line 399 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSkyBlue ( )

static

Creates a ColourValue representing the colour LightSkyBlue.

Returns: Returns the created ColourValue.

Definition at line 402 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSlateGray ( )

static

Creates a ColourValue representing the colour LightSlateGray.

Returns: Returns the created ColourValue.

Definition at line 405 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightSteelBlue ( )

static

Creates a ColourValue representing the colour LightSteelBlue.

Returns: Returns the created ColourValue.

Definition at line 408 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LightYellow ( )

static

Creates a ColourValue representing the colour LightYellow.

Returns: Returns the created ColourValue.

Definition at line 411 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Lime ( )

static

Creates a ColourValue representing the colour Lime.

Returns: Returns the created ColourValue.

Definition at line 414 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::LimeGreen ( )

static

Creates a ColourValue representing the colour LimeGreen.

Returns: Returns the created ColourValue.

Definition at line 417 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Linen ( )

static

Creates a ColourValue representing the colour Linen.

Returns: Returns the created ColourValue.

Definition at line 420 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Magenta ( )

static

Creates a ColourValue representing the colour Magenta.

Returns: Returns the created ColourValue.

Definition at line 423 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Maroon ( )

static

Creates a ColourValue representing the colour Maroon.

Returns: Returns the created ColourValue.

Definition at line 426 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumAquamarine ( )

static

Creates a ColourValue representing the colour MediumAquamarine.

Returns: Returns the created ColourValue.

Definition at line 429 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumBlue ( )

static

Creates a ColourValue representing the colour MediumBlue.

Returns: Returns the created ColourValue.

Definition at line 432 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumOrchid ( )

static

Creates a ColourValue representing the colour MediumOrchid.

Returns: Returns the created ColourValue.

Definition at line 435 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumPurple ( )

static

Creates a ColourValue representing the colour MediumPurple.

Returns: Returns the created ColourValue.

Definition at line 438 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSeaGreen ( )

static

Creates a ColourValue representing the colour MediumSeaGreen.

Returns: Returns the created ColourValue.

Definition at line 441 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSlateBlue ( )

static

Creates a ColourValue representing the colour MediumSlateBlue.

Returns: Returns the created ColourValue.

Definition at line 444 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumSpringGreen ( )

static

Creates a ColourValue representing the colour MediumSpringGreen.

Returns: Returns the created ColourValue.

Definition at line 447 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumTurquoise ( )

static

Creates a ColourValue representing the colour MediumTurquoise.

Returns: Returns the created ColourValue.

Definition at line 450 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MediumVioletRed ( )

static

Creates a ColourValue representing the colour MediumVioletRed.

Returns: Returns the created ColourValue.

Definition at line 453 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MidnightBlue ( )

static

Creates a ColourValue representing the colour MidnightBlue.

Returns: Returns the created ColourValue.

Definition at line 456 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MintCream ( )

static

Creates a ColourValue representing the colour MintCream.

Returns: Returns the created ColourValue.

Definition at line 459 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::MistyRose ( )

static

Creates a ColourValue representing the colour MistyRose.

Returns: Returns the created ColourValue.

Definition at line 462 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Moccasin ( )

static

Creates a ColourValue representing the colour Moccasin.

Returns: Returns the created ColourValue.

Definition at line 465 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::NavajoWhite ( )

static

Creates a ColourValue representing the colour NavajoWhite.

Returns: Returns the created ColourValue.

Definition at line 468 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Navy ( )

static

Creates a ColourValue representing the colour Navy.

Returns: Returns the created ColourValue.

Definition at line 471 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OldLace ( )

static

Creates a ColourValue representing the colour OldLace.

Returns: Returns the created ColourValue.

Definition at line 474 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Olive ( )

static

Creates a ColourValue representing the colour Olive.

Returns: Returns the created ColourValue.

Definition at line 477 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OliveDrab ( )

static

Creates a ColourValue representing the colour OliveDrab.

Returns: Returns the created ColourValue.

Definition at line 480 of file colourvalue.cpp.

Boole Mezzanine::ColourValue::operator!= ( const ColourValue & Colour ) const

Inequality Comparison Operator.

Parameters

Colour This is another ColourValue to compare with.

Returns: False if the colors match perfectly, True otherwise

Definition at line 166 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::operator* ( const Real Scalar )

Scalar Multiplication Operator.

Parameters

Scalar The Scalar to multiply all the colour channels by.

Returns: Returns a new ColourValue with the updated values.

Definition at line 142 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::operator* ( const ColourValue & Colour )

Multiplication Operator.

Parameters

Colour The ColourValue to multiply each respective colour channel by.

Returns: Returns a new ColourValue with the updated values.

Definition at line 151 of file colourvalue.cpp.

ColourValue & Mezzanine::ColourValue::operator*= ( const ColourValue & Colour )

Multiplication Operator.

Parameters

Colour The ColourValue to multiply each respective colour channel by.

Returns: Returns a new ColourValue with the updated values.

Definition at line 160 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::operator+ ( const ColourValue & Colour )

Addition Operator.

Parameters

Colour The ColourValue to add each respective colour channel by.

Returns: Returns a new ColourValue with the updated values.

Definition at line 145 of file colourvalue.cpp.

ColourValue & Mezzanine::ColourValue::operator+= ( const ColourValue & Colour )

Addition Operator.

Parameters

Colour The ColourValue to add each respective colour channel by.

Returns: Returns a new ColourValue with the updated values.

Definition at line 154 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::operator- ( const ColourValue & Colour )

Subtraction Operator.

Parameters

Colour The ColourValue to subtract each respective colour channel by.

Returns: Retruns a new ColourValue with the updated values.

Definition at line 148 of file colourvalue.cpp.

ColourValue & Mezzanine::ColourValue::operator-= ( const ColourValue & Colour )

Subtraction Operator.

Parameters

Colour The ColourValue to subtract each respective colour channel by.

Returns: Retruns a new ColourValue with the updated values.

Definition at line 157 of file colourvalue.cpp.

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

Assignment operator.

Parameters

OtherColour The colour values you want to overwrite this colour's values with.

Definition at line 169 of file colourvalue.cpp.

Boole Mezzanine::ColourValue::operator== ( const ColourValue & Colour ) const

Equality Comparison Operator.

Parameters

Colour This is another ColourValue to compare with.

Returns: True if the colors match perfectly, false otherwise

Definition at line 163 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Orange ( )

static

Creates a ColourValue representing the colour Orange.

Returns: Returns the created ColourValue.

Definition at line 483 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::OrangeRed ( )

static

Creates a ColourValue representing the colour OrangeRed.

Returns: Returns the created ColourValue.

Definition at line 486 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Orchid ( )

static

Creates a ColourValue representing the colour Orchid.

Returns: Returns the created ColourValue.

Definition at line 489 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleGoldenRod ( )

static

Creates a ColourValue representing the colour PaleGoldenRod.

Returns: Returns the created ColourValue.

Definition at line 492 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleGreen ( )

static

Creates a ColourValue representing the colour PaleGreen.

Returns: Returns the created ColourValue.

Definition at line 495 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleTurquoise ( )

static

Creates a ColourValue representing the colour PaleTurquoise.

Returns: Returns the created ColourValue.

Definition at line 498 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PaleVioletRed ( )

static

Creates a ColourValue representing the colour PaleVioletRed.

Returns: Returns the created ColourValue.

Definition at line 501 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PapayaWhip ( )

static

Creates a ColourValue representing the colour PapayaWhip.

Returns: Returns the created ColourValue.

Definition at line 504 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PeachPuff ( )

static

Creates a ColourValue representing the colour PeachPuff.

Returns: Returns the created ColourValue.

Definition at line 507 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Peru ( )

static

Creates a ColourValue representing the colour Peru.

Returns: Returns the created ColourValue.

Definition at line 510 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Pink ( )

static

Creates a ColourValue representing the colour Pink.

Returns: Returns the created ColourValue.

Definition at line 513 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Plum ( )

static

Creates a ColourValue representing the colour Plum.

Returns: Returns the created ColourValue.

Definition at line 516 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::PowderBlue ( )

static

Creates a ColourValue representing the colour PowderBlue.

Returns: Returns the created ColourValue.

Definition at line 519 of file colourvalue.cpp.

void Mezzanine::ColourValue::ProtoDeSerialize ( const XML::Node & OneNode )

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

Parameters

OneNode An XML::Node containing the data.

Definition at line 633 of file colourvalue.cpp.

void Mezzanine::ColourValue::ProtoSerialize ( XML::Node & CurrentRoot ) const

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

Parameters

CurrentRoot The point in the XML hierarchy that all this ColourValue should be appended to.

Definition at line 609 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Purple ( )

static

Creates a ColourValue representing the colour Purple.

Returns: Returns the created ColourValue.

Definition at line 522 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Red ( )

static

Creates a ColourValue representing the colour Red.

Returns: Returns the created ColourValue.

Definition at line 525 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::RosyBrown ( )

static

Creates a ColourValue representing the colour RosyBrown.

Returns: Returns the created ColourValue.

Definition at line 528 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::RoyalBlue ( )

static

Creates a ColourValue representing the colour RoyalBlue.

Returns: Returns the created ColourValue.

Definition at line 531 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SaddleBrown ( )

static

Creates a ColourValue representing the colour SaddleBrown.

Returns: Returns the created ColourValue.

Definition at line 534 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Salmon ( )

static

Creates a ColourValue representing the colour Salmon.

Returns: Returns the created ColourValue.

Definition at line 537 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SandyBrown ( )

static

Creates a ColourValue representing the colour SandyBrown.

Returns: Returns the created ColourValue.

Definition at line 540 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SeaGreen ( )

static

Creates a ColourValue representing the colour SeaGreen.

Returns: Returns the created ColourValue.

Definition at line 543 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SeaShell ( )

static

Creates a ColourValue representing the colour SeaShell.

Returns: Returns the created ColourValue.

Definition at line 546 of file colourvalue.cpp.

void Mezzanine::ColourValue::SetAlphaChannel ( const Real Alpha )

Set the Alpha component of this color.

Parameters

Alpha A Real between 0 and 1 signify how much Opaque/Transparent this will color with have.

Definition at line 117 of file colourvalue.cpp.

void Mezzanine::ColourValue::SetBlueChannel ( const Real Blue )

Set the Blue component of this color.

Parameters

Blue	A Real between 0 and 1 signify how much Blue this will color with have.

Definition at line 111 of file colourvalue.cpp.

void Mezzanine::ColourValue::SetGreenChannel ( const Real Green )

Set the Green component of this color.

Parameters

Green A Real between 0 and 1 signify how much Green this will color with have.

Definition at line 105 of file colourvalue.cpp.

void Mezzanine::ColourValue::SetRedChannel ( const Real Red )

Set the Red component of this color.

Parameters

Red	A Real between 0 and 1 signify how much red this will color with have.

Definition at line 99 of file colourvalue.cpp.

void Mezzanine::ColourValue::SetValues	(	const Real	Red,
		const Real	Green,
		const Real	Blue,
		const Real	Alpha
	)

Sets each of the colour channels.

Parameters

Red	A Real between 0 and 1 signify how much red this will color with have.
Green	A Real between 0 and 1 signify how much Green this will color with have.
Blue	A Real between 0 and 1 signify how much Blue this will color with have.
Alpha	A Real between 0 and 1 signify how much Opaque/Transparent this will color with have.

Definition at line 123 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Sienna ( )

static

Creates a ColourValue representing the colour Sienna.

Returns: Returns the created ColourValue.

Definition at line 549 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Silver ( )

static

Creates a ColourValue representing the colour Silver.

Returns: Returns the created ColourValue.

Definition at line 552 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SkyBlue ( )

static

Creates a ColourValue representing the colour SkyBlue.

Returns: Returns the created ColourValue.

Definition at line 555 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SlateBlue ( )

static

Creates a ColourValue representing the colour SlateBlue.

Returns: Returns the created ColourValue.

Definition at line 558 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SlateGray ( )

static

Creates a ColourValue representing the colour SlateGray.

Returns: Returns the created ColourValue.

Definition at line 561 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Snow ( )

static

Creates a ColourValue representing the colour Snow.

Returns: Returns the created ColourValue.

Definition at line 564 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SpringGreen ( )

static

Creates a ColourValue representing the colour SpringGreen.

Returns: Returns the created ColourValue.

Definition at line 567 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::SteelBlue ( )

static

Creates a ColourValue representing the colour SteelBlue.

Returns: Returns the created ColourValue.

Definition at line 570 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Tan ( )

static

Creates a ColourValue representing the colour Tan.

Returns: Returns the created ColourValue.

Definition at line 573 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Teal ( )

static

Creates a ColourValue representing the colour Teal.

Returns: Returns the created ColourValue.

Definition at line 576 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Thistle ( )

static

Creates a ColourValue representing the colour Thistle.

Returns: Returns the created ColourValue.

Definition at line 579 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Tomato ( )

static

Creates a ColourValue representing the colour Tomato.

Returns: Returns the created ColourValue.

Definition at line 582 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Transparent ( )

static

Creates a ColourValue representing no colour.

Returns: Returns the created ColourValue.

Definition at line 180 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Turquoise ( )

static

Creates a ColourValue representing the colour Turquoise.

Returns: Returns the created ColourValue.

Definition at line 585 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Violet ( )

static

Creates a ColourValue representing the colour Violet.

Returns: Returns the created ColourValue.

Definition at line 588 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Wheat ( )

static

Creates a ColourValue representing the colour Wheat.

Returns: Returns the created ColourValue.

Definition at line 591 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::White ( )

static

Creates a ColourValue representing the colour White.

Returns: Returns the created ColourValue.

Definition at line 594 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::WhiteSmoke ( )

static

Creates a ColourValue representing the colour WhiteSmoke.

Returns: Returns the created ColourValue.

Definition at line 597 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::Yellow ( )

static

Creates a ColourValue representing the colour Yellow.

Returns: Returns the created ColourValue.

Definition at line 600 of file colourvalue.cpp.

ColourValue Mezzanine::ColourValue::YellowGreen ( )

static

Creates a ColourValue representing the colour YellowGreen.

Returns: Returns the created ColourValue.

Definition at line 603 of file colourvalue.cpp.

Member Data Documentation

Real Mezzanine::ColourValue::AlphaChannel

Value from 0.0 to 1.0 representing the transparency of the colours. 1.0 is opaque and 0.0 is clear.

Note: Not accessible from scripting languages

Definition at line 79 of file colourvalue.h.

Real Mezzanine::ColourValue::BlueChannel

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.

Note: Not accessible from scripting languages

Definition at line 76 of file colourvalue.h.

Real Mezzanine::ColourValue::GreenChannel

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.

Note: Not accessible from scripting languages

Definition at line 73 of file colourvalue.h.

Real Mezzanine::ColourValue::RedChannel

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.

Note: Not accessible from scripting languages

Definition at line 70 of file colourvalue.h.

The documentation for this class was generated from the following files:

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/colourvalue.h
/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/colourvalue.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation