Winter Cardinal UI - v0.442.0 / DShadowImpl

Class: DShadowImpl

Hierarchy

NineSlicePlane

↳ DShadowImpl

Implements

DShadow

Constructors

constructor

Properties

Methods

Constructors

constructor

• new DShadowImpl(texture, width, height, offsetX, offsetY): DShadowImpl

Parameters

Name	Type
`texture`	`Texture`
`width`	`number`
`height`	`number`
`offsetX`	`number`
`offsetY`	`number`

Returns

DShadowImpl

Overrides

NineSlicePlane.constructor

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:16

Properties

_accessibleActive

• _accessibleActive: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Implementation of

DShadow._accessibleActive

Inherited from

NineSlicePlane._accessibleActive

Defined in

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

_accessibleDiv

• _accessibleDiv: boolean

Member

Memberof

PIXI.DisplayObject#

Todo

Needs docs.

Implementation of

DShadow._accessibleDiv

Inherited from

NineSlicePlane._accessibleDiv

Defined in

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

_bounds

• _bounds: Bounds

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

Member

PIXI.DisplayObject#_bounds

Implementation of

DShadow._bounds

Inherited from

NineSlicePlane._bounds

Defined in

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

_boundsID

• Protected _boundsID: number

Flags the cached bounds as dirty.

Member

PIXI.DisplayObject#_boundsID

Implementation of

DShadow._boundsID

Inherited from

NineSlicePlane._boundsID

Defined in

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

_boundsRect

• Protected _boundsRect: Bounds

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

Member

PIXI.DisplayObject#_boundsRect

Implementation of

DShadow._boundsRect

Inherited from

NineSlicePlane._boundsRect

Defined in

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

_destroyed

• Protected _destroyed: boolean

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

Member

PIXI.DisplayObject#_destroyed

Implementation of

DShadow._destroyed

Inherited from

NineSlicePlane._destroyed

Defined in

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

_enabledFilters

• Protected _enabledFilters: Filter[]

Currently enabled filters

Member

PIXI.DisplayObject#_enabledFilters

Implementation of

DShadow._enabledFilters

Inherited from

NineSlicePlane._enabledFilters

Defined in

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

_height

• _height: number

The height of the NineSlicePlane, setting this will actually modify the vertices and UV’s of this plane

Member

PIXI.NineSlicePlane#_height

Inherited from

NineSlicePlane._height

Defined in

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

_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

Implementation of

DShadow._lastSortedIndex

Inherited from

NineSlicePlane._lastSortedIndex

Defined in

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

_localBounds

• _localBounds: Bounds

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

Member

PIXI.DisplayObject#_localBounds

Implementation of

DShadow._localBounds

Inherited from

NineSlicePlane._localBounds

Defined in

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

_localBoundsRect

• Protected _localBoundsRect: Bounds

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

Member

PIXI.DisplayObject#_localBoundsRect

Implementation of

DShadow._localBoundsRect

Inherited from

NineSlicePlane._localBoundsRect

Defined in

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

_mask

• Protected _mask: null | Container | MaskData

The original, cached mask of the object.

Member

PIXI.DisplayObject#_mask

Implementation of

DShadow._mask

Inherited from

NineSlicePlane._mask

Defined in

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

_offsetX

• Protected _offsetX: number

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:11

_offsetY

• Protected _offsetY: number

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:12

_shiftX

• Protected _shiftX: number

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:13

_shiftY

• Protected _shiftY: number

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:14

_tempDisplayObjectParent

• Protected _tempDisplayObjectParent: Container

Member

Implementation of

DShadow._tempDisplayObjectParent

Inherited from

NineSlicePlane._tempDisplayObjectParent

Defined in

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

_width

• _width: number

The width of the NineSlicePlane, setting this will actually modify the vertices and UV’s of this plane

Member

PIXI.NineSlicePlane#_width

Inherited from

NineSlicePlane._width

Defined in

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

_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

Implementation of

DShadow._zIndex

Inherited from

NineSlicePlane._zIndex

Defined in

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

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#

Implementation of

DShadow.accessible

Inherited from

NineSlicePlane.accessible

