PowerUI.Css.BackgroundColour Class Reference

Detailed Description

Represents the solid background colour of an element.

Inheritance diagram for PowerUI.Css.BackgroundColour:

Public Member Functions
	BackgroundColour (Element element)
	Creates a new solid background colour property for the given element. More...
override void	SetOverlayColour (Color colour)
	Called to apply the given colour overlay to this property. More...
override void	Paint ()
	Called when a paint event occurs. Paint events don't relocate the whole UI so are quick and efficient. More...
Public Member Functions inherited from PowerUI.Css.DisplayableProperty
	DisplayableProperty (Element element)
	Creates a new displayable property for the given element. More...
void	SetVisibility (bool visible)
	Call this when the visibility of this property as a whole changes. More...
void	SetOverlayColour ()
	Sets the overlay colour from the elements colour overlay property. More...
void	ColourChanged ()
	Call this when any colour of this property has changed. More...
virtual void	OnBatchDestroy ()
	Called when the isolation batch for this property gets removed. More...
void	Change (string property, Value newValue)
	Called when a named css property changes. More...
void	ClearBlocks ()
	Clears all mesh blocks that this property has allocated. More...
void	WentOffScreen ()
Vector3	MapPX (float x, float y, float z)
	Maps the given pixel location to a world location. More...
void	Render ()
	Make this property visible by forcing it to redraw. More...
void	RequestPaint ()
	Requests for a paint event to occur. Note that paint events are more efficient than a layout as they only refresh the mesh colours and uvs rather than the whole mesh. More...
void	RequestLayout ()
	Requests for a layout event to occur. Note that paint events are more efficient than a layout as they only refresh the mesh colours and uvs rather than the whole mesh. More...
MeshBlock	Add ()
	Allocates a new mesh block for this property to use. Mesh blocks are the core of how PowerUI displays content. More...
void	Transform (Transformation topTransform)
	Transforms all the blocks that this property has allocated. Note that transformations are a post process. More...
void	ApplyTransform ()
	Applies any transforms (rotate,scale etc) now. Note that tranforms are post-processes so they are very fast and mostly done by paint events. More...
void	Isolate ()
	Isolates this property from the rest of the UI such that it can have a custom mesh/shader/texture etc. More...
void	Include ()
	Reverses PowerUI.Css.DisplayableProperty.Isolate by re-including this property in the main UI batch. More...
bool	IsIsolated ()
	Checks if this is an isolated property - that's one which is seperate and takes its own drawcall. More...
void	SetupBatch (TextureAtlas graphics, TextureAtlas font)
AtlasLocation	RequireImage (AtlasEntity image)

Public Attributes
Color	BaseColour
	The colour the background should be with no colour overlay. More...
Color	BackingColour
	The colour the background should be with any colour overlay applied. More...
Public Attributes inherited from PowerUI.Css.DisplayableProperty
bool	Visible
	True if this is currently visible on screen. More...
bool	Changed
	True if this property has changed its appearance. More...
bool	Isolated
	True if this property is isolated and has a seperate mesh and material from everything else. More...
int	BlockCount
	The number of mesh blocks that this property has allocated. More...
Element	Element
	The parent element that this is a property of. More...
MeshBlock	FirstBlock
	The first mesh block that this property has allocated. This is the head of a linked list. More...
bool	GotBatchAlready
	Only applies to Isolated properties. Set to true when this property has allocated a UIBatch on the current layout. More...

Protected Member Functions
override void	Layout ()
	Called when a layout event occurs. Layout events relocate the whole UI so should be used less frequently than a paint event. More...
Protected Member Functions inherited from PowerUI.Css.DisplayableProperty
virtual bool	NowOnScreen ()
	Called when this element goes on screen. More...
virtual void	NowOffScreen ()
	Called when this element goes off screen (or is removed from the DOM). More...
virtual void	OnChange (string property, Value newValue)
	Called when a named css property changes. More...

Additional Inherited Members
Properties inherited from PowerUI.Css.DisplayableProperty
bool	Paintable [get]
	Checks if this property can be repainted. More...

Constructor & Destructor Documentation

PowerUI.Css.BackgroundColour.BackgroundColour ( Element  element)

inline

Creates a new solid background colour property for the given element.

Parameters

element

The element to give a border to.

Member Function Documentation

override void PowerUI.Css.BackgroundColour.Layout ( )

inlineprotectedvirtual

Called when a layout event occurs. Layout events relocate the whole UI so should be used less frequently than a paint event.

Reimplemented from PowerUI.Css.DisplayableProperty.

override void PowerUI.Css.BackgroundColour.Paint ( )

inlinevirtual

Called when a paint event occurs. Paint events don't relocate the whole UI so are quick and efficient.

Reimplemented from PowerUI.Css.DisplayableProperty.

override void PowerUI.Css.BackgroundColour.SetOverlayColour ( Color  colour)

inlinevirtual

Called to apply the given colour overlay to this property.

Parameters

colour

The colour overlay to apply.

Reimplemented from PowerUI.Css.DisplayableProperty.

Member Data Documentation

Color PowerUI.Css.BackgroundColour.BackingColour

The colour the background should be with any colour overlay applied.

Color PowerUI.Css.BackgroundColour.BaseColour

The colour the background should be with no colour overlay.