Winter Cardinal UI - v0.442.0 / DBaseBackgroundMesh

Class: DBaseBackgroundMesh

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new DBaseBackgroundMesh(texture): DBaseBackgroundMesh

Parameters

Name Type
texture Texture

Returns

DBaseBackgroundMesh

Overrides

Mesh.constructor

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:15

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

Mesh._accessibleActive

Defined in

node_modules/pixi.js/pixi.js.d.ts:13747

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Inherited from

Mesh._accessibleDiv

Defined in

node_modules/pixi.js/pixi.js.d.ts:13753

_bounds

• _bounds: Bounds

The bounds object, this is used to calculate and store the bounds of the displayObject.

Member

PIXI.DisplayObject#_bounds

Inherited from

Mesh._bounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13869

_boundsID

• Protected _boundsID: number

Flags the cached bounds as dirty.

Member

PIXI.DisplayObject#_boundsID

Inherited from

Mesh._boundsID

Defined in

node_modules/pixi.js/pixi.js.d.ts:13882

_boundsRect

• Protected _boundsRect: Bounds

Cache of this display-object’s bounds-rectangle.

Member

PIXI.DisplayObject#_boundsRect

Inherited from

Mesh._boundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:13889

_destroyed

• Protected _destroyed: boolean

If the object has been destroyed via destroy(). If true, it should not be used.

Member

PIXI.DisplayObject#_destroyed

Inherited from

Mesh._destroyed

Defined in

node_modules/pixi.js/pixi.js.d.ts:13910

_enabledFilters

• Protected _enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

Inherited from

Mesh._enabledFilters

Defined in

node_modules/pixi.js/pixi.js.d.ts:13863

_lastSortedIndex

• Protected _lastSortedIndex: number

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.

Member

PIXI.DisplayObject#_lastSortedIndex

Inherited from

Mesh._lastSortedIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:13832

_localBounds

• _localBounds: Bounds

Local bounds object, swapped with _bounds when using getLocalBounds().

Member

PIXI.DisplayObject#_localBounds

Inherited from

Mesh._localBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13875

_localBoundsRect

• Protected _localBoundsRect: Bounds

Cache of this display-object’s local-bounds rectangle.

Member

PIXI.DisplayObject#_localBoundsRect

Inherited from

Mesh._localBoundsRect

Defined in

node_modules/pixi.js/pixi.js.d.ts:13896

_mask

• Protected _mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

Inherited from

Mesh._mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:13903

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Inherited from

Mesh._tempDisplayObjectParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:13983

_zIndex

• Protected _zIndex: number

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

Member

PIXI.DisplayObject#_zIndex

Inherited from

Mesh._zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:13840

accessible

• accessible: boolean

Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.accessible

Defined in

node_modules/pixi.js/pixi.js.d.ts:13726

accessibleChildren

• accessibleChildren: boolean

Setting to false will prevent any children inside this container to be accessible. Defaults to true.

Member

Memberof

PIXI.DisplayObject#

Default

true

Inherited from

Mesh.accessibleChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13780

accessibleHint

• accessibleHint: string

Sets the aria-label attribute of the shadow div

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.accessibleHint

Defined in

node_modules/pixi.js/pixi.js.d.ts:13741

accessiblePointerEvents

• accessiblePointerEvents: string

Specify the pointer-events the accessible div will use Defaults to auto.

Member

Memberof

PIXI.DisplayObject#

Default

'auto'

Inherited from

Mesh.accessiblePointerEvents

Defined in

node_modules/pixi.js/pixi.js.d.ts:13771

accessibleTitle

• accessibleTitle: string

Sets the title attribute of the shadow div If accessibleTitle AND accessibleHint has not been this will default to ‘displayObject [tabIndex]’

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.accessibleTitle

Defined in

node_modules/pixi.js/pixi.js.d.ts:13734

accessibleType

• accessibleType: string

Specify the type of div the accessible layer is. Screen readers treat the element differently depending on this type. Defaults to button.

