new PIXI.Graphics()
Extends
Members
-
alphanumber
-
The opacity of the object.
-
blendModenumber
-
The blend mode to be applied to the graphic shape. Apply a value of
PIXI.BLEND_MODES.NORMALto reset the blend mode.- Default Value:
- PIXI.BLEND_MODES.NORMAL;
- See:
-
boundsPaddingnumber
-
The bounds' padding used for bounds calculation.
-
cacheAsBitmapboolean
-
When cacheAsBitmap is set to true the graphics object will 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 in exchange for taking up texture memory. It is also useful if you need the graphics
object to be anti-aliased, because it will be rendered using canvas. This is not recommended if
you are constantly redrawing the graphics element.- Default Value:
- false
-
readonlychildrenArray.<PIXI.DisplayObject>
-
The array of children of this container.
-
fillAlphanumber
-
The alpha value used when filling the Graphics object.
- Default Value:
- 1
-
filterAreaPIXI.Rectangle
-
The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangleAlso works as an interaction mask
-
filtersArray.<PIXI.Filter>
-
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'
- IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
-
heightnumber
-
The height of the Container, setting this will actually modify the scale to achieve the value set
-
isMaskboolean
-
Whether this shape is being used as a mask.
-
lineColorstring
-
The color of any lines drawn.
- Default Value:
- 0
-
lineWidthnumber
-
The width (thickness) of any lines drawn.
- Default Value:
- 0
-
readonlylocalTransformPIXI.Matrix
-
Current transform of the object based on local factors: position, scale, other stuff
-
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 or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.- TODO
-
- For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-
readonlyparentPIXI.Container
-
The display object container that contains this display object.
-
The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4. -
positionPIXI.Point PIXI.ObservablePoint
-
The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4. -
renderableboolean
-
Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.Only affects recursive calls from parent. You can ask for bounds manually
-
rotationnumber
-
The rotation of the object in radians.
-
The scale factor of the object.
Assignment by value since pixi-v4. -
The skew factor for the object in radians.
Assignment by value since pixi-v4. -
tintnumber
-
The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to
reset the tint.- Default Value:
- 0xFFFFFF
-
transformPIXI.TransformBase
-
World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing -
visibleboolean
-
The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
-
widthnumber
-
The width of the Container, setting this will actually modify the scale to achieve the value set
-
readonlyworldAlphanumber
-
The multiplied alpha of the displayObject
-
readonlyworldTransformPIXI.Matrix
-
Current transform of the object based on world (parent) factors
-
readonlyworldVisibleboolean
-
Indicates if the object is globally visible.
-
xnumber
-
The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x -
ynumber
-
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
Methods
-
inherited _recursivePostUpdateTransform()
-
recursively updates transform of all objects from the root to this one
internal function for toLocal() -
inherited addChild(child){PIXI.DisplayObject}
-
Adds one or more children to the container.
Multiple items can be added like so:
myContainer.addChild(thingOne, thingTwo, thingThree)Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to add to the container
Returns:
Type Description PIXI.DisplayObject The first child that was added. -
inherited addChildAt(child, index){PIXI.DisplayObject}
-
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Name Type Description childPIXI.DisplayObject The child to add
indexnumber The index to place the child in
Returns:
Type Description PIXI.DisplayObject The child that was added. -
addHole(){PIXI.Graphics}
-
Adds a hole in the current path.
Returns:
Type Description PIXI.Graphics Returns itself. -
arc(cx, cy, radius, startAngle, endAngle, anticlockwise){PIXI.Graphics}
-
The arc method creates an arc/curve (used to create circles, or parts of circles).
Name Type Default Description cxnumber The x-coordinate of the center of the circle
cynumber The y-coordinate of the center of the circle
radiusnumber The radius of the circle
startAnglenumber The starting angle, in radians (0 is at the 3 o'clock position
of the arc's circle)endAnglenumber The ending angle, in radians
anticlockwiseboolean false optional Specifies whether the drawing should be
counter-clockwise or clockwise. False is default, and indicates clockwise, while true
indicates counter-clockwise.Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
arcTo(x1, y1, x2, y2, radius){PIXI.Graphics}
-
The arcTo() method creates an arc/curve between two tangents on the canvas.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
Name Type Description x1number The x-coordinate of the beginning of the arc
y1number The y-coordinate of the beginning of the arc
x2number The x-coordinate of the end of the arc
y2number The y-coordinate of the end of the arc
radiusnumber The radius of the arc
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
beginFill(color, alpha){PIXI.Graphics}
-
Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.Name Type Default Description colornumber 0 optional the color of the fill
alphanumber 1 optional the alpha of the fill
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY){PIXI.Graphics}
-
Calculate the points for a bezier curve and then draws it.
Name Type Description cpXnumber Control point x
cpYnumber Control point y
cpX2number Second Control point x
cpY2number Second Control point y
toXnumber Destination point x
toYnumber Destination point y
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
inherited calculateBounds()
-
Recalculates the bounds of the container.
-
clear(){PIXI.Graphics}
-
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
clone(){PIXI.Graphics}
-
Creates a new Graphics object with the same values as this one.
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)Returns:
Type Description PIXI.Graphics A clone of the graphics object -
closePath(){PIXI.Graphics}
-
Closes the current path.
Returns:
Type Description PIXI.Graphics Returns itself. -
containsPoint(point){boolean}
-
Tests if a point is inside this graphics object
Name Type Description pointPIXI.Point the point to test
Returns:
Type Description boolean the result of the test -
destroy(options)
-
Destroys the Graphics object.
Name Type Description optionsobject | boolean optional Options parameter. A boolean will act as if all
options have been set to that valueName Type Default Description childrenboolean false optional if set to true, all the children will have
their destroy method called as well. 'options' will be passed on to those calls.textureboolean false optional Only used for child Sprites if options.children is set to true
Should it destroy the texture of the child spritebaseTextureboolean false optional Only used for child Sprites if options.children is set to true
Should it destroy the base texture of the child sprite -
drawCircle(x, y, radius){PIXI.Graphics}
-
Draws a circle.
Name Type Description xnumber The X coordinate of the center of the circle
ynumber The Y coordinate of the center of the circle
radiusnumber The radius of the circle
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawEllipse(x, y, width, height){PIXI.Graphics}
-
Draws an ellipse.
Name Type Description xnumber The X coordinate of the center of the ellipse
ynumber The Y coordinate of the center of the ellipse
widthnumber The half width of the ellipse
heightnumber The half height of the ellipse
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawPolygon(path){PIXI.Graphics}
-
Draws a polygon using the given path.
Name Type Description pathArray.<number> | Array.<PIXI.Point> The path data used to construct the polygon.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawRect(x, y, width, height){PIXI.Graphics}
-
Name Type Description xnumber The X coord of the top-left of the rectangle
ynumber The Y coord of the top-left of the rectangle
widthnumber The width of the rectangle
heightnumber The height of the rectangle
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawRoundedRect(x, y, width, height, radius){PIXI.Graphics}
-
Name Type Description xnumber The X coord of the top-left of the rectangle
ynumber The Y coord of the top-left of the rectangle
widthnumber The width of the rectangle
heightnumber The height of the rectangle
radiusnumber Radius of the rectangle corners
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
drawShape(shape){PIXI.GraphicsData}
-
Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
Name Type Description shapePIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.Rectangle | PIXI.RoundedRectangle The shape object to draw.
Returns:
Type Description PIXI.GraphicsData The generated GraphicsData object. -
endFill(){PIXI.Graphics}
-
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
generateCanvasTexture(scaleMode, resolution){PIXI.Texture}
-
Generates a canvas texture.
Name Type Default Description scaleModenumber The scale mode of the texture.
resolutionnumber 1 The resolution of the texture.
Returns:
Type Description PIXI.Texture The new texture. -
inherited getBounds(skipUpdate, rect){PIXI.Rectangle}
-
Retrieves the bounds of the displayObject as a rectangle object.
Name Type Description skipUpdateboolean setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boostrectPIXI.Rectangle Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
inherited getChildAt(index){PIXI.DisplayObject}
-
Returns the child at the specified index
Name Type Description indexnumber The index to get the child at
Returns:
Type Description PIXI.DisplayObject The child at the given index, if any. -
inherited getChildIndex(child){number}
-
Returns the index position of a child DisplayObject instance
Name Type Description childPIXI.DisplayObject The DisplayObject instance to identify
Returns:
Type Description number The index position of the child display object to identify -
inherited getLocalBounds(rect){PIXI.Rectangle}
-
Retrieves the local bounds of the displayObject as a rectangle object
Name Type Description rectPIXI.Rectangle optional Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
isFastRect(){boolean}
-
True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
masked with gl.scissor.Returns:
Type Description boolean True if only 1 rect. -
lineStyle(lineWidth, color, alpha){PIXI.Graphics}
-
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
method or the drawCircle() method.Name Type Default Description lineWidthnumber 0 optional width of the line to draw, will update the objects stored style
colornumber 0 optional color of the line to draw, will update the objects stored style
alphanumber 1 optional alpha of the line to draw, will update the objects stored style
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
lineTo(x, y){PIXI.Graphics}
-
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).Name Type Description xnumber the X coordinate to draw to
ynumber the Y coordinate to draw to
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
moveTo(x, y){PIXI.Graphics}
-
Moves the current drawing position to x, y.
Name Type Description xnumber the X coordinate to move to
ynumber the Y coordinate to move to
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
quadraticCurveTo(cpX, cpY, toX, toY){PIXI.Graphics}
-
Calculate the points for a quadratic bezier curve and then draws it.
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-cName Type Description cpXnumber Control point x
cpYnumber Control point y
toXnumber Destination point x
toYnumber Destination point y
Returns:
Type Description PIXI.Graphics This Graphics object. Good for chaining method calls -
inherited removeChild(child){PIXI.DisplayObject}
-
Removes one or more children from the container.
Name Type Description childPIXI.DisplayObject repeatable The DisplayObject(s) to remove
Returns:
Type Description PIXI.DisplayObject The first child that was removed. -
inherited removeChildAt(index){PIXI.DisplayObject}
-
Removes a child from the specified index position.
Name Type Description indexnumber The index to get the child from
Returns:
Type Description PIXI.DisplayObject The child that was removed. -
inherited removeChildren(beginIndex, endIndex){Array.<DisplayObject>}
-
Removes all children from this container that are within the begin and end indexes.
Name Type Default Description beginIndexnumber 0 optional The beginning position.
endIndexnumber this.children.length optional The ending position. Default value is size of the container.
Returns:
Type Description Array.<DisplayObject> List of removed children -
inherited renderCanvas(renderer)
-
Renders the object using the Canvas renderer
Name Type Description rendererPIXI.CanvasRenderer The renderer
-
inherited renderWebGL(renderer)
-
Renders the object using the WebGL renderer
Name Type Description rendererPIXI.WebGLRenderer The renderer
-
inherited setChildIndex(child, index)
-
Changes the position of an existing child in the display object container
Name Type Description childPIXI.DisplayObject The child DisplayObject instance for which you want to change the index number
indexnumber The resulting index number for the child display object
-
inherited setParent(container){PIXI.Container}
-
Set the parent Container of this DisplayObject
Name Type Description containerPIXI.Container The Container to add this DisplayObject to
Returns:
Type Description PIXI.Container The Container that this DisplayObject was added to -
inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}
-
Convenience function to set the position, scale, skew and pivot at once.
Name Type Default Description xnumber 0 optional The X position
ynumber 0 optional The Y position
scaleXnumber 1 optional The X scale value
scaleYnumber 1 optional The Y scale value
rotationnumber 0 optional The rotation
skewXnumber 0 optional The X skew value
skewYnumber 0 optional The Y skew value
pivotXnumber 0 optional The X pivot value
pivotYnumber 0 optional The Y pivot value
Returns:
Type Description PIXI.DisplayObject The DisplayObject instance -
inherited swapChildren(child, child2)
-
Swaps the position of 2 Display Objects within this container.
Name Type Description childPIXI.DisplayObject First display object to swap
child2PIXI.DisplayObject Second display object to swap
-
inherited toGlobal(position, point, skipUpdate){PIXI.Point}
-
Calculates the global position of the display object
Name Type Default Description positionPIXI.Point The world origin to calculate from
pointPIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdateboolean false optional Should we skip the update transform.
Returns:
Type Description PIXI.Point A point object representing the position of this object -
inherited toLocal(position, from, point, skipUpdate){PIXI.Point}
-
Calculates the local position of the display object relative to another point
Name Type Default Description positionPIXI.Point The world origin to calculate from
fromPIXI.DisplayObject optional The DisplayObject to calculate the global position from
pointPIXI.Point optional A Point object in which to store the value, optional
(otherwise will create a new Point)skipUpdateboolean false optional Should we skip the update transform
Returns:
Type Description PIXI.Point A point object representing the position of this object -
updateLocalBounds()
-
Update the bounds of the object
-
inherited updateTransform()
-
Updates the transform on all children of this container for rendering