pixi.primitives.Graphics

type

class

extends

pixi.display.DisplayObjectContainer

metadata

:native: "PIXI.Graphics"

Static Variables

Constructor

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

Instance Variables hide inherited show inherited

The opacity of the object.

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

The bounds' padding used for bounds calculation.

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

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'

read-only The array of children of this container.

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

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

The alpha value used when filling the Graphics object.

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

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'

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

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)

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

Whether this shape is being used as a mask.

The color of any lines drawn.

The width (thickness) of any lines drawn.

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.

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

Is called when mouse is moved across the renderer element

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

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

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

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

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

The pivot point of the displayObject that it rotates around

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

Can this object be rendered

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

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

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

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

The rotation of the object in radians.

The scale factor of the object.

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

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

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

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

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

Is called when a touch is moved across the renderer element

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

The visibility of the object.

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

read-only The multiplied alpha of the displayObject

read-only Indicates if the sprite is globaly visible.

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

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

Instance Methods hide inherited show inherited

parameters: child {DisplayObject} The DisplayObject to add to the container

Adds a child to the container.

parameters: child {DisplayObject} The child to add; index {Int} The index to place the child in

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

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. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
returns: {Graphics}

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

parameters: {Float} x1 The x-coordinate of the beginning of the arc; {Float} y1 The y-coordinate of the beginning of the arc; {Float} x2 The x-coordinate of the end of the arc; {Float} y2 The y-coordinate of the end of the arc; {Float} radius The radius of the arc
returns: {Graphics}

the arcTo() method creates an arc/curve between two tangents on the canvas. "borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!

parameters: color {Int} the color of the fill; [alpha] {Float} the alpha of the fill
returns: {Graphics}

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

parameters: {Float} cpX Control point x; {Float} cpY Control point y; {Float} cpX2 Second Control point x; {Float} cpY2 Second Control point y; {Float} toX Destination point x; {Float} toY Destination point y
returns: {Graphics}

Calculate the points for a bezier curve.

returns: {Graphics}

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

Destroys a previous cached sprite.

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}

Draws a circle.

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}

Draws an ellipse.

parameters: path {Array} The path data used to construct the polygon.
returns: {Graphics}

Draws a polygon using the given path.

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}

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}

parameters: {Circle|Rectangle|Ellipse|Line|Polygon} shape The Shape object to draw.
returns: {GraphicsData} The generated GraphicsData object.

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

returns: {Graphics}

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

parameters: resolution {Float} The resolution of the texture being generated; scaleMode {Int} Should be one of the PIXI.scaleMode consts; [renderer] {CanvasRenderer|WebGLRenderer} The renderer used to generate the texture.
returns: {Texture} a texture of the graphics object

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: [matrix] {Matrix}
returns: {Rectangle} the rectangular bounding area

Retrieves the bounds of the displayObject as a rectangle object

parameters: index {Int} The index to get the child from
returns: {DisplayObject}

Returns the child at the specified index

parameters

name {String} The name of the child

returns

{DisplayObject}

metadata

:keep

Returns the child with the specified name

parameters: child {DisplayObject} The DisplayObject instance to identify
returns: {Int} The index position of the child display object to identify

Returns the index position of a child DisplayObject instance

returns: {Rectangle} the rectangular bounding area

Retrieves the local bounds of the displayObject as a rectangle object

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

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

parameters: x {Float} the X coordinate to draw to; y {Float} the Y coordinate to draw to

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 move to; y {Float} the Y coordinate to move to

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

parameters: {Float} cx The x-coordinate of the center of the circle; {Float} cy The y-coordinate of the center of the circle; {Float} radius The radius of the circle; {Float} startAngle The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle); {Float} endAngle The ending angle, in radians; {Float} [anticlockwise] Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.
returns: {Graphics}

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

parameters: child {DisplayObject} The DisplayObject to remove

Removes a child from the container.

parameters: index {Int} The index to get the child from

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

parameters: beginIndex {Int} The beginning position. Predefined value is 0.; [endIndex] {Int} The ending position. Predefined value is children's array length.

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

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

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

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

