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 polygons can be filled at this stage Complex polygons will not be filled. Heres an example of a complex polygon: http://www.goodboydigital.com/wp-content/uploads/2013/06/complexPolygon.png
Constructor
Graphics
()
Item Index
Methods
- _generateCachedSprite
- _renderCanvas
- _renderWebGL
- addChild
- addChildAt
- beginFill
- clear
- click
- drawCircle
- drawEllipse
- drawRect
- endFill
- generateTexture
- getBounds
- getChildAt
- getLocalBounds
- lineStyle
- lineTo
- mousedown
- mouseout
- mouseover
- mouseup
- mouseupoutside
- moveTo
- removeChild
- removeChildAt
- removeChildren
- removeStageReference
- setInteractive deprecated
- setStageReference
- swapChildren
- tap
- touchend
- touchendoutside
- touchstart
- updateBounds
Properties
- _bounds
- _currentBounds
- _interactive
- _webGL
- alpha
- blendMode
- bounds
- bounds
- buttonMode
- cacheAsBitmap
- children
- color
- currentPath
- defaultCursor
- dynamic
- fillAlpha
- filterArea
- filters
- graphicsData
- height
- hitArea
- interactive
- isMask
- lineColor
- lineWidth
- mask
- parent
- pivot
- position
- renderable
- rotation
- scale
- stage
- tint
- visible
- width
- worldAlpha
- worldTransform
- worldVisible
- x
- y
Methods
_generateCachedSprite
()
private
Generates the cached sprite when the sprite has cacheAsBitmap = true
_renderCanvas
-
renderSession
Renders the object using the Canvas renderer
Parameters:
-
renderSessionRenderSession
_renderWebGL
-
renderSession
Renders the object using the WebGL renderer
Parameters:
-
renderSessionRenderSession
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:
-
colorNumberthe color of the fill
-
alphaNumberthe alpha of the fill
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 coordinate of the center of the circle
-
yNumberThe Y coordinate of the center of the circle
-
radiusNumberThe radius of the circle
drawEllipse
-
x -
y -
width -
height
Draws an ellipse.
Parameters:
-
xNumberThe X coordinate of the upper-left corner of the framing rectangle of this ellipse
-
yNumberThe Y coordinate of the upper-left corner of the framing rectangle of this ellipse
-
widthNumberThe width of the ellipse
-
heightNumberThe height of the ellipse
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.
generateTexture
()
Texture
Useful function that returns a texture of the graphics object that can then be used to create sprites This can be quite useful if your geometry is complicated and needs to be reused multiple times.
Returns:
a texture of the graphics object
getBounds
()
Rectangle
Retrieves the bounds of the graphic shape as a rectangle object
Returns:
the rectangular bounding area
getChildAt
-
index
Returns the child at the specified index
Parameters:
-
indexNumberThe index to get the child from
getLocalBounds
()
Rectangle
Retrieves the local bounds of the displayObject as a rectangle object
Returns:
the rectangular bounding area
lineStyle
-
lineWidth -
color -
alpha
Specifies the 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 coordinate to draw to
-
yNumberthe Y coordinate 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 coordinate to move to
-
yNumberthe Y coordinate to move to
removeChild
-
child
Removes a child from the container.
Parameters:
-
childDisplayObjectThe DisplayObject to remove
removeChildAt
-
index
Removes a child from the specified index position in the child list of the container.
Parameters:
-
indexNumberThe index to get the child from
removeChildren
-
beginIndex -
endIndex
Removes all child instances from the child list of the container.
Parameters:
-
beginIndexNumberThe beginning position. Predefined value is 0.
-
endIndexNumberThe ending position. Predefined value is children's array length.
removeStageReference
()
removes the current stage reference of the container
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
setStageReference
-
stage
Sets the container's stage reference, the stage this object is connected to
Parameters:
-
stageStagethe stage that the container will have as its current stage reference
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 touches over the displayObject
Parameters:
-
interactionDataInteractionData
updateBounds
()
Update the bounds of the object
Properties
_interactive
Boolean
private
[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property
_webGL
Array
private
Array containing some WebGL-related properties used by the WebGL renderer
alpha
Number
The opacity of the object.
blendMode
Number
The blend mode to be applied to the graphic shape
Default: PIXI.blendModes.NORMAL;
bounds
Number
the bounds' padding used for bounds calculation
cacheAsBitmap
Boolean
private
If cacheAsBitmap is true the graphics object will then be rendered as if it was a sprite. This is useful if your graphics element does not change often as it will speed up the rendering of the object It is also usful as the graphics object will always be antialiased because it will be rendered using canvas Not recommended if you are constanly redrawing the graphics element.
Default: false
children
Array[read-only] The array of children of this container.
color
Array<>
private
[NYI] Unknown
currentPath
Object
private
Current path
defaultCursor
String
This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true
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
filterArea
Rectangle
The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
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
height
Number
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
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
isMask
IsMask
Whether this shape is being used as a mask
lineColor
String
The color of any lines drawn
lineWidth
Number
The width of any lines drawn
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.Graphics 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.
tint
Number
The tint applied to the graphic shape. This is a hex value
Default: 0xFFFFFF
visible
Boolean
The visibility of the object.
width
Number
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
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
worldVisible
Boolean
[read-only] Indicates if the sprite is globaly visible.
x
Number
The position of the displayObject on the x axis relative to the local coordinates of the parent.
y
Number
The position of the displayObject on the y axis relative to the local coordinates of the parent.