PIXI

Class: MovieClip

PIXI.extras. MovieClip

new PIXI.extras.MovieClip(textures)

extras/MovieClip.js, line 26

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

var alienImages = ["image_sequence_01.png","image_sequence_02.png","image_sequence_03.png","image_sequence_04.png"];
var textureArray = [];

for (var i=0; i < 4; i++)
{
     var texture = PIXI.Texture.fromImage(alienImages[i]);
     textureArray.push(texture);
};

var mc = new PIXI.MovieClip(textureArray);
Name Type Description
textures Array.<PIXI.Texture> | Array.<Object>

an array of PIXI.Texture or frame objects that make up the animation
textures[].texture PIXI.Texture

the PIXI.Texture of the frame
textures[].time number

the duration of the frame in ms

Extends

Members

alphanumber

The opacity of the object.

anchorPIXI.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 the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

animationSpeednumber

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

Default Value:
  • 1

blendModenumber

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

Default Value:
  • PIXI.BLEND_MODES.NORMAL
See:

cacheAsBitmapboolean

Set this to true if you want this display object to be 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 'false'

cachedTintnumber

An internal cached value of the tint.

Default Value:
  • 0xFFFFFF

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

readonlycurrentFramenumber

The MovieClips current frame index

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 rectangle

filtersArray.<PIXI.AbstractFilter>

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'

heightnumber

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

loopboolean

Whether or not the movie clip repeats after playing.

Default Value:
  • true

maskPIXI.Graphics PIXI.Sprite

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.

pivotPIXI.Point

The pivot point of the displayObject that it rotates around

readonlyplayingboolean

Indicates if the MovieClip is currently playing

positionPIXI.Point

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

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

rotationnumber

The rotation of the object in radians.

scalePIXI.Point

The scale factor of the object.

shaderPIXI.AbstractFilter PIXI.Shader

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

skewPIXI.Point

The skew factor for the object in radians.

texturePIXI.Texture

The texture that the sprite is using

texturesArray.<PIXI.Texture>

The array of textures used for this MovieClip

tintnumber

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

Default Value:
  • 0xFFFFFF

readonlytotalFramesnumber

totalFrames is the total number of frames in the MovieClip. This is the same as number of textures
assigned to the MovieClip.

Default Value:
  • 0

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

widthnumber

The width of the sprite, 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 sprite is globally visible.

xnumber

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

ynumber

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

Methods

staticPIXI.extras.MovieClip.fromFrames(frames)

extras/MovieClip.js, line 291

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

Name Type Description
frames Array.<string>

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

staticPIXI.extras.MovieClip.fromImages(images)

extras/MovieClip.js, line 309

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

Name Type Description
images Array.<string>

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

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 112

Adds a child to the container.

You can also add multple items like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 153

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
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited containsPoint(point){boolean}

core/sprites/Sprite.js, line 357

Tests if a point is inside this sprite

Name Type Description
point PIXI.Point

the point to test
Returns:
Type Description
boolean the result of the test

inherited destroy(destroyTexture, destroyBaseTexture)

core/sprites/Sprite.js, line 516

Destroys this sprite and optionally its texture

Name Type Default Description
destroyTexture boolean false optional

Should it destroy the current texture of the sprite as well
destroyBaseTexture boolean false optional

Should it destroy the base texture of the sprite as well

inherited generateTexture(renderer, resolution, scaleMode){PIXI.Texture}

core/display/Container.js, line 368

Useful function that returns a texture of the display 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.

Name Type Description
renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.
resolution number

The resolution of the texture being generated
scaleMode number

See PIXI.SCALE_MODES for possible values
Returns:
Type Description
PIXI.Texture a texture of the display object

inherited getBounds(matrix){PIXI.Rectangle}

core/sprites/Sprite.js, line 218

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

Name Type Description
matrix PIXI.Matrix

the transformation matrix of the sprite
Returns:
Type Description
PIXI.Rectangle the framing rectangle

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 248

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 210

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

inherited getLocalBounds()

core/sprites/Sprite.js, line 342

Gets the local bounds of the sprite object.

gotoAndPlay(frameNumber)

extras/MovieClip.js, line 207

Goes to a specific frame and begins playing the MovieClip

Name Type Description
frameNumber number

frame index to start at

gotoAndStop(frameNumber)

extras/MovieClip.js, line 193

Stops the MovieClip and goes to a specific frame

Name Type Description
frameNumber number

frame index to stop at

play()

extras/MovieClip.js, line 177

Plays the MovieClip

inherited removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 264

Removes a child from the container.

Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 304

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex)

core/display/Container.js, line 324

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

Name Type Description
beginIndex number

The beginning position. Default value is 0.
endIndex number

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

inherited renderCanvas(renderer)

core/display/Container.js, line 601

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

inherited renderWebGL(renderer)

core/display/Container.js, line 509

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 228

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

Name Type Description
child PIXI.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

inherited setParent(container){Container}

core/display/DisplayObject.js, line 505

Set the parent Container of this DisplayObject

Name Type Description
container Container

The Container to add this DisplayObject to
Returns:
Type Description
Container The Container that this DisplayObject was added to

inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

core/display/DisplayObject.js, line 530

Convenience function to set the postion, scale, skew and pivot at once.

Name Type Default Description
x number 0 optional

The X position
y number 0 optional

The Y position
scaleX number 1 optional

The X scale value
scaleY number 1 optional

The Y scale value
rotation number 0 optional

The rotation
skewX number 0 optional

The X skew value
skewY number 0 optional

The Y skew value
pivotX number 0 optional

The X pivot value
pivotY number 0 optional

The Y pivot value
Returns:
Type Description
PIXI.DisplayObject

stop()

extras/MovieClip.js, line 162

Stops the MovieClip

inherited swapChildren(child, child2)

core/display/Container.js, line 184

Swaps the position of 2 Display Objects within this container.

Name Type Description
child PIXI.DisplayObject
child2 PIXI.DisplayObject

inherited toGlobal(position){PIXI.Point}

core/display/DisplayObject.js, line 402

Calculates the global position of the display object

Name Type Description
position PIXI.Point

The world origin to calculate from
Returns:
Type Description
PIXI.Point A point object representing the position of this object

inherited toLocal(position, from, point){PIXI.Point}

core/display/DisplayObject.js, line 430

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

Name Type Description
position PIXI.Point

The world origin to calculate from
from PIXI.DisplayObject optional

The DisplayObject to calculate the global position from
point PIXI.Point optional

A Point object in which to store the value, optional (otherwise will create a new Point)
Returns:
Type Description
PIXI.Point A point object representing the position of this object