FBColor Class Reference

FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor FBColor

Inheritance diagram for FBColor:

[legend]

List of all members.

---

Detailed Description

FBColor class.

Color vector.

This class creates a list like object, which can be modified using the list protocol method. But unlike lists, its length is fixed: it always contain 3 floating point values. Thus it does not support the any list methods that would affect its length. The values within can be changed, usually via the bracket operator.

    # Supported list protocol methods:
    color = FBColor()
    len(color)
    print color[0]
        color[0] = 1.0

Warning:

Slicing is not supported by this object.

See samples: LayeredTexture.py, SetAllCamerasBackgroundColor.py, SetAllCamerasBackgroundColorFromCurrentCamera.py, SetAllCamerasBackgroundColorFromFirstSelectedCamera.py.

Public Member Functions
	FBColor ()
	Constructor.
	FBColor (FBColor pColor)
	Constructor.
	FBColor (float pR, float pG, float pB)
	Constructor.
	FBColor (tuple< float, float, float >)
	Constructor.
int	__len__ ()
	Returns the number of elements.
float	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print color[1].
	__setitem__ (int pIndex, float pComponentValue)
	Sets the ith components Corresponds to python: color[1] = 0.5.
	FBColor ()
	Constructor.
	FBColor (float pValue)
	Constructor from array.
	FBColor (float pRed, float pGreen, float pBlue)
	Constructor.
	FBColor (FBColor pVector)
	Copy Constructor.

---

Constructor & Destructor Documentation

FBColor

(

)

Constructor.

Default constructor, all values within are set to 0.0, except for the Alpha value which is set to 1.0.

FBColor

(

FBColor

pColor

)

Constructor.

Copy constructor. Copy values from another instance.

FBColor	(	float	pR,
		float	pG,
		float	pB
	)

Constructor.

Explicitely construct a vector by specifying its RGBA values. Should the Alpha value not be relevant, just set it to 1.0.

FBColor

(

tuple< float, float, float >

)

Constructor.

A vector can be built from any python object with supports the tuple interface and is of a lenght of 3.

FBColor

(

)

Constructor.

FBColor

(

float

pValue

)

Constructor from array.

Parameters:

pValue

Array to take values from.

FBColor	(	float	pRed,
		float	pGreen,
		float	pBlue
	)

Constructor.

Parameters:

	pRed	Red component.
	pGreen	Green component.
	pBlue	Blue component.

FBColor

(

FBColor

pVector

)

Copy Constructor.

---

Member Function Documentation

int __len__

(

)

Returns the number of elements.

Corresponds to python: len(object)

float __getitem__

(

int

pIndex

)

Returns the ith component Corresponds to python: print color[1].

Parameters:

pIndex

Index of the components to get (0:Red, 1:Green, 2:Blue)

Returns:

Color component value.

__setitem__	(	int	pIndex,
		float	pComponentValue
	)

Sets the ith components Corresponds to python: color[1] = 0.5.

Parameters:

	pIndex	Index of the components to set (0:Red, 1:Green, 2:Blue)
	pComponentValue	Value of component to set

---