Defined in

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

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

Implementation of

DShadow.accessibleChildren

Inherited from

NineSlicePlane.accessibleChildren

Defined in

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

accessibleHint

• accessibleHint: string

Sets the aria-label attribute of the shadow div

Member

Memberof

PIXI.DisplayObject#

Implementation of

DShadow.accessibleHint

Inherited from

NineSlicePlane.accessibleHint

Defined in

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

accessiblePointerEvents

• accessiblePointerEvents: string

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

Member

Memberof

PIXI.DisplayObject#

Default

'auto'

Implementation of

DShadow.accessiblePointerEvents

Inherited from

NineSlicePlane.accessiblePointerEvents

Defined in

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

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#

Implementation of

DShadow.accessibleTitle

Inherited from

NineSlicePlane.accessibleTitle

Defined in

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

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'

Implementation of

DShadow.accessibleType

Inherited from

NineSlicePlane.accessibleType

Defined in

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

alpha

• alpha: number

The opacity of the object.

Member

PIXI.DisplayObject#alpha

Implementation of

DShadow.alpha

Inherited from

NineSlicePlane.alpha

Defined in

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

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

Implementation of

DShadow.angle

Inherited from

NineSlicePlane.angle

Defined in

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

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

NineSlicePlane.blendMode

Defined in

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

bottomHeight

• bottomHeight: number

The height of the bottom row

Member

Inherited from

NineSlicePlane.bottomHeight

Defined in

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

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#

Implementation of

DShadow.buttonMode

Inherited from

NineSlicePlane.buttonMode

Defined in

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

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#

Implementation of

DShadow.cacheAsBitmap

Inherited from

NineSlicePlane.cacheAsBitmap

Defined in

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

children

• Readonly children: DisplayObject[]

The array of children of this container.

Member

PIXI.Container#children

Inherited from

NineSlicePlane.children

Defined in

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

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#

Implementation of

DShadow.cursor

Inherited from

NineSlicePlane.cursor

Defined in

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

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

NineSlicePlane.drawMode

Defined in

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

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

Implementation of

DShadow.filterArea

Inherited from

NineSlicePlane.filterArea

Defined in

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

filters

• filters: Filter[]

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

Member

PIXI.DisplayObject#filters

Implementation of

DShadow.filters

Inherited from

NineSlicePlane.filters

Defined in

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

geometry

• Readonly geometry: Geometry

Includes vertex positions, face indices, normals, colors, UVs, and custom attributes within buffers, reducing the cost of passing all this data to the GPU. Can be shared between multiple Mesh objects.

Member

PIXI.Mesh#geometry

Inherited from

NineSlicePlane.geometry

Defined in

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

height

• height: number

The height of the NineSlicePlane, setting this will actually modify the vertices and UV’s of this plane

Member

Inherited from

NineSlicePlane.height

Defined in

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

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#

Implementation of

DShadow.hitArea

Inherited from

NineSlicePlane.hitArea

Defined in

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

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#

Implementation of

DShadow.interactive

Inherited from

NineSlicePlane.interactive

Defined in

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

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

NineSlicePlane.interactiveChildren

Defined in

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

isMask

• isMask: boolean

Does any other displayObject use this object as a mask?

Member

PIXI.DisplayObject#isMask

Implementation of

DShadow.isMask

Inherited from

NineSlicePlane.isMask

Defined in

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

isSprite

• isSprite: boolean

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

Member

PIXI.DisplayObject#isSprite

Implementation of

DShadow.isSprite

Inherited from

NineSlicePlane.isSprite

Defined in

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

leftWidth

• leftWidth: number

The width of the left column

Member

Inherited from

NineSlicePlane.leftWidth

Defined in

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

localTransform

• Readonly localTransform: Matrix

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

Member

Implementation of

DShadow.localTransform

Inherited from

NineSlicePlane.localTransform

Defined in

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

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

Implementation of

DShadow.mask

Inherited from

NineSlicePlane.mask

Defined in

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

material

• material: MeshMaterial

Alias for PIXI.Mesh#shader.

Member

Inherited from

NineSlicePlane.material

Defined in

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

name

• name: string