parameters: stage {Stage} the stage that the object will have as its current stage reference

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

parameters: child1 {DisplayObject}; child2 {DisplayObject}

Swaps the position of 2 Display Objects within this container.

parameters: position {Point} The world origin to calculate from
returns: {Point} A point object representing the position of this object

Calculates the global position of the display object

parameters: position {Point} The world origin to calculate from; [frm] {DisplayObject} The DisplayObject to calculate the global position from
returns: {Point} A point object representing the position of this object

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

Update the bounds of the object

Generates and updates the cached sprite for this object.

Updates texture size based on canvas size

pixi.primitives.Graphics

Static Variables

CIRC : Int

ELIP : Int

POLY : Int

RECT : Int

RREC : Int

Constructor

Instance Variables hide inherited show inherited

alpha : Float

blendMode : Int

boundsPadding : Float

buttonMode : Bool

cacheAsBitmap : Bool

children : Array<DisplayObject>

click : pixi.InteractionData -> Void

defaultCursor : String

fillAlpha : Float

filterArea : pixi.geom.Rectangle

filters : Array<Dynamic>

height : Float

hitArea : Dynamic

interactive : Bool

isMask : Bool

lineColor : String

lineWidth : Float

mask : pixi.primitives.Graphics

mousedown : pixi.InteractionData -> Void

mousemove : pixi.InteractionData -> Void

mouseout : pixi.InteractionData -> Void

mouseover : pixi.InteractionData -> Void

mouseup : pixi.InteractionData -> Void

mouseupoutside : pixi.InteractionData -> Void

name : String

parent : DisplayObjectContainer

pivot : pixi.geom.Point

position : pixi.geom.Point

renderable : Bool

rightclick : pixi.InteractionData -> Void

rightdown : pixi.InteractionData -> Void

rightup : pixi.InteractionData -> Void

rightupoutside : pixi.InteractionData -> Void

rotation : Float

scale : pixi.geom.Point

stage : Stage

tap : pixi.InteractionData -> Void

tint : Int

touchend : pixi.InteractionData -> Void

touchendoutside : pixi.InteractionData -> Void

touchmove : pixi.InteractionData -> Void

touchstart : pixi.InteractionData -> Void

visible : Bool

width : Float

worldAlpha : Float

worldVisible : Bool

x : Float

y : Float

Instance Methods hide inherited show inherited

addChild(child : DisplayObject) : Void

addChildAt(child : DisplayObject, index : Int) : Void

arc(cx : Float, cy : Float, radius : Float, startAngle : Float, endAngle : Float, ?anticlockwise : Bool) : Graphics

arcTo(x1 : Float, y1 : Float, x2 : Float, y2 : Float, radius : Float) : Graphics

beginFill(color : Int, ?alpha : Float) : Graphics

bezierCurveTo(cpX : Float, cpY : Float, cpX2 : Float, cpY2 : Float, toX : Float, toY : Float) : Graphics

clear() : Graphics

destroyCachedSprite() : Void

drawCircle(x : Float, y : Float, radius : Float) : Graphics

drawEllipse(x : Float, y : Float, width : Float, height : Float) : Graphics

drawPolygon(path : Array<Float>) : Graphics

drawRect(x : Float, y : Float, width : Float, height : Float) : Graphics

drawRoundedRect(x : Float, y : Float, width : Float, height : Float, radius : Float) : Graphics

drawShape(shape : pixi.geom.Circle) : GraphicsData

endFill() : Graphics

generateTexture(resolution : Float, scaleMode : Int, ?renderer : pixi.renderers.webgl.WebGLRenderer) : pixi.textures.Texture

getBounds(?matrix : pixi.geom.Matrix) : pixi.geom.Rectangle

getChildAt(index : Int) : DisplayObject

getChildByName(name : String) : DisplayObject

getChildIndex(child : DisplayObject) : Int

getLocalBounds() : pixi.geom.Rectangle

lineStyle(lineWidth : Float, ?color : Int, ?alpha : Float) : Graphics