Member

Memberof

PIXI.DisplayObject#

Default

'button'

Inherited from

Mesh.accessibleType

Defined in

node_modules/pixi.js/pixi.js.d.ts:13762

alpha

• alpha: number

The opacity of the object.

Member

PIXI.DisplayObject#alpha

Inherited from

Mesh.alpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:13793

angle

• angle: number

The 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.

Member

Inherited from

Mesh.angle

Defined in

node_modules/pixi.js/pixi.js.d.ts:14070

blendMode

• blendMode: number

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

Member

Default

PIXI.BLEND_MODES.NORMAL;

See

PIXI.BLEND_MODES

Inherited from

Mesh.blendMode

Defined in

node_modules/pixi.js/pixi.js.d.ts:13457

buttonMode

• buttonMode: boolean

If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the ‘cursor’ property to 'pointer'.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.buttonMode = true;

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.buttonMode

Defined in

node_modules/pixi.js/pixi.js.d.ts:14152

cacheAsBitmap

• cacheAsBitmap: boolean

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

IMPORTANT GOTCHA - Make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.cacheAsBitmap

Defined in

node_modules/pixi.js/pixi.js.d.ts:14179

children

• Readonly children: DisplayObject[]

The array of children of this container.

Member

PIXI.Container#children

Inherited from

Mesh.children

Defined in

node_modules/pixi.js/pixi.js.d.ts:13547

cursor

• cursor: string

This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.cursor = 'wait';

See

https://developer.mozilla.org/en/docs/Web/CSS/cursor

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.cursor

Defined in

node_modules/pixi.js/pixi.js.d.ts:14166

drawMode

• drawMode: number

The way the Mesh should be drawn, can be any of the PIXI.DRAW_MODES constants.

Member

PIXI.Mesh#drawMode

See

PIXI.DRAW_MODES

Inherited from

Mesh.drawMode

Defined in

node_modules/pixi.js/pixi.js.d.ts:13418

filterArea

• filterArea: Rectangle

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.

Member

PIXI.DisplayObject#filterArea

Inherited from

Mesh.filterArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:13849

filters

• filters: Filter[]

Sets the filters for the displayObject.

Member

PIXI.DisplayObject#filters

Inherited from

Mesh.filters

Defined in

node_modules/pixi.js/pixi.js.d.ts:13857

geometry

• geometry: DBaseBackgroundMeshGeometry

Overrides

Mesh.geometry

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:12

hitArea

• hitArea: IHitArea

Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject’s bounds.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.hitArea

Defined in

node_modules/pixi.js/pixi.js.d.ts:14140

interactive

• interactive: boolean

Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless interactive is set to true.

Example

const sprite = new PIXI.Sprite(texture);
sprite.interactive = true;
sprite.on('tap', (event) => {
   //handle event
});

Member

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.interactive

Defined in

node_modules/pixi.js/pixi.js.d.ts:14128

interactiveChildren

• interactiveChildren: boolean

Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive hitTest function

Member

Memberof

PIXI.Container#

Inherited from

Mesh.interactiveChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13706

isMask

• isMask: boolean

Does any other displayObject use this object as a mask?

Member

PIXI.DisplayObject#isMask

Inherited from

Mesh.isMask

Defined in

node_modules/pixi.js/pixi.js.d.ts:13920

isSprite

• isSprite: boolean

used to fast check if a sprite is.. a sprite!

Member

PIXI.DisplayObject#isSprite

Inherited from

Mesh.isSprite

Defined in

node_modules/pixi.js/pixi.js.d.ts:13915

localTransform

• Readonly localTransform: Matrix

Current transform of the object based on local factors: position, scale, other stuff.

Member

Inherited from

Mesh.localTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:14028

mask

• mask: null | Container | MaskData

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. 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.

Example

const graphics = new PIXI.Graphics();
graphics.beginFill(0xFF3300);
graphics.drawRect(50, 250, 100, 100);
graphics.endFill();

