Graphics Class
The Graphics class contains a set of methods that you can use to create primitive shapes and lines. It is important to know that with the webGL renderer only simple polys can be filled at this stage Complex polys will not be filled. Heres an example of a complex poly: http://www.goodboydigital.com/wp-content/uploads/2013/06/complexPolygon.png
Constructor
Graphics
()
Item Index
Methods
Methods
addChild
-
child
Adds a child to the container.
Parameters:
-
childDisplayObjectThe DisplayObject to add to the container
addChildAt
-
child -
index
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Parameters:
-
childDisplayObjectThe child to add
-
indexNumberThe index to place the child in
beginFill
-
color -
alpha
Specifies a simple one-color fill that subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.
Parameters:
-
colorUintthe color of the fill
-
alphaNumberthe alpha
clear
()
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
click
-
interactionData
A callback that is used when the users clicks on the displayObject with their mouse
Parameters:
-
interactionDataInteractionData
drawCircle
-
x -
y -
radius
Draws a circle.
Parameters:
-
xNumberThe X coord of the center of the circle
-
yNumberThe Y coord of the center of the circle
-
radiusNumberThe radius of the circle
drawEllipse
-
x -
y -
width -
height
Draws an ellipse.
Parameters:
-
xNumber -
yNumber -
widthNumber -
heightNumber
drawRect
-
x -
y -
width -
height
Parameters:
-
xNumberThe X coord of the top-left of the rectangle
-
yNumberThe Y coord of the top-left of the rectangle
-
widthNumberThe width of the rectangle
-
heightNumberThe height of the rectangle
endFill
()
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
getChildAt
-
index
Returns the Child at the specified index
Parameters:
-
indexNumberThe index to get the child from
lineStyle
-
lineWidth -
color -
alpha
Specifies a line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.
Parameters:
-
lineWidthNumberwidth of the line to draw, will update the object's stored style
-
colorNumbercolor of the line to draw, will update the object's stored style
-
alphaNumberalpha of the line to draw, will update the object's stored style
lineTo
-
x -
y
Draws a line using the current line style from the current drawing position to (x, y); the current drawing position is then set to (x, y).
Parameters:
-
xNumberthe X coord to draw to
-
yNumberthe Y coord to draw to
mousedown
-
interactionData
A callback that is used when the user clicks the mouse down over the sprite
Parameters:
-
interactionDataInteractionData
mouseout
-
interactionData
A callback that is used when the users mouse leaves the displayObject
Parameters:
-
interactionDataInteractionData
mouseover
-
interactionData
A callback that is used when the users mouse rolls over the displayObject
Parameters:
-
interactionDataInteractionData
mouseup
-
interactionData
A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
mouseupoutside
-
interactionData
A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject
Parameters:
-
interactionDataInteractionData
moveTo
-
x -
y
Moves the current drawing position to (x, y).
Parameters:
-
xNumberthe X coord to move to
-
yNumberthe Y coord to move to
removeChild
-
child
Removes a child from the container.
Parameters:
-
childDisplayObjectThe DisplayObject to remove
setInteractive
-
interactive
[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false
Parameters:
-
interactiveBoolean
swapChildren
-
child -
child2
[NYI] Swaps the depth of 2 displayObjects
Parameters:
-
childDisplayObject -
child2DisplayObject
tap
-
interactionData
A callback that is used when the users taps on the sprite with their finger basically a touch version of click
Parameters:
-
interactionDataInteractionData
touchend
-
interactionData
A callback that is used when the user releases a touch over the displayObject
Parameters:
-
interactionDataInteractionData
touchendoutside
-
interactionData
A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite
Parameters:
-
interactionDataInteractionData
touchstart
-
interactionData
A callback that is used when the user touch's over the displayObject
Parameters:
-
interactionDataInteractionData
Properties
_interactive
Boolean
private
[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property
alpha
Number
The opacity of the object.
children
Array[read-only] The of children of this container.
color
Array<>
private
[NYI] Unkown
currentPath
Object
private
Current path
dynamic
Boolean
private
[NYI] Holds whether or not this object is dynamic, for rendering optimization
fillAlpha
Number
The alpha of the fill of this graphics object
filters
Array An array of filters
Sets the filters for the displayObject. * IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'
graphicsData
Array
private
Graphics data
hitArea
Rectangle | Circle | Ellipse | Polygon
This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)
interactive
Boolean
Indicates if the sprite will have touch and mouse interactivity. It is false by default
Default: false
lineColor
String
The color of any lines drawn
lineWidth
Number
The width of any lines drawn
localTransform
Mat3
private
[read-only] Current transform of the object locally
mask
Graphics
Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Ggraphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.
parent
DisplayObjectContainer
[read-only] The display object container that contains this display object.
renderable
Boolean
Can this object be rendered
rotation
Number
The rotation of the object in radians.
stage
Stage
[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.
visible
Boolean
The visibility of the object.
worldAlpha
Number
[read-only] The multiplied alpha of the displayobject
worldTransform
Mat3
private
[read-only] Current transform of the object based on world (parent) factors