Detailed Description

Represents a canvas context which lets you draw 2D shapes and polygons on the UI. See the canvas html tag for more information.

Inheritance diagram for PowerUI.CanvasContext:

Public Member Functions
	CanvasContext (CanvasTag tag)
	Creates a new canvas context for the given canvas element. More...

Glyph	ToGlyph ()
	Creates an infinitext glyph from the path you've just made. More...

void	beginPath ()
	Starts creating a path on this context. Used to draw and fill in any kind of shape. More...

void	closePath ()
	Closes the current path such that it forms a loop by drawing a line to the first node. More...

void	lineTo (float x, float y)
	Adds a line from the current pen location to the given point. Note that nothing will be seen until you call a fill or stroke method. More...

void	arc (float centerX, float centerY, float radius, float sAngle, float eAngle)
	Creates an arc around the given circle center. Note that nothing will be seen until you call a fill or stroke method. More...

void	arc (float centerX, float centerY, float radius, float sAngle, float eAngle, bool counterClockwise)
	Creates an arc around the given circle center. Note that nothing will be seen until you call a fill or stroke method. More...

bool	isPointInPath (float x, float y)
	Is the specified point in (not on) the current path? More...

void	curveTo (float c1x, float c1y, float c2x, float c2y, float x, float y)

void	quadraticCurveTo (float cx, float cy, float x, float y)

void	arcTo (float x1, float y1, float x2, float y2, float radius)
	Adds an arc between the given points using the pen point as a control point. Note that nothing will be seen until you call a fill or stroke method. More...

float	Angle (float x0, float y0, float x1, float y1)
	Gets the signed angle from one vector, the first, to another. More...

void	stroke ()
	Draws the outline of path you created, and doesn't reset the path, using the stroke style. More...

void	fill ()
	Fills the current path with a solid colour. The colour used originates from the fillStyle. More...

void	moveTo (float x, float y)
	Moves the current pen location to the given point. Used when drawing paths. More...

void	ApplyImageData ()
	Applies the image data so it's ready for rendering. More...

void	apply ()
	Forces any changes to be applied right now. More...

void	Resized ()
	Called when the element is resized. More...

void	clear ()
	Useful method to clear the whole context. More...

void	clearRect (int xStart, int yStart, int width, int height)
	Clears the specified region of the canvas. More...

void	fillRect (int xStart, int yStart, int width, int height)
	Fills the specified box region using the current fillStyle. More...

void	fillRect (int xStart, int yStart, int rectWidth, int rectHeight, Color32 colour)
	Fills the specified box region using the given colour. More...

Public Attributes
Scanner	Rasteriser
	The rasteriser used to fill with. More...

VectorPath	Path
	The underlying path. More...

ImagePackage	Package
	A package containing the dynamic image. This is used to actually display the image on screen. More...

DynamicTexture	ImageData
	The target rendering plane. More...

Color32	FillColour =new Color32(0,0,0,255)
	The current fill colour. See fillStyle. Default is black. More...

Color32	StrokeColour =new Color32(0,0,0,255)
	The current stroke colour. See strokeStyle. Default is black. More...

Properties
int	PathNodeCount `[get]`
	The current number of nodes on the current path. More...

Element	canvas `[get]`
	The canvas element that this is the context for. More...

string	fillStyle `[get, set]`
	Applies the current fill style. More...

string	strokeStyle `[get, set]`
	Applies the current stroke style. More...

int	width `[get, set]`
	The width of the canvas context. More...

int	height `[get, set]`
	The height of the canvas context. More...

Private Attributes
CanvasTag	Canvas
	The tag handler for the canvas that this is a context for. More...

Constructor & Destructor Documentation

PowerUI.CanvasContext.CanvasContext ( CanvasTag tag)

inline

Creates a new canvas context for the given canvas element.

Parameters

canvas The canvas handler for a particular canvas element.

Member Function Documentation

float PowerUI.CanvasContext.Angle	(	float	x0,
		float	y0,
		float	x1,
		float	y1
	)

inline

Gets the signed angle from one vector, the first, to another.

void PowerUI.CanvasContext.apply ( )

inline

Forces any changes to be applied right now.

void PowerUI.CanvasContext.ApplyImageData ( )

inline

Applies the image data so it's ready for rendering.