const sprite = new PIXI.Sprite(texture);
sprite.mask = graphics;

Todo

At the moment, PIXI.CanvasRenderer doesn’t support PIXI.Sprite as mask.

Member

Inherited from

Mesh.mask

Defined in

node_modules/pixi.js/pixi.js.d.ts:14106

material

• material: MeshMaterial

Alias for PIXI.Mesh#shader.

Member

Inherited from

Mesh.material

Defined in

node_modules/pixi.js/pixi.js.d.ts:13448

name

• name: string

The instance name of the object.

Memberof

PIXI.DisplayObject#

Member

name

Inherited from

Mesh.name

Defined in

node_modules/pixi.js/pixi.js.d.ts:14186

parent

• parent: Container

The display object container that contains this display object.

Member

PIXI.DisplayObject#parent

Inherited from

Mesh.parent

Defined in

node_modules/pixi.js/pixi.js.d.ts:13817

pivot

• pivot: ObservablePoint

The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.

Member

Inherited from

Mesh.pivot

Defined in

node_modules/pixi.js/pixi.js.d.ts:14049

position

• position: ObservablePoint

The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.

Member

Inherited from

Mesh.position

Defined in

node_modules/pixi.js/pixi.js.d.ts:14035

renderable

• renderable: boolean

Can 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.

Member

PIXI.DisplayObject#renderable

Inherited from

Mesh.renderable

Defined in

node_modules/pixi.js/pixi.js.d.ts:13811

rotation

• rotation: number

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.

Member

Inherited from

Mesh.rotation

Defined in

node_modules/pixi.js/pixi.js.d.ts:14063

roundPixels

• roundPixels: boolean

If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth. To set the global default, change PIXI.settings.ROUND_PIXELS

Member

Default

false

Inherited from

Mesh.roundPixels

Defined in

node_modules/pixi.js/pixi.js.d.ts:13467

scale

• scale: ObservablePoint

The scale factor of the object. Assignment by value since pixi-v4.

Member

Inherited from

Mesh.scale

Defined in

node_modules/pixi.js/pixi.js.d.ts:14042

shader

• shader: MeshMaterial

Overrides

Mesh.shader

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:13

size

• size: number

How much of the geometry to draw, by default 0 renders everything.

Member

PIXI.Mesh#size

Default

0

Inherited from

Mesh.size

Defined in

node_modules/pixi.js/pixi.js.d.ts:13430

skew

• skew: ObservablePoint

The skew factor for the object in radians. Assignment by value since pixi-v4.

Member

Inherited from

Mesh.skew

Defined in

node_modules/pixi.js/pixi.js.d.ts:14056

sortDirty

• sortDirty: boolean

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.

Member

PIXI.Container#sortDirty

Inherited from

Mesh.sortDirty

Defined in

node_modules/pixi.js/pixi.js.d.ts:13570

sortableChildren

• sortableChildren: boolean

If 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

Link

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.

See

PIXI.settings.SORTABLE_CHILDREN

Member

PIXI.Container#sortableChildren

Inherited from

Mesh.sortableChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13563

start

• start: number

Typically the index of the IndexBuffer where to start drawing.

Member

PIXI.Mesh#start

Default

0

Inherited from

Mesh.start

Defined in

node_modules/pixi.js/pixi.js.d.ts:13424

state

• state: State

Represents the WebGL state the Mesh required to render, excludes shader and geometry. E.g., blend mode, culling, depth testing, direction of rendering triangles, backface, etc.

Member

PIXI.Mesh#state

Inherited from

Mesh.state

Defined in

node_modules/pixi.js/pixi.js.d.ts:13411

texture

• texture: Texture

The texture that the Mesh uses.

Member

Inherited from

Mesh.texture

Defined in

node_modules/pixi.js/pixi.js.d.ts:13481

tint

• tint: number

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

Member

Default

0xFFFFFF

Inherited from

Mesh.tint

Defined in

node_modules/pixi.js/pixi.js.d.ts:13475

transform