The instance name of the object.

Memberof

PIXI.DisplayObject#

Member

name

Implementation of

DShadow.name

Inherited from

NineSlicePlane.name

Defined in

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

parent

• parent: Container

The display object container that contains this display object.

Member

PIXI.DisplayObject#parent

Implementation of

DShadow.parent

Inherited from

NineSlicePlane.parent

Defined in

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

pivot

• pivot: ObservablePoint

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

Member

Implementation of

DShadow.pivot

Inherited from

NineSlicePlane.pivot

Defined in

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

position

• position: ObservablePoint

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

Member

Implementation of

DShadow.position

Inherited from

NineSlicePlane.position

Defined in

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

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

Implementation of

DShadow.renderable

Inherited from

NineSlicePlane.renderable

Defined in

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

rightWidth

• rightWidth: number

The width of the right column

Member

Inherited from

NineSlicePlane.rightWidth

Defined in

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

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

Implementation of

DShadow.rotation

Inherited from

NineSlicePlane.rotation

Defined in

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

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

NineSlicePlane.roundPixels

Defined in

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

scale

• scale: ObservablePoint

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

Member

Implementation of

DShadow.scale

Inherited from

NineSlicePlane.scale

Defined in

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

shader

• shader: Shader | MeshMaterial

Represents the vertex and fragment shaders that processes the geometry and runs on the GPU. Can be shared between multiple Mesh objects.

Member

PIXI.Mesh#shader

Inherited from

NineSlicePlane.shader

Defined in

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

size

• size: number

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

Member

PIXI.Mesh#size

Default

Inherited from

NineSlicePlane.size

Defined in

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

skew

• skew: ObservablePoint

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

Member

Implementation of

DShadow.skew

Inherited from

NineSlicePlane.skew

Defined in

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

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

NineSlicePlane.sortDirty

Defined in

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

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

NineSlicePlane.sortableChildren

Defined in

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

start

• start: number

Typically the index of the IndexBuffer where to start drawing.

Member

PIXI.Mesh#start

Default

Inherited from

NineSlicePlane.start

Defined in

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

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

NineSlicePlane.state

Defined in

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

texture

• texture: Texture

The texture that the Mesh uses.

Member

Inherited from

NineSlicePlane.texture

Defined in

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

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

NineSlicePlane.tint

Defined in

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

topHeight

• topHeight: number

The height of the top row

Member

Inherited from

NineSlicePlane.topHeight

Defined in

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

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

Implementation of

DShadow.transform

Inherited from

NineSlicePlane.transform

Defined in

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

uvBuffer

• Readonly uvBuffer: Buffer

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

Member

Inherited from

NineSlicePlane.uvBuffer

Defined in

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

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

NineSlicePlane.verticesBuffer

Defined in

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

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

Implementation of

DShadow.visible

Inherited from

NineSlicePlane.visible

Defined in

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

width

• width: number

The width of the NineSlicePlane, setting this will actually modify the vertices and UV’s of this plane

Member

Inherited from

NineSlicePlane.width

Defined in

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

worldAlpha

• Readonly worldAlpha: number

The multiplied alpha of the displayObject.

Member

PIXI.DisplayObject#worldAlpha

Implementation of

DShadow.worldAlpha

Inherited from

NineSlicePlane.worldAlpha

Defined in

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

worldTransform

• Readonly worldTransform: Matrix

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

Member

Implementation of

DShadow.worldTransform

Inherited from

NineSlicePlane.worldTransform

Defined in

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

worldVisible

• Readonly worldVisible: boolean

Indicates if the object is globally visible.

Member

Implementation of

DShadow.worldVisible

Inherited from

NineSlicePlane.worldVisible

Defined in

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

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

Implementation of

DShadow.x

Inherited from

NineSlicePlane.x

Defined in

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

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

Implementation of

DShadow.y

Inherited from

NineSlicePlane.y

Defined in

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

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

Implementation of

DShadow.zIndex

Inherited from

NineSlicePlane.zIndex

Defined in

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

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

NineSlicePlane.BATCHABLE_SIZE

Defined in

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

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

NineSlicePlane._calculateBounds

