API Docs for: 2.0.0
Show:

MovieClip Class

Extends Sprite
Module: PIXI

A MovieClip is a simple way to display an animation depicted by a list of textures.

Constructor

MovieClip

(
  • textures
)

Parameters:

  • textures Array

    an array of {Texture} objects that make up the animation

Methods

_destroyCachedSprite

() private

Destroys the cached sprite.

_generateCachedSprite

() private

Internal method.

_renderCachedSprite

(
  • renderSession
)
private

Internal method.

Parameters:

  • renderSession Object

    The render session

_renderCanvas

(
  • renderSession
)
private

Inherited from DisplayObject but overwritten in src/pixi/display/Sprite.js:306

Renders the object using the Canvas renderer

Parameters:

  • renderSession RenderSession

_renderWebGL

(
  • renderSession
)
private

Inherited from DisplayObject but overwritten in src/pixi/display/Sprite.js:243

Renders the object using the WebGL renderer

Parameters:

  • renderSession RenderSession

addChild

(
  • child
)
DisplayObject

Adds a child to the container.

Parameters:

Returns:

DisplayObject:

The child that was added.

addChildAt

(
  • child
  • index
)
DisplayObject

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 Number

    The index to place the child in

Returns:

DisplayObject:

The child that was added.

click

(
  • interactionData
)

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

Parameters:

fromFrames

(
  • frames
)
static

A short hand way of creating a movieclip from an array of frame ids

Parameters:

  • frames Array

    the array of frames ids the movieclip will use as its texture frames

fromImages

(
  • frames
)
static

A short hand way of creating a movieclip from an array of image ids

Parameters:

  • frames Array

    the array of image ids the movieclip will use as its texture frames

generateTexture

(
  • resolution
  • scaleMode
  • renderer
)
Texture

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 Number

    The resolution of the texture being generated

  • scaleMode Number

    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

getBounds

(
  • matrix
)
Rectangle

Inherited from DisplayObject but overwritten in src/pixi/display/Sprite.js:164

Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.

Parameters:

  • matrix Matrix

    the transformation matrix of the sprite

Returns:

Rectangle:

the framing rectangle

getChildAt

(
  • index
)
DisplayObject

Returns the child at the specified index

Parameters:

  • index Number

    The index to get the child from

Returns:

DisplayObject:

The child at the given index, if any.

getChildIndex

(
  • child
)
Number

Returns the index position of a child DisplayObject instance

Parameters:

Returns:

Number:

The index position of the child display object to identify

getLocalBounds

() Rectangle

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.

Returns:

Rectangle:

The rectangular bounding area

gotoAndPlay

(
  • frameNumber
)

Goes to a specific frame and begins playing the MovieClip

Parameters:

  • frameNumber Number

    frame index to start at

gotoAndStop

(
  • frameNumber
)

Stops the MovieClip and goes to a specific frame

Parameters:

  • frameNumber Number

    frame index to stop at

mousedown

(
  • interactionData
)

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

Parameters:

mouseout

(
  • interactionData
)

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

Parameters:

mouseover

(
  • interactionData
)

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

Parameters:

mouseup

(
  • interactionData
)

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
)

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:

onTextureUpdate

(
  • event
)
private

When the texture is updated, this event will fire to update the scale and frame

Parameters:

  • event Object

play

()

Plays the MovieClip

removeChild

(
  • child
)
DisplayObject

Removes a child from the container.

Parameters:

Returns:

DisplayObject:

The child that was removed.

removeChildAt

(
  • index
)
DisplayObject

Removes a child from the specified index position.

Parameters:

  • index Number

    The index to get the child from

Returns:

DisplayObject:

The child that was removed.

removeChildren

(
  • beginIndex
  • endIndex
)

Removes all children from this container that are within the begin and end indexes.

Parameters:

  • beginIndex Number

    The beginning position. Default value is 0.

  • endIndex Number

    The ending position. Default value is size of the container.

removeStageReference

()

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

rightclick

(
  • interactionData
)

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

Parameters:

rightdown

(
  • interactionData
)

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

Parameters:

rightup

(
  • interactionData
)

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
)

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
)

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 Number

    The resulting index number for the child display object

setStageReference

(
  • stage
)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters:

  • stage Stage

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

setTexture

(
  • texture
)

Sets the texture of the sprite

Parameters:

  • texture Texture

    The PIXI texture that is displayed by the sprite

stop

()

Stops the MovieClip

swapChildren

(
  • child
  • child2
)

Swaps the position of 2 Display Objects within this container.

Parameters:

tap

(
  • interactionData
)

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

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
  • [from]
)
Point

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

Parameters:

  • position Point

    The world origin to calculate from

  • [from] DisplayObject optional

    The DisplayObject to calculate the global position from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

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

Parameters:

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:

touchstart

(
  • interactionData
)

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

Parameters:

updateCache

()

Generates and updates the cached sprite for this object.

Properties

_bounds

Rectangle private

The original, cached bounds of the object

_cacheAsBitmap

Boolean private

Cached internal flag.

_cacheIsDirty

Boolean private

Cached internal flag.

_cr

Number private

cached sin rotation and cos rotation

_currentBounds

Rectangle private

Inherited from DisplayObject but overwritten in src/pixi/display/DisplayObject.js:179

The most up-to-date bounds of the object

_height

Number private

The height of the sprite (this is initially set by the texture)

_interactive

Boolean private

[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property

_sr

Number private

cached sin rotation and cos rotation

_width

Number private

The width of the sprite (this is initially set by the texture)

alpha

Number

The opacity of the object.

anchor

Point

The anchor sets the origin point of the texture. The default is 0,0 this means the texture's origin is the top left Setting than anchor to 0.5,0.5 means the textures origin is centered Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner

animationSpeed

Number

The speed that the MovieClip will play at. Higher is faster, lower is slower

Default: 1

blendMode

Number

The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.

Default: PIXI.blendModes.NORMAL;

buttonMode

Boolean

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

cacheAsBitmap

Boolean

Set if this display object 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 simply set this property to 'null'

children

Array

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

currentFrame

Number

[read-only] The MovieClips current frame index (this may not have to be a whole number)

Default: 0

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

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'

height

Number

The height of the sprite, 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

loop

Boolean

Whether or not the movie clip repeats after playing.

Default: true

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.

onComplete

Function

Function to call when a MovieClip finishes playing

parent

DisplayObjectContainer

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

pivot

Point

The pivot point of the displayObject that it rotates around

playing

Boolean

[read-only] Indicates if the MovieClip is currently playing

position

Point

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

renderable

Boolean

Can this object be rendered

rotation

Number

The rotation of the object in radians.

scale

Point

The scale factor of the object.

shader

PIXI.AbstractFilter

The shader that will be used to render the texture to the stage. Set to null to remove a current shader.

Default: null

stage

Stage

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

texture

Texture

The texture that the sprite is using

textures

Array

The array of textures that make up the animation

tint

Number

The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Default: 0xFFFFFF

totalFrames

Number

[read-only] totalFrames is the total number of frames in the MovieClip. This is the same as number of textures assigned to the MovieClip.

Default: 0

visible

Boolean

The visibility of the object.

width

Number

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

worldAlpha

Number

[read-only] The multiplied alpha of the displayObject

worldTransform

Matrix private

[read-only] Current transform of the object based on world (parent) factors

worldVisible

Boolean

[read-only] Indicates if the sprite is globally 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.