• transform: Transform

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.

Member

PIXI.DisplayObject#transform

Inherited from

Mesh.transform

Defined in

node_modules/pixi.js/pixi.js.d.ts:13787

uvBuffer

• Readonly uvBuffer: Buffer

To change mesh uv’s, change its uvBuffer data and increment its _updateID.

Member

Inherited from

Mesh.uvBuffer

Defined in

node_modules/pixi.js/pixi.js.d.ts:13436

verticesBuffer

• Readonly verticesBuffer: Buffer

To change mesh vertices, change its uvBuffer data and increment its _updateID. Incrementing _updateID is optional because most of Mesh objects do it anyway.

Member

Inherited from

Mesh.verticesBuffer

Defined in

node_modules/pixi.js/pixi.js.d.ts:13443

visible

• visible: boolean

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.

Member

PIXI.DisplayObject#visible

Inherited from

Mesh.visible

Defined in

node_modules/pixi.js/pixi.js.d.ts:13802

worldAlpha

• Readonly worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

Inherited from

Mesh.worldAlpha

Defined in

node_modules/pixi.js/pixi.js.d.ts:13824

worldTransform

• Readonly worldTransform: Matrix

Current transform of the object based on world (parent) factors.

Member

Inherited from

Mesh.worldTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:14021

worldVisible

• Readonly worldVisible: boolean

Indicates if the object is globally visible.

Member

Inherited from

Mesh.worldVisible

Defined in

node_modules/pixi.js/pixi.js.d.ts:14086

x

• x: number

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

Member

Inherited from

Mesh.x

Defined in

node_modules/pixi.js/pixi.js.d.ts:14007

y

• y: number

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

Member

Inherited from

Mesh.y

Defined in

node_modules/pixi.js/pixi.js.d.ts:14014

zIndex

• zIndex: number

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 displayObjects within the same container.

Member

Inherited from

Mesh.zIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:14079

BATCHABLE_SIZE

▪ Static BATCHABLE_SIZE: number

The maximum number of vertices to consider batchable. Generally, the complexity of the geometry.

Memberof

PIXI.Mesh

Static

Member

BATCHABLE_SIZE

Inherited from

Mesh.BATCHABLE_SIZE

Defined in

node_modules/pixi.js/pixi.js.d.ts:13540

Accessors

cornerMask