Defined in

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

_recursivePostUpdateTransform

▸ _recursivePostUpdateTransform(): void

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

Returns

void

Implementation of

DShadow._recursivePostUpdateTransform

Inherited from

NineSlicePlane._recursivePostUpdateTransform

Defined in

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

_refresh

▸ _refresh(): void

Refreshes NineSlicePlane coords. All of them.

Returns

void

Inherited from

NineSlicePlane._refresh

Defined in

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

_render

▸ _render(renderer): void

Standard renderer draw.

Parameters

Name	Type	Description
`renderer`	`Renderer`	Instance to renderer.

Returns

void

Inherited from

NineSlicePlane._render

Defined in

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

_renderDefault

▸ _renderDefault(renderer): void

Standard non-batching way of rendering.

Parameters

Name	Type	Description
`renderer`	`Renderer`	Instance to renderer.

Returns

void

Inherited from

NineSlicePlane._renderDefault

Defined in

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

_renderToBatch

▸ _renderToBatch(renderer): void

Rendering by using the Batch system.

Parameters

Name	Type	Description
`renderer`	`Renderer`	Instance to renderer.

Returns

void

Inherited from

NineSlicePlane._renderToBatch

Defined in

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

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

NineSlicePlane.addChild

Defined in

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

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

NineSlicePlane.addChildAt

Defined in

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

addListener

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

Parameters

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

Returns

this

Implementation of

DShadow.addListener

Inherited from

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

Implementation of

DShadow.addListener

Inherited from

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

NineSlicePlane.calculateBounds

Defined in

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

calculateUvs

▸ calculateUvs(): void

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

Returns

void

Inherited from

NineSlicePlane.calculateUvs

Defined in

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

calculateVertices

▸ calculateVertices(): void

Updates vertexData field based on transform and vertices

Returns

void

Inherited from

NineSlicePlane.calculateVertices

Defined in

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

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

NineSlicePlane.containerUpdateTransform

Defined in

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

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

NineSlicePlane.containsPoint

Defined in

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

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

Implementation of

DShadow.destroy

Inherited from

NineSlicePlane.destroy

Defined in

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

disableTempParent

▸ disableTempParent(cacheParent): void

Pair method for enableTempParent

Parameters

Name	Type	Description
`cacheParent`	`DisplayObject`	actual parent of element

Returns

void

Implementation of

DShadow.disableTempParent

Inherited from

NineSlicePlane.disableTempParent

Defined in

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

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

Implementation of

DShadow.displayObjectUpdateTransform

Inherited from

NineSlicePlane.displayObjectUpdateTransform

Defined in

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

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.

Implementation of

DShadow.emit

Inherited from

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

Implementation of

DShadow.enableTempParent

Inherited from

NineSlicePlane.enableTempParent

Defined in

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

eventNames

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

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

Returns

(string | symbol)[]

Implementation of

DShadow.eventNames

Inherited from

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

Implementation of

DShadow.getBounds

Inherited from

NineSlicePlane.getBounds

Defined in

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

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

NineSlicePlane.getChildAt

Defined in

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

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

NineSlicePlane.getChildByName

Defined in

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

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

NineSlicePlane.getChildIndex

Defined in

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

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#

Implementation of

DShadow.getGlobalPosition

Inherited from

NineSlicePlane.getGlobalPosition

Defined in

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

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.

Implementation of

DShadow.getLocalBounds

Inherited from

NineSlicePlane.getLocalBounds

Defined in

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

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

Implementation of

DShadow.listenerCount

Inherited from

NineSlicePlane.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[]

Implementation of

DShadow.listeners

Inherited from

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

Implementation of

DShadow.off

Inherited from

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

Implementation of

DShadow.on

Inherited from

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

Implementation of

DShadow.on

Inherited from

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

NineSlicePlane.onChildrenChange

Defined in

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

onReflow

▸ onReflow(base, width, height): void

Parameters

Name	Type
`base`	`DBase`<`DThemeBase`, `DBaseOptions`<`DThemeBase`, `any`>>
`width`	`number`
`height`	`number`

Returns

void

Implementation of

DShadow.onReflow

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:36

