API Docs for: 2.2.1
Show:

Graphics Class

Extends DisplayObjectContainer
Defined in: pixi/primitives/Graphics.hx:18

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

()

Defined in pixi/primitives/Graphics.hx:18

Methods

addChild

(
  • child
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:43

Adds a child to the container.

Parameters:

addChildAt

(
  • child
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:51

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:

  • child DisplayObject

    The child to add

  • index Int

    The index to place the child in

arc

(
  • cx
  • cy
  • radius
  • startAngle
  • endAngle
  • [anticlockwise]
)
Graphics

Defined in pixi/primitives/Graphics.hx:29

The arc method creates an arc/curve (used to create circles, or parts of circles).

Parameters:

  • cx Float

    The x-coordinate of the center of the circle

  • cy Float

    The y-coordinate of the center of the circle

  • radius Float

    The radius of the circle

  • startAngle Float

    The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)

  • endAngle Float

    The ending angle, in radians

  • [anticlockwise] Bool optional

    Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.

Returns:

Graphics:

arc

(
  • cx
  • cy
  • radius
  • startAngle
  • endAngle
  • [anticlockwise]
)
Graphics

Defined in pixi/primitives/Graphics.hx:101

The arc() method creates an arc/curve (used to create circles, or parts of circles).

Parameters:

  • cx Float

    The x-coordinate of the center of the circle

  • cy Float

    The y-coordinate of the center of the circle

  • radius Float

    The radius of the circle

  • startAngle Float

    The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)

  • endAngle Float

    The ending angle, in radians

  • [anticlockwise] Float optional

    Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.

Returns:

Graphics:

arcTo

(
  • x1
  • y1
  • x2
  • y2
  • radius
)
Graphics

Defined in pixi/primitives/Graphics.hx:86

the arcTo() method creates an arc/curve between two tangents on the canvas.

"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!

Parameters:

  • x1 Float

    The x-coordinate of the beginning of the arc

  • y1 Float

    The y-coordinate of the beginning of the arc

  • x2 Float

    The x-coordinate of the end of the arc

  • y2 Float

    The y-coordinate of the end of the arc

  • radius Float

    The radius of the arc

Returns:

Graphics:

beginFill

(
  • color
  • [alpha]
)
Graphics

Defined in pixi/primitives/Graphics.hx:115

Specifies a simple one-color fill that subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) use when drawing.

Parameters:

  • color Int

    the color of the fill

  • [alpha] Float optional

    the alpha of the fill

Returns:

Graphics:

bezierCurveTo

(
  • cpX
  • cpY
  • cpX2
  • cpY2
  • toX
  • toY
)
Graphics

Defined in pixi/primitives/Graphics.hx:72

Calculate the points for a bezier curve.

Parameters:

  • cpX Float

    Control point x

  • cpY Float

    Control point y

  • cpX2 Float

    Second Control point x

  • cpY2 Float

    Second Control point y

  • toX Float

    Destination point x

  • toY Float

    Destination point y

Returns:

Graphics:

clear

() Graphics

Defined in pixi/primitives/Graphics.hx:189

Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.

Returns:

Graphics:

click

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:279

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:

destroyCachedSprite

()

Defined in pixi/primitives/Graphics.hx:204

Destroys a previous cached sprite.

drawCircle

(
  • x
  • y
  • radius
)
Graphics

Defined in pixi/primitives/Graphics.hx:157

Draws a circle.

Parameters:

  • x Float

    The X coordinate of the center of the circle

  • y Float

    The Y coordinate of the center of the circle

  • radius Float

    The radius of the circle

Returns:

Graphics:

drawEllipse

(
  • x
  • y
  • width
  • height
)
Graphics

Defined in pixi/primitives/Graphics.hx:168

Draws an ellipse.

Parameters:

  • x Float

    The X coordinate of the center of the ellipse

  • y Float

    The Y coordinate of the center of the ellipse

  • width Float

    The half width of the ellipse

  • height Float

    The half height of the ellipse

Returns:

Graphics:

drawPolygon

(
  • path
)
Graphics

Defined in pixi/primitives/Graphics.hx:180

Draws a polygon using the given path.

Parameters:

  • path Array

    The path data used to construct the polygon.

Returns:

Graphics:

drawRect

(
  • x
  • y
  • width
  • height
)
Graphics

Defined in pixi/primitives/Graphics.hx:134

Parameters:

  • x Float

    The X coord of the top-left of the rectangle

  • y Float

    The Y coord of the top-left of the rectangle

  • width Float

    The width of the rectangle

  • height Float

    The height of the rectangle

Returns:

Graphics:

drawRoundedRect

(
  • x
  • y
  • width
  • height
  • radius
)
Graphics

Defined in pixi/primitives/Graphics.hx:145

Parameters:

  • x Float

    The X coord of the top-left of the rectangle

  • y Float

    The Y coord of the top-left of the rectangle

  • width Float

    The width of the rectangle

  • height Float

    The height of the rectangle

  • radius Float

    Radius of the rectangle corners

Returns:

Graphics:

drawShape

(
  • shape
)
GraphicsData

Defined in pixi/primitives/Graphics.hx:218

Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.

Parameters:

Returns:

GraphicsData:

The generated GraphicsData object.

endFill

() Graphics

Defined in pixi/primitives/Graphics.hx:126

Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.

Returns:

Graphics:

generateTexture

(
  • resolution
  • scaleMode
  • [renderer]
)
Texture

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:23

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters:

  • resolution Float

    The resolution of the texture being generated

  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

  • [renderer] CanvasRenderer | WebGLRenderer optional

    The renderer used to generate the texture.

Returns:

Texture:

a texture of the graphics object

getBounds

(
  • [matrix]
)
Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:36

Retrieves the bounds of the displayObject as a rectangle object

