SS6Project that contains animations.
The name of animePack(SSAE).
The name of animation.
The bounds object, this is used to calculate and store the bounds of the displayObject.
Protected
_Flags the cached bounds as dirty.
Protected
_Cache of this display-object's bounds-rectangle.
Protected
_If the object has been destroyed via destroy(). If true, it should not be used.
Protected
_Currently enabled filters.
Protected
_Protected
_Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.
Local bounds object, swapped with _bounds
when using getLocalBounds()
.
Protected
_Cache of this display-object's local-bounds rectangle.
Protected
_The original, cached mask of the object.
Protected
_Protected
_The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.
The opacity of the object.
Readonly
childrenThe array of children of this container.
Should this object be rendered if the bounds of this object are out of frame?
Culling has no effect on whether updateTransform is called.
If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.
The area the filter is applied to. This is used as more of an optimization rather than figuring out the dimensions of the displayObject each frame you can set this rectangle.
Also works as an interaction mask.
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'
.
Does any other displayObject use this object as a mask?
Used to fast check if a sprite is.. a sprite!
Protected
onThe display object container that contains this display object.
Protected
playProtected
playerCan 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.
Protected
skipIf set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.
This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as
https://github.com/pixijs/pixi-display
Also be aware of that this may not work nicely with the addChildAt() function, as the zIndex sorting may cause the child to automatically sorted to another position.
Should children be sorted by zIndex at the next updateTransform call.
Will get automatically set to true if a new child is added, or if a child's zIndex changes.
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.
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.
Readonly
worldThe multiplied alpha of the displayObject.
Static
prefixedThe angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
Readonly flag for destroyed display objects.
The height of the Container, setting this will actually modify the scale to achieve the value set.
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 PixiJS a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent.
Otherwise, getLocalBounds
may calculate incorrect bounds, which makes the container's width and height wrong.
To remove a mask, set this property to null
.
For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.
The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.
The width of the Container, setting this will actually modify the scale to achieve the value set.
Current transform of the object based on world (parent) factors.
Indicates if the object is globally visible.
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
The zIndex of the displayObject.
If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other display objects within the same container.
Protected
_Protected
Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).
Protected
_Recursively updates transform of all objects from the root to this one internal function for toLocal()
Protected
_To be overridden by the subclasses.
The renderer
Protected
_Protected
Renders this object and its children with culling.
The renderer
Optional
context: anyRecalculates the bounds of the container.
This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.
名前を指定してパーツの再生するインスタンスアニメを変更します。 指定したパーツがインスタンスパーツでない場合、falseを返します. インスタンスパーツ名はディフォルトでは「ssae名:モーション名」とつけられています。 再生するアニメの名前は アニメパック名 と アニメ名 で指定してください。 現在再生しているアニメを指定することは入れ子となり無限ループとなるためできません。
変更するアニメーションは同じ ssfb に含まれる必要があります。 インスタンスパーツが再生するアニメを変更します
インスタンスキーは
SS上のパーツ名
参照するアニメパック名
参照するアニメ名
インスタンスキーの上書きフラグ
インスタンスキー
Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy
.
Optional
options: boolean | IDestroyOptionsOptions parameter. A boolean will act as if all options have been set to that value
if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
Pair method for enableTempParent
Actual parent of element
Calls each of the listeners registered for a given event.
Used in Renderer, cacheAsBitmap and other places where you call an updateTransform
on root
const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);
Return an array listing the events for which the emitter has registered listeners.
Calculates and returns the (world) bounds of the display object as a [Rectangle]PIXI.Rectangle.
This method is expensive on containers with a large subtree (like the stage). This is because the bounds
of a container depend on its children's bounds, which recursively causes all bounds in the subtree to
be recalculated. The upside, however, is that calling getBounds
once on a container will indeed update
the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using
displayObject._bounds.getRectangle()
when traversing through all the bounds in a scene graph. Otherwise,
calling getBounds
on each object in a subtree will cause the total cost to increase quadratically as
its height increases.
The transforms of all objects in a container's subtree and of all ancestors are updated. The world bounds of all display objects in a container's subtree will also be recalculated.
The _bounds
object stores the last calculation of the bounds. You can use to entirely skip bounds
calculation if needed.
const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);
Do know that usage of getLocalBounds
can corrupt the _bounds
of children (the whole subtree, actually). This
is a known issue that has not been solved. See [getLocalBounds]PIXI.DisplayObject#getLocalBounds for more
details.
getBounds
should be called with skipUpdate
equal to true
in a render() call. This is because the transforms
are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain
cases.
Optional
skipUpdate: booleanSetting 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 boost.
Optional
rect: RectangleOptional rectangle to store the result of the bounds calculation.
Returns the child at the specified index
The index to get the child at
Optional
deep: booleanReturns the index position of a child DisplayObject instance
The DisplayObject instance to identify
Retrieves the local bounds of the displayObject as a rectangle object.
Calling getLocalBounds
may invalidate the _bounds
of the whole subtree below. If using it inside a render()
call, it is advised to call getBounds()
immediately after to recalculate the world bounds of the subtree.
Optional
rect: RectangleOptional rectangle to store the result of the bounds calculation.
Optional
skipChildrenUpdate: booleanSetting to true
will stop re-calculation of children transforms,
it was default behaviour of pixi 4.0-5.2 and caused many problems to users.
Return the number of listeners listening to a given event.
Return the listeners registered for a given event.
Optional
fn: ListenerFnOptional
context: anyOptional
once: booleanAdd a listener for a given event.
Optional
context: anyAdd a one-time listener for a given event.
Optional
context: anyProtected
onOverridable method that can be used by Container subclasses whenever the children array is modified.
Optional
_length: numberアニメーション再生を一時停止する
アニメーション再生を開始する
Optional
frameNo: numberRemove all listeners, or those of the specified event.
Optional
event: string | symbolRemoves a child from the specified index position.
The index to get the child from
The child that was removed.
Removes all children from this container that are within the begin and end indexes.
Optional
beginIndex: numberThe beginning position.
Optional
endIndex: numberThe ending position. Default value is size of the container.
Remove the listeners of a given event.
Optional
fn: ListenerFnOptional
context: anyOptional
once: booleanRenders the object using the WebGL renderer.
The [_render]PIXI.Container#_render method is be overriden for rendering the contents of the
container itself. This render
method will invoke it, and also invoke the render
methods of all
children afterward.
If renderable
or visible
is false or if worldAlpha
is not positive or if cullable
is true and
the bounds of this object are out of frame, this implementation will entirely skip rendering.
See PIXI.DisplayObject for choosing between renderable
or visible
. Generally,
setting alpha to zero is not recommended for purely skipping rendering.
When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. See [cullable]PIXI.DisplayObject#cullable and [cullArea]PIXI.DisplayObject#cullArea. Other culling methods might be better suited for a large number static objects; see [@pixi-essentials/cull]https://www.npmjs.com/package/@pixi-essentials/cull and [pixi-cull]https://www.npmjs.com/package/pixi-cull.
The [renderAdvanced]PIXI.Container#renderAdvanced method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.
The renderer
Protected
renderRender the object using the WebGL renderer and advanced features.
The renderer
アニメーション再生を再開する
アニメーションの透明度を設定する
アニメーションの速度を設定する (deprecated この関数は削除される可能性があります)
アニメーション速度(frame per sec.)
描画更新が間に合わないときにフレームをスキップするかどうか
アニメーション再生設定
開始フレーム番号(マイナス設定でデフォルト値を変更しない)
終了フレーム番号(マイナス設定でデフォルト値を変更しない)
ループ回数(ゼロもしくはマイナス設定で無限ループ)
アニメーションの速度を設定する
アニメーション速度(設定値に対する乗率)負数設定で逆再生
描画更新が間に合わないときにフレームをスキップするかどうか
Changes the position of an existing child in the display object container
The child DisplayObject instance for which you want to change the index number
The resulting index number for the child display object
アニメーション再生を位置(フレーム)を設定する
Protected
Set1フレーム分のアニメーション描画
フレーム番号
delta step
Set the parent Container of this DisplayObject.
The Container to add this DisplayObject to.
Convenience function to set the position, scale, skew and pivot at once.
Optional
x: numberThe X position
Optional
y: numberThe Y position
Optional
scaleX: numberThe X scale value
Optional
scaleY: numberThe Y scale value
Optional
rotation: numberThe rotation
Optional
skewX: numberThe X skew value
Optional
skewY: numberThe Y skew value
Optional
pivotX: numberThe X pivot value
Optional
pivotY: numberThe Y pivot value
Setup
The name of animePack(SSAE).
The name of animation.
ユーザーデータコールバックの設定
Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.
アニメーションを停止する
Swaps the position of 2 Display Objects within this container.
First display object to swap
Second display object to swap
エラー処理
エラー
Calculates the global position of the display object.
The world origin to calculate from.
Optional
point: PA Point object in which to store the value, optional (otherwise will create a new Point).
Optional
skipUpdate: booleanShould we skip the update transform.
Calculates the local position of the display object relative to another point.
The world origin to calculate from.
Optional
from: DisplayObjectThe DisplayObject to calculate the global position from.
Optional
point: PA Point object in which to store the value, optional (otherwise will create a new Point).
Optional
skipUpdate: booleanShould we skip the update transform
Protected
UpdateProtected
UpdateUpdate is called PIXI.ticker
expected 1
Updates the transform on all children of this container for rendering.
Static
mixinMixes all enumerable properties and methods from a source object to DisplayObject.
The source of properties and methods to mix in.
SS6Player (extends PIXI.Container)