• get cornerMask(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:48

• set cornerMask(cornerMask): void

Parameters

Name Type
cornerMask number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:52

cornerRadius

• get cornerRadius(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:40

• set cornerRadius(cornerRadius): void

Parameters

Name Type
cornerRadius number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:44

height

• get height(): number

Returns

number

Overrides

Mesh.height

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:32

• set height(height): void

Parameters

Name Type
height number

Returns

void

Overrides

Mesh.height

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:36

width

• get width(): number

Returns

number

Overrides

Mesh.width

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:23

• set width(width): void

Parameters

Name Type
width number

Returns

void

Overrides

Mesh.width

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:27

Methods

_calculateBounds

▸ _calculateBounds(): void

Updates the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account. there must be a aVertexPosition attribute present in the geometry for bounds to be calculated correctly.

Returns

void

Inherited from

Mesh._calculateBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13514

_recursivePostUpdateTransform

▸ _recursivePostUpdateTransform(): void

Recursively updates transform of all objects from the root to this one internal function for toLocal()

Returns

void

Inherited from

Mesh._recursivePostUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:13925

_render

▸ _render(renderer): void

Parameters

Name Type
renderer Renderer

Returns

void

Overrides

Mesh._render

Defined in

src/main/typescript/wcardinal/ui/d-base-background-mesh.ts:56

_renderDefault

▸ _renderDefault(renderer): void

Standard non-batching way of rendering.

Parameters

Name Type Description
renderer Renderer Instance to renderer.

Returns

void

Inherited from

Mesh._renderDefault

Defined in

node_modules/pixi.js/pixi.js.d.ts:13493

_renderToBatch

▸ _renderToBatch(renderer): void

Rendering by using the Batch system.

Parameters

Name Type Description
renderer Renderer Instance to renderer.

Returns

void

Inherited from

Mesh._renderToBatch

Defined in

node_modules/pixi.js/pixi.js.d.ts:13499

addChild

▸ addChild<TChildren>(...children): TChildren[0]

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Type parameters

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to add to the container

Returns

TChildren[0]

The first child that was added.

Inherited from

Mesh.addChild

Defined in

node_modules/pixi.js/pixi.js.d.ts:13585

addChildAt

▸ addChildAt<T>(child, index): T

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

Type parameters

Name Type
T extends DisplayObject

Parameters

Name Type Description
child T The child to add
index number The index to place the child in

Returns

T

The child that was added.

Inherited from

Mesh.addChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:13593

addListener

▸ addListener(event, fn, context?): this

Parameters

Name Type
event InteractionEventTypes
fn (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

Mesh.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25521

▸ addListener(event, fn, context?): this

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Inherited from

Mesh.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25523

calculateBounds

▸ calculateBounds(): void

Recalculates the bounds of the container.

Returns

void

Inherited from

Mesh.calculateBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13656

calculateUvs

▸ calculateUvs(): void

Updates uv field based on from geometry uv’s or batchUvs

Returns

void

Inherited from

Mesh.calculateUvs

Defined in

node_modules/pixi.js/pixi.js.d.ts:13507

calculateVertices

▸ calculateVertices(): void

Updates vertexData field based on transform and vertices

Returns

void

Inherited from

Mesh.calculateVertices

Defined in

node_modules/pixi.js/pixi.js.d.ts:13503

containerUpdateTransform

▸ containerUpdateTransform(): void

Container default updateTransform, does update children of container. Will crash if there’s no parent element.

Returns

void

Memberof

PIXI.Container#

Function

containerUpdateTransform

Inherited from

Mesh.containerUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:13698

containsPoint

▸ containsPoint(point): boolean

Tests if a point is inside this mesh. Works only for PIXI.DRAW_MODES.TRIANGLES.

Parameters

Name Type Description
point IPointData the point to test

Returns

boolean

the result of the test

Inherited from

Mesh.containsPoint

Defined in

node_modules/pixi.js/pixi.js.d.ts:13521

destroy

▸ destroy(options?): void

Destroys the Mesh object.

Parameters

Name Type Description
options? Object Options parameter. A boolean will act as if all options have been set to that value
options.children? boolean if set to true, all the children will have their destroy method called as well. ‘options’ will be passed on to those calls.

Returns

void

Inherited from

Mesh.destroy

Defined in

node_modules/pixi.js/pixi.js.d.ts:13530

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name Type Description
cacheParent DisplayObject actual parent of element

Returns

void

Inherited from

Mesh.disableTempParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:14000

displayObjectUpdateTransform

▸ displayObjectUpdateTransform(): void

DisplayObject default updateTransform, does not update children of container. Will crash if there’s no parent element.

Returns

void

Memberof

PIXI.DisplayObject#

Function

displayObjectUpdateTransform

Inherited from

Mesh.displayObjectUpdateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:14114

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.
...args any[] Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Inherited from

Mesh.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

enableTempParent

▸ enableTempParent(): DisplayObject

Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

const cacheParent = elem.enableTempParent();
elem.updateTransform();
elem.disableTempParent(cacheParent);

Returns

DisplayObject

current parent

Inherited from

Mesh.enableTempParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:13995

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

Mesh.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

getBounds

▸ getBounds(skipUpdate?, rect?): Rectangle

Retrieves the bounds of the displayObject as a rectangle object.

Parameters

Name Type Description
skipUpdate? boolean Setting 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.
rect? Rectangle Optional rectangle to store the result of the bounds calculation.

Returns

Rectangle

The rectangular bounding area.

Inherited from

Mesh.getBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13935

getChildAt

▸ getChildAt(index): DisplayObject

Returns the child at the specified index

Parameters

Name Type Description
index number The index to get the child at

Returns

DisplayObject

The child at the given index, if any.

Inherited from

Mesh.getChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:13621

getChildByName

▸ getChildByName(name, deep?): DisplayObject

Returns the display object in the container.

Recursive searches are done in a preorder traversal.

Parameters

Name Type Description
name string Instance name.
deep? boolean Whether to search recursively

Returns

DisplayObject

The child with the specified name.

Method

getChildByName

Memberof

PIXI.Container#

Inherited from

Mesh.getChildByName

Defined in

node_modules/pixi.js/pixi.js.d.ts:13718

getChildIndex

▸ getChildIndex(child): number

Returns the index position of a child DisplayObject instance

Parameters

Name Type Description
child DisplayObject The DisplayObject instance to identify

Returns

number

The index position of the child display object to identify

Inherited from

Mesh.getChildIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:13607

getGlobalPosition

▸ getGlobalPosition(point?, skipUpdate?): Point

Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.

Parameters

Name Type Description
point? Point The point to write the global value to.
skipUpdate? boolean Setting 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.

Returns

Point

The updated point.

Method

getGlobalPosition

Memberof

PIXI.DisplayObject#

Inherited from

Mesh.getGlobalPosition

Defined in

node_modules/pixi.js/pixi.js.d.ts:14198

getLocalBounds

▸ getLocalBounds(rect?, skipChildrenUpdate?): Rectangle

Retrieves the local bounds of the displayObject as a rectangle object.

Parameters

Name Type Description
rect? Rectangle Optional rectangle to store the result of the bounds calculation.
skipChildrenUpdate? boolean Setting 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.

Returns

Rectangle

The rectangular bounding area.

Inherited from

Mesh.getLocalBounds

Defined in

node_modules/pixi.js/pixi.js.d.ts:13665

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

number

Inherited from

Mesh.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

Function[]

Inherited from

Mesh.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

off

▸ off(event, fn?, context?): this

Parameters

Name Type
event string
fn? Function
context? any

Returns

this

Inherited from

Mesh.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25534

on

▸ on(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

Mesh.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25530

▸ on(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

Mesh.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25532

onChildrenChange

▸ onChildrenChange(): void

Overridable method that can be used by Container subclasses whenever the children array is modified

Returns

void

Inherited from

Mesh.onChildrenChange

Defined in

node_modules/pixi.js/pixi.js.d.ts:13576

once

▸ once(event, fn, context?): this

Parameters

Name Type
event "removed" | "added"
fn (displayObject: DisplayObject) => void
context? any

Returns

this

Inherited from

Mesh.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25527

▸ once(event, fn, context?): this

Parameters

Name Type
event string
fn Function
context? any

Returns

this

Inherited from

Mesh.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25529

removeAllListeners

▸ removeAllListeners(event?): this

Parameters

Name Type
event? InteractionEventTypes

Returns

this

Inherited from

Mesh.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25516

▸ removeAllListeners(event?): this

Parameters

Name Type
event? string | symbol

Returns

this

Inherited from

Mesh.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25517

removeChild

▸ removeChild<TChildren>(...children): TChildren[0]

Removes one or more children from the container.

Type parameters

Name Type
TChildren extends DisplayObject[]

Parameters

Name Type Description
...children TChildren The DisplayObject(s) to remove

Returns

TChildren[0]

The first child that was removed.

Inherited from

Mesh.removeChild

Defined in

node_modules/pixi.js/pixi.js.d.ts:13628

removeChildAt

▸ removeChildAt(index): DisplayObject

Removes a child from the specified index position.

Parameters

Name Type Description
index number The index to get the child from

Returns

DisplayObject

The child that was removed.

Inherited from

Mesh.removeChildAt

Defined in

node_modules/pixi.js/pixi.js.d.ts:13635

removeChildren

▸ removeChildren(beginIndex?, endIndex?): DisplayObject[]

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

Parameters

Name Type Description
beginIndex? number The beginning position.
endIndex? number The ending position. Default value is size of the container.

Returns

DisplayObject[]

List of removed children

Inherited from

Mesh.removeChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13643

removeListener

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event InteractionEventTypes
fn? (event: InteractionEvent) => void
context? any

Returns

this

Inherited from

Mesh.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25513

▸ removeListener(event, fn?, context?): this

Parameters

Name Type
event string | symbol
fn? Function
context? any

Returns

this

Inherited from

Mesh.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25515

render

▸ render(renderer): void

Renders the object using the WebGL renderer

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

Mesh.render

Defined in

node_modules/pixi.js/pixi.js.d.ts:13671

renderAdvanced

▸ renderAdvanced(renderer): void

Render the object using the WebGL renderer and advanced features.

Parameters

Name Type Description
renderer Renderer The renderer

Returns

void

Inherited from

Mesh.renderAdvanced

Defined in

node_modules/pixi.js/pixi.js.d.ts:13678

setChildIndex

▸ setChildIndex(child, index): void

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

Parameters

Name Type Description
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

Returns

void

Inherited from

Mesh.setChildIndex

Defined in

node_modules/pixi.js/pixi.js.d.ts:13614

setParent

▸ setParent(container): Container

Set the parent Container of this DisplayObject.

Parameters

Name Type Description
container Container The Container to add this DisplayObject to.

Returns

Container

The Container that this DisplayObject was added to.

Inherited from

Mesh.setParent

Defined in

node_modules/pixi.js/pixi.js.d.ts:13963

setTransform

▸ setTransform(x?, y?, scaleX?, scaleY?, rotation?, skewX?, skewY?, pivotX?, pivotY?): DisplayObject

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

Parameters

Name Type Description
x? number The X position
y? number The Y position
scaleX? number The X scale value
scaleY? number The Y scale value
rotation? number The rotation
skewX? number The X skew value
skewY? number The Y skew value
pivotX? number The X pivot value
pivotY? number The Y pivot value

Returns

DisplayObject

The DisplayObject instance

Inherited from

Mesh.setTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:13978

sortChildren

▸ sortChildren(): void

Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.

Returns

void

Inherited from

Mesh.sortChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13647

swapChildren

▸ swapChildren(child, child2): void

Swaps the position of 2 Display Objects within this container.

Parameters

Name Type Description
child DisplayObject First display object to swap
child2 DisplayObject Second display object to swap

Returns

void

Inherited from

Mesh.swapChildren

Defined in

node_modules/pixi.js/pixi.js.d.ts:13600

toGlobal

▸ toGlobal(position, point?, skipUpdate?): Point

Calculates the global position of the display object.

Parameters

Name Type Description
position IPointData The world origin to calculate from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform.

Returns

Point

A point object representing the position of this object.

Inherited from

Mesh.toGlobal

Defined in

node_modules/pixi.js/pixi.js.d.ts:13945

toLocal

▸ toLocal(position, from?, point?, skipUpdate?): Point

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

Parameters

Name Type Description
position IPointData The world origin to calculate from.
from? DisplayObject The DisplayObject to calculate the global position from.
point? Point A Point object in which to store the value, optional (otherwise will create a new Point).
skipUpdate? boolean Should we skip the update transform

Returns

Point

A point object representing the position of this object

Inherited from

Mesh.toLocal

Defined in

node_modules/pixi.js/pixi.js.d.ts:13956

updateTransform

▸ updateTransform(): void

Updates the transform on all children of this container for rendering

Returns

void

Inherited from

Mesh.updateTransform

Defined in

node_modules/pixi.js/pixi.js.d.ts:13651

mixin

▸ mixin(source): void

Mixes all enumerable properties and methods from a source object to DisplayObject.

Parameters

Name Type Description
source any The source of properties and methods to mix in.

Returns

void

Inherited from

Mesh.mixin

Defined in

node_modules/pixi.js/pixi.js.d.ts:9230

Edit this page.