Parameters:

Returns:

Rectangle:

the rectangular bounding area

getChildAt

(
  • index
)
DisplayObject

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:69

Returns the child at the specified index

Parameters:

  • index Int

    The index to get the child from

Returns:

DisplayObject:

getChildIndex

(
  • child
)
Int

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:112

Returns the index position of a child DisplayObject instance

Parameters:

Returns:

Int:

The index position of the child display object to identify

getLocalBounds

() Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:45

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

lineStyle

(
  • lineWidth
  • color
  • alpha
)

Defined in pixi/primitives/Graphics.hx:43

Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.

Parameters:

  • lineWidth Float

    width of the line to draw, will update the object's stored style

  • color Int

    color of the line to draw, will update the object's stored style

  • alpha Float

    [alpha] of the line to draw, will update the object's stored style

lineTo

(
  • x
  • y
)

Defined in pixi/primitives/Graphics.hx:62

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:

  • x Float

    the X coordinate to draw to

  • y Float

    the Y coordinate to draw to

mousedown

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:286

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:

mousemove

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:301

Is called when mouse is moved across the renderer element

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:272

A callback that is used when the users mouse leaves the displayObject

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:265

A callback that is used when the users mouse rolls over the displayObject

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:293

A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:308

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

moveTo

(
  • x
  • y
)

Defined in pixi/primitives/Graphics.hx:53

Moves the current drawing position to (x, y).

Parameters:

  • x Float

    the X coordinate to move to

  • y Float

    the Y coordinate to move to

removeChild

(
  • child
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:78

Removes a child from the container.

Parameters:

removeChildAt

(
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:86

Removes a child from the specified index position in the child list of the container.

Parameters:

  • index Int

    The index to get the child from

removeChildren

(
  • beginIndex
  • [endIndex]
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:94

Removes all child instances from the child list of the container.

Parameters:

  • beginIndex Int

    The beginning position. Predefined value is 0.

  • [endIndex] Int optional

    The ending position. Predefined value is children's array length.

removeStageReference

()

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:121

Removes the current stage reference from the container and all of its children.

rightclick

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:316

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:

rightdown

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:323

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:

rightup

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:330

A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject

Parameters:

rightupoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:338

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:

setChildIndex

(
  • child
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:103

Changes the position of an existing child in the display object container

Parameters:

  • child DisplayObject

    The child DisplayObject instance for which you want to change the index number

  • index Int

    The resulting index number for the child display object

setStageReference

(
  • stage
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:53

Sets the object's stage reference, the stage this object is connected to

Parameters:

  • stage Stage

    the stage that the object will have as its current stage reference

swapChildren

(
  • child1
  • child2
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:60

Swaps the position of 2 Display Objects within this container.

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:346

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

toGlobal

(
  • position
)
Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:61

Calculates the global position of the display object

Parameters:

  • position Point

    The world origin to calculate from

Returns:

Point:

A point object representing the position of this object

toLocal

(
  • position
  • [frm]
)
Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:70

Calculates the local position of the display object relative to another point

Parameters:

  • position Point

    The world origin to calculate from

  • [frm] DisplayObject optional

    The DisplayObject to calculate the global position from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:361

A callback that is used when the user releases a touch over the displayObject

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:368

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:

touchmove

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:376

Is called when a touch is moved across the renderer element

Parameters:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:354

A callback that is used when the user touches over the displayObject

Parameters:

updateBounds

()

Defined in pixi/primitives/Graphics.hx:211

Update the bounds of the object

updateCache

()

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:80

Generates and updates the cached sprite for this object.

updateCachedSpriteTexture

()

Defined in pixi/primitives/Graphics.hx:197

Updates texture size based on canvas size

Properties

alpha

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:87

The opacity of the object.

blendMode

Int

Defined in pixi/primitives/Graphics.hx:264

The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.

Default: PIXI.blendModes.NORMAL;

boundsPadding

Float

Defined in pixi/primitives/Graphics.hx:281

The bounds' padding used for bounds calculation.

buttonMode

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:95

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

cacheAsBitmap

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:103

Set weather or not a the display objects is cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects To remove filters simply set this property to 'null'

children

Array

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:34

[read-only] The array of children of this container.

defaultCursor

String

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:112

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

fillAlpha

Float

Defined in pixi/primitives/Graphics.hx:230

The alpha value used when filling the Graphics object.

filterArea

Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:120

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

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:129

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'

height

Float

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:26

The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

hitArea

Rectangle | Circle | Ellipse | Polygon

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:138

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

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:147

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Default: false

isMask

Bool

Defined in pixi/primitives/Graphics.hx:273

Whether this shape is being used as a mask.

lineColor

String

Defined in pixi/primitives/Graphics.hx:246

The color of any lines drawn.

Default: 0

lineWidth

Float

Defined in pixi/primitives/Graphics.hx:238

The width (thickness) of any lines drawn.

mask

Graphics

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:156

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

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:166

[read-only] The display object container that contains this display object.

pivot

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:175

The pivot point of the displayObject that it rotates around

position

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:183

The coordinate of the object relative to the local coordinates of the parent.

renderable

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:191

Can this object be rendered

rotation

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:199

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:207

The scale factor of the object.

stage

Stage

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:215

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

tint

Int

Defined in pixi/primitives/Graphics.hx:255

The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.

Default: 0xFFFFFF

visible

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:224

The visibility of the object.

width

Float

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:18

The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

worldAlpha

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:232

[read-only] The multiplied alpha of the displayObject

worldVisible

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:241

[read-only] Indicates if the sprite is globaly visible.

x

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:249

The position of the displayObject on the x axis relative to the local coordinates of the parent.

y

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:257

The position of the displayObject on the y axis relative to the local coordinates of the parent.