onTextureUpdate

▸ onTextureUpdate(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:32

once

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

Parameters

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

Returns

this

Implementation of

DShadow.once

Inherited from

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

Implementation of

DShadow.once

Inherited from

NineSlicePlane.once

Defined in

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

removeAllListeners

▸ removeAllListeners(event?): this

Parameters

Name	Type
`event?`	`InteractionEventTypes`

Returns

this

Implementation of

DShadow.removeAllListeners

Inherited from

NineSlicePlane.removeAllListeners

Defined in

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

▸ removeAllListeners(event?): this

Parameters

Name	Type
`event?`	`string` \| `symbol`

Returns

this

Implementation of

DShadow.removeAllListeners

Inherited from

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

NineSlicePlane.removeChild

Defined in

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

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

NineSlicePlane.removeChildAt

Defined in

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

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

NineSlicePlane.removeChildren

Defined in

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

removeListener

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

Parameters

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

Returns

this

Implementation of

DShadow.removeListener

Inherited from

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

Implementation of

DShadow.removeListener

Inherited from

NineSlicePlane.removeListener

Defined in

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

render

▸ render(renderer): void

Parameters

Name	Type
`renderer`	`Renderer`

Returns

void

Implementation of

DShadow.render

Overrides

NineSlicePlane.render

Defined in

src/main/typescript/wcardinal/ui/d-shadow-impl.ts:45

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

NineSlicePlane.renderAdvanced

Defined in

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

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

NineSlicePlane.setChildIndex

Defined in

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

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.

Implementation of

DShadow.setParent

Inherited from

NineSlicePlane.setParent

Defined in

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

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

Implementation of

DShadow.setTransform

Inherited from

NineSlicePlane.setTransform

Defined in

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

sortChildren

▸ sortChildren(): void

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

Returns

void

Inherited from

NineSlicePlane.sortChildren

Defined in

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

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

NineSlicePlane.swapChildren

Defined in

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

textureUpdated

▸ textureUpdated(): void

Method used for overrides, to do something in case texture frame was changed. Meshes based on plane can override it and change more details based on texture.

Returns

void

Inherited from

NineSlicePlane.textureUpdated

Defined in

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

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.

Implementation of

DShadow.toGlobal

Inherited from

NineSlicePlane.toGlobal

Defined in

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

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

Implementation of

DShadow.toLocal

Inherited from

NineSlicePlane.toLocal

Defined in

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

updateHorizontalVertices

▸ updateHorizontalVertices(): void

Updates the horizontal vertices.

Returns

void

Inherited from

NineSlicePlane.updateHorizontalVertices

Defined in

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

updateTransform

▸ updateTransform(): void

Updates the transform on all children of this container for rendering

Returns

void

Implementation of

DShadow.updateTransform

Inherited from

NineSlicePlane.updateTransform

Defined in

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

updateVerticalVertices

▸ updateVerticalVertices(): void

Updates the vertical vertices.

Returns

void

Inherited from

NineSlicePlane.updateVerticalVertices

Defined in

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

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

NineSlicePlane.mixin

Defined in

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

Edit this page.

Class: DShadowImpl

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Properties

_accessibleActive

Implementation of

Inherited from

Defined in

_accessibleDiv

Implementation of

Inherited from

Defined in

_bounds

Implementation of

Inherited from

Defined in

_boundsID

Implementation of

Inherited from

Defined in

_boundsRect

Implementation of

Inherited from

Defined in

_destroyed

Implementation of

Inherited from

Defined in

_enabledFilters

Implementation of

Inherited from

Defined in

_height

Inherited from

Defined in

_lastSortedIndex

Implementation of

Inherited from

Defined in

_localBounds

Implementation of

Inherited from

Defined in

_localBoundsRect

Implementation of

Inherited from

Defined in

_mask

Implementation of

Inherited from

Defined in

_offsetX

Defined in

_offsetY

Defined in

_shiftX

Defined in

_shiftY

Defined in

_tempDisplayObjectParent

Implementation of

Inherited from

Defined in

_width

Inherited from

Defined in

_zIndex

Implementation of

Inherited from

Defined in