void PowerUI.CanvasContext.arc	(	float	centerX,
		float	centerY,
		float	radius,
		float	sAngle,
		float	eAngle
	)

inline

Creates an arc around the given circle center. Note that nothing will be seen until you call a fill or stroke method.

void PowerUI.CanvasContext.arc	(	float	centerX,
		float	centerY,
		float	radius,
		float	sAngle,
		float	eAngle,
		bool	counterClockwise
	)

inline

Creates an arc around the given circle center. Note that nothing will be seen until you call a fill or stroke method.

void PowerUI.CanvasContext.arcTo	(	float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	radius
	)

inline

Adds an arc between the given points using the pen point as a control point. Note that nothing will be seen until you call a fill or stroke method.

void PowerUI.CanvasContext.beginPath ( )

inline

Starts creating a path on this context. Used to draw and fill in any kind of shape.

void PowerUI.CanvasContext.clear ( )

inline

Useful method to clear the whole context.

void PowerUI.CanvasContext.clearRect	(	int	xStart,
		int	yStart,
		int	width,
		int	height
	)

inline

Clears the specified region of the canvas.

void PowerUI.CanvasContext.closePath ( )

inline

Closes the current path such that it forms a loop by drawing a line to the first node.

void PowerUI.CanvasContext.curveTo	(	float	c1x,
		float	c1y,
		float	c2x,
		float	c2y,
		float	x,
		float	y
	)

inline

void PowerUI.CanvasContext.fill ( )

inline

Fills the current path with a solid colour. The colour used originates from the fillStyle.

void PowerUI.CanvasContext.fillRect	(	int	xStart,
		int	yStart,
		int	width,
		int	height
	)

inline

Fills the specified box region using the current fillStyle.

void PowerUI.CanvasContext.fillRect	(	int	xStart,
		int	yStart,
		int	rectWidth,
		int	rectHeight,
		Color32	colour
	)

inline

Fills the specified box region using the given colour.

bool PowerUI.CanvasContext.isPointInPath	(	float	x,
		float	y
	)

inline

Is the specified point in (not on) the current path?

Parameters

x	The x coordinate.
y	The y coordinate.

void PowerUI.CanvasContext.lineTo	(	float	x,
		float	y
	)

inline

Adds a line from the current pen location to the given point. Note that nothing will be seen until you call a fill or stroke method.

void PowerUI.CanvasContext.moveTo	(	float	x,
		float	y
	)

inline

Moves the current pen location to the given point. Used when drawing paths.

void PowerUI.CanvasContext.quadraticCurveTo	(	float	cx,
		float	cy,
		float	x,
		float	y
	)

inline

void PowerUI.CanvasContext.Resized ( )

inline

Called when the element is resized.

void PowerUI.CanvasContext.stroke ( )

inline

Draws the outline of path you created, and doesn't reset the path, using the stroke style.

Glyph PowerUI.CanvasContext.ToGlyph ( )

inline

Creates an infinitext glyph from the path you've just made.

Member Data Documentation

CanvasTag PowerUI.CanvasContext.Canvas

private

The tag handler for the canvas that this is a context for.

Color32 PowerUI.CanvasContext.FillColour =new Color32(0,0,0,255)

The current fill colour. See fillStyle. Default is black.

DynamicTexture PowerUI.CanvasContext.ImageData

The target rendering plane.

ImagePackage PowerUI.CanvasContext.Package

A package containing the dynamic image. This is used to actually display the image on screen.

VectorPath PowerUI.CanvasContext.Path

The underlying path.

Scanner PowerUI.CanvasContext.Rasteriser

The rasteriser used to fill with.

Color32 PowerUI.CanvasContext.StrokeColour =new Color32(0,0,0,255)

The current stroke colour. See strokeStyle. Default is black.

Property Documentation

Element PowerUI.CanvasContext.canvas

get

The canvas element that this is the context for.

string PowerUI.CanvasContext.fillStyle

getset

Applies the current fill style.

int PowerUI.CanvasContext.height

getset

The height of the canvas context.

int PowerUI.CanvasContext.PathNodeCount

get

The current number of nodes on the current path.

string PowerUI.CanvasContext.strokeStyle

getset

Applies the current stroke style.

int PowerUI.CanvasContext.width

getset

The width of the canvas context.

Detailed Description

Public Member Functions

Public Attributes

Properties

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation