Winter Cardinal UI - v0.442.0 / DDynamicText
Mesh
↳ DDynamicText
• new DDynamicText(style
): DDynamicText
Name | Type |
---|---|
style |
DDynamicTextStyle |
Mesh.constructor
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:44
• _accessibleActive: boolean
Member
Memberof
PIXI.DisplayObject#
Todo
Needs docs.
Mesh._accessibleActive
node_modules/pixi.js/pixi.js.d.ts:13747
• _accessibleDiv: boolean
Member
Memberof
PIXI.DisplayObject#
Todo
Needs docs.
Mesh._accessibleDiv
node_modules/pixi.js/pixi.js.d.ts:13753
• Protected
_atlas: null
| DynamicFontAtlas
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:36
• Protected
_atlasRevisionUpdated: number
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:37
• _bounds: Bounds
The bounds object, this is used to calculate and store the bounds of the displayObject.
Member
PIXI.DisplayObject#_bounds
Mesh._bounds
node_modules/pixi.js/pixi.js.d.ts:13869
• Protected
_boundsID: number
Flags the cached bounds as dirty.
Member
PIXI.DisplayObject#_boundsID
Mesh._boundsID
node_modules/pixi.js/pixi.js.d.ts:13882
• Protected
_boundsRect: Bounds
Cache of this display-object’s bounds-rectangle.
Member
PIXI.DisplayObject#_boundsRect
Mesh._boundsRect
node_modules/pixi.js/pixi.js.d.ts:13889
• Protected
_destroyed: boolean
If the object has been destroyed via destroy(). If true, it should not be used.
Member
PIXI.DisplayObject#_destroyed
Mesh._destroyed
node_modules/pixi.js/pixi.js.d.ts:13910
• Protected
_enabledFilters: Filter
[]
Currently enabled filters
Member
PIXI.DisplayObject#_enabledFilters
Mesh._enabledFilters
node_modules/pixi.js/pixi.js.d.ts:13863
• Protected
_height: number
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:39
• Protected
_isDirty: boolean
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:34
• Protected
_isGeometryDirty: boolean
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:35
• 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
Mesh._lastSortedIndex
node_modules/pixi.js/pixi.js.d.ts:13832
• _localBounds: Bounds
Local bounds object, swapped with _bounds
when using getLocalBounds()
.
Member
PIXI.DisplayObject#_localBounds
Mesh._localBounds
node_modules/pixi.js/pixi.js.d.ts:13875
• Protected
_localBoundsRect: Bounds
Cache of this display-object’s local-bounds rectangle.
Member
PIXI.DisplayObject#_localBoundsRect
Mesh._localBoundsRect
node_modules/pixi.js/pixi.js.d.ts:13896
• Protected
_mask: null
| Container
| MaskData
The original, cached mask of the object.
Member
PIXI.DisplayObject#_mask
Mesh._mask
node_modules/pixi.js/pixi.js.d.ts:13903
• Protected
_modifier: DDynamicTextModifier
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:40
• Protected
_style: DDynamicTextStyle
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:31
• Protected
_tempDisplayObjectParent: Container
Member
Mesh._tempDisplayObjectParent
node_modules/pixi.js/pixi.js.d.ts:13983
• Protected
_text: string
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:32
• Protected
_textApproved: string
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:33
• Protected
_width: number
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:38
• 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
Mesh._zIndex
node_modules/pixi.js/pixi.js.d.ts:13840
• accessible: boolean
Flag for if the object is accessible. If true AccessibilityManager will overlay a shadow div with attributes set
Member
Memberof
PIXI.DisplayObject#
Mesh.accessible
node_modules/pixi.js/pixi.js.d.ts:13726
• accessibleChildren: boolean
Setting to false will prevent any children inside this container to be accessible. Defaults to true.
Member
Memberof
PIXI.DisplayObject#
Default
true
Mesh.accessibleChildren
node_modules/pixi.js/pixi.js.d.ts:13780
• accessibleHint: string
Sets the aria-label attribute of the shadow div
Member
Memberof
PIXI.DisplayObject#
Mesh.accessibleHint
node_modules/pixi.js/pixi.js.d.ts:13741
• accessiblePointerEvents: string
Specify the pointer-events the accessible div will use Defaults to auto.
Member
Memberof
PIXI.DisplayObject#
Default
'auto'
Mesh.accessiblePointerEvents
node_modules/pixi.js/pixi.js.d.ts:13771
• 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#
Mesh.accessibleTitle
node_modules/pixi.js/pixi.js.d.ts:13734
• 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'
Mesh.accessibleType
node_modules/pixi.js/pixi.js.d.ts:13762
• alpha: number
The opacity of the object.
Member
PIXI.DisplayObject#alpha
Mesh.alpha
node_modules/pixi.js/pixi.js.d.ts:13793
• 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
Mesh.angle
node_modules/pixi.js/pixi.js.d.ts:14070
• 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
Mesh.blendMode
node_modules/pixi.js/pixi.js.d.ts:13457
• 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#
Mesh.buttonMode
node_modules/pixi.js/pixi.js.d.ts:14152
• 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#
Mesh.cacheAsBitmap
node_modules/pixi.js/pixi.js.d.ts:14179
• Readonly
children: DisplayObject
[]
The array of children of this container.
Member
PIXI.Container#children
Mesh.children
node_modules/pixi.js/pixi.js.d.ts:13547
• 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#
Mesh.cursor
node_modules/pixi.js/pixi.js.d.ts:14166
• 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
Mesh.drawMode
node_modules/pixi.js/pixi.js.d.ts:13418
• 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
Mesh.filterArea
node_modules/pixi.js/pixi.js.d.ts:13849
• filters: Filter
[]
Sets the filters for the displayObject.
'null'
.Member
PIXI.DisplayObject#filters
Mesh.filters
node_modules/pixi.js/pixi.js.d.ts:13857
• Readonly
geometry: DDynamicTextGeometry
Mesh.geometry
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:42
• 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#
Mesh.hitArea
node_modules/pixi.js/pixi.js.d.ts:14140
• 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#
Mesh.interactive
node_modules/pixi.js/pixi.js.d.ts:14128
• 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#
Mesh.interactiveChildren
node_modules/pixi.js/pixi.js.d.ts:13706
• isMask: boolean
Does any other displayObject use this object as a mask?
Member
PIXI.DisplayObject#isMask
Mesh.isMask
node_modules/pixi.js/pixi.js.d.ts:13920
• isSprite: boolean
used to fast check if a sprite is.. a sprite!
Member
PIXI.DisplayObject#isSprite
Mesh.isSprite
node_modules/pixi.js/pixi.js.d.ts:13915
• Readonly
localTransform: Matrix
Current transform of the object based on local factors: position, scale, other stuff.
Member
Mesh.localTransform
node_modules/pixi.js/pixi.js.d.ts:14028
• 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
Mesh.mask
node_modules/pixi.js/pixi.js.d.ts:14106
• material: MeshMaterial
Alias for PIXI.Mesh#shader.
Member
Mesh.material
node_modules/pixi.js/pixi.js.d.ts:13448
• name: string
The instance name of the object.
Memberof
PIXI.DisplayObject#
Member
name
Mesh.name
node_modules/pixi.js/pixi.js.d.ts:14186
• parent: Container
The display object container that contains this display object.
Member
PIXI.DisplayObject#parent
Mesh.parent
node_modules/pixi.js/pixi.js.d.ts:13817
• pivot: ObservablePoint
The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.
Member
Mesh.pivot
node_modules/pixi.js/pixi.js.d.ts:14049
• position: ObservablePoint
The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.
Member
Mesh.position
node_modules/pixi.js/pixi.js.d.ts:14035
• 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
Mesh.renderable
node_modules/pixi.js/pixi.js.d.ts:13811
• 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
Mesh.rotation
node_modules/pixi.js/pixi.js.d.ts:14063
• 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
Mesh.roundPixels
node_modules/pixi.js/pixi.js.d.ts:13467
• scale: ObservablePoint
The scale factor of the object. Assignment by value since pixi-v4.
Member
Mesh.scale
node_modules/pixi.js/pixi.js.d.ts:14042
• 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
Mesh.shader
node_modules/pixi.js/pixi.js.d.ts:13405
• size: number
How much of the geometry to draw, by default 0
renders everything.
Member
PIXI.Mesh#size
Default
0
Mesh.size
node_modules/pixi.js/pixi.js.d.ts:13430
• skew: ObservablePoint
The skew factor for the object in radians. Assignment by value since pixi-v4.
Member
Mesh.skew
node_modules/pixi.js/pixi.js.d.ts:14056
• 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
Mesh.sortDirty
node_modules/pixi.js/pixi.js.d.ts:13570
• 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
Mesh.sortableChildren
node_modules/pixi.js/pixi.js.d.ts:13563
• start: number
Typically the index of the IndexBuffer where to start drawing.
Member
PIXI.Mesh#start
Default
0
Mesh.start
node_modules/pixi.js/pixi.js.d.ts:13424
• 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
Mesh.state
node_modules/pixi.js/pixi.js.d.ts:13411
• texture: Texture
The texture that the Mesh uses.
Member
Mesh.texture
node_modules/pixi.js/pixi.js.d.ts:13481
• 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
Mesh.tint
node_modules/pixi.js/pixi.js.d.ts:13475
• 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
Mesh.transform
node_modules/pixi.js/pixi.js.d.ts:13787
• Readonly
uvBuffer: Buffer
To change mesh uv’s, change its uvBuffer data and increment its _updateID.
Member
Mesh.uvBuffer
node_modules/pixi.js/pixi.js.d.ts:13436
• 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
Mesh.verticesBuffer
node_modules/pixi.js/pixi.js.d.ts:13443
• 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
Mesh.visible
node_modules/pixi.js/pixi.js.d.ts:13802
• Readonly
worldAlpha: number
The multiplied alpha of the displayObject.
Member
PIXI.DisplayObject#worldAlpha
Mesh.worldAlpha
node_modules/pixi.js/pixi.js.d.ts:13824
• Readonly
worldTransform: Matrix
Current transform of the object based on world (parent) factors.
Member
Mesh.worldTransform
node_modules/pixi.js/pixi.js.d.ts:14021
• Readonly
worldVisible: boolean
Indicates if the object is globally visible.
Member
Mesh.worldVisible
node_modules/pixi.js/pixi.js.d.ts:14086
• 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
Mesh.x
node_modules/pixi.js/pixi.js.d.ts:14007
• 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
Mesh.y
node_modules/pixi.js/pixi.js.d.ts:14014
• 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
Mesh.zIndex
node_modules/pixi.js/pixi.js.d.ts:14079
▪ 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
Mesh.BATCHABLE_SIZE
node_modules/pixi.js/pixi.js.d.ts:13540
• get
clipped(): boolean
boolean
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:151
• get
height(): number
number
Mesh.height
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:137
• set
height(height
): void
Name | Type |
---|---|
height |
number |
void
Mesh.height
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:142
• get
style(): DDynamicTextStyle
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:155
• get
text(): string
string
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:106
• set
text(text
): void
Name | Type |
---|---|
text |
string |
void
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:110
• get
width(): number
number
Mesh.width
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:122
• set
width(width
): void
Name | Type |
---|---|
width |
number |
void
Mesh.width
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:127
▸ _calculateBounds(): void
void
Mesh._calculateBounds
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:265
▸ _recursivePostUpdateTransform(): void
Recursively updates transform of all objects from the root to this one internal function for toLocal()
void
Mesh._recursivePostUpdateTransform
node_modules/pixi.js/pixi.js.d.ts:13925
▸ _render(renderer?
): void
Name | Type |
---|---|
renderer? |
Renderer |
void
Mesh._render
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:271
▸ _renderDefault(renderer
): void
Standard non-batching way of rendering.
Name | Type | Description |
---|---|---|
renderer |
Renderer |
Instance to renderer. |
void
Mesh._renderDefault
node_modules/pixi.js/pixi.js.d.ts:13493
▸ _renderToBatch(renderer
): void
Rendering by using the Batch system.
Name | Type | Description |
---|---|---|
renderer |
Renderer |
Instance to renderer. |
void
Mesh._renderToBatch
node_modules/pixi.js/pixi.js.d.ts:13499
▸ 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)
Name | Type |
---|---|
TChildren |
extends DisplayObject [] |
Name | Type | Description |
---|---|---|
...children |
TChildren |
The DisplayObject(s) to add to the container |
TChildren
[0
]
The first child that was added.
Mesh.addChild
node_modules/pixi.js/pixi.js.d.ts:13585
▸ 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
Name | Type |
---|---|
T |
extends DisplayObject |
Name | Type | Description |
---|---|---|
child |
T |
The child to add |
index |
number |
The index to place the child in |
T
The child that was added.
Mesh.addChildAt
node_modules/pixi.js/pixi.js.d.ts:13593
▸ addListener(event
, fn
, context?
): this
Name | Type |
---|---|
event |
InteractionEventTypes |
fn |
(event : InteractionEvent ) => void |
context? |
any |
this
Mesh.addListener
node_modules/pixi.js/pixi.js.d.ts:25521
▸ addListener(event
, fn
, context?
): this
Name | Type |
---|---|
event |
string | symbol |
fn |
Function |
context? |
any |
this
Mesh.addListener
node_modules/pixi.js/pixi.js.d.ts:25523
▸ calculateBounds(): void
Recalculates the bounds of the container.
void
Mesh.calculateBounds
node_modules/pixi.js/pixi.js.d.ts:13656
▸ calculateUvs(): void
Updates uv field based on from geometry uv’s or batchUvs
void
Mesh.calculateUvs
node_modules/pixi.js/pixi.js.d.ts:13507
▸ calculateVertices(): void
Updates vertexData field based on transform and vertices
void
Mesh.calculateVertices
node_modules/pixi.js/pixi.js.d.ts:13503
▸ containerUpdateTransform(): void
Container default updateTransform, does update children of container. Will crash if there’s no parent element.
void
Memberof
PIXI.Container#
Function
containerUpdateTransform
Mesh.containerUpdateTransform
node_modules/pixi.js/pixi.js.d.ts:13698
▸ containsPoint(point
): boolean
Tests if a point is inside this mesh. Works only for PIXI.DRAW_MODES.TRIANGLES.
Name | Type | Description |
---|---|---|
point |
IPointData |
the point to test |
boolean
the result of the test
Mesh.containsPoint
node_modules/pixi.js/pixi.js.d.ts:13521
▸ destroy(options?
): void
Destroys the Mesh object.
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. |
void
Mesh.destroy
node_modules/pixi.js/pixi.js.d.ts:13530
▸ disableTempParent(cacheParent
): void
Pair method for enableTempParent
Name | Type | Description |
---|---|---|
cacheParent |
DisplayObject |
actual parent of element |
void
Mesh.disableTempParent
node_modules/pixi.js/pixi.js.d.ts:14000
▸ displayObjectUpdateTransform(): void
DisplayObject default updateTransform, does not update children of container. Will crash if there’s no parent element.
void
Memberof
PIXI.DisplayObject#
Function
displayObjectUpdateTransform
Mesh.displayObjectUpdateTransform
node_modules/pixi.js/pixi.js.d.ts:14114
▸ emit(event
, ...args
): boolean
Calls each of the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
...args |
any [] |
Arguments that are passed to registered listeners |
boolean
true
if the event had listeners, else false
.
Mesh.emit
node_modules/pixi.js/pixi.js.d.ts:25441
▸ 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);
DisplayObject
current parent
Mesh.enableTempParent
node_modules/pixi.js/pixi.js.d.ts:13995
▸ eventNames(): (string
| symbol
)[]
Return an array listing the events for which the emitter has registered listeners.
(string
| symbol
)[]
Mesh.eventNames
node_modules/pixi.js/pixi.js.d.ts:25415
▸ getBounds(skipUpdate?
, rect?
): Rectangle
Retrieves the bounds of the displayObject as a rectangle object.
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. |
Rectangle
The rectangular bounding area.
Mesh.getBounds
node_modules/pixi.js/pixi.js.d.ts:13935
▸ getChildAt(index
): DisplayObject
Returns the child at the specified index
Name | Type | Description |
---|---|---|
index |
number |
The index to get the child at |
DisplayObject
The child at the given index, if any.
Mesh.getChildAt
node_modules/pixi.js/pixi.js.d.ts:13621
▸ getChildByName(name
, deep?
): DisplayObject
Returns the display object in the container.
Recursive searches are done in a preorder traversal.
Name | Type | Description |
---|---|---|
name |
string |
Instance name. |
deep? |
boolean |
Whether to search recursively |
DisplayObject
The child with the specified name.
Method
getChildByName
Memberof
PIXI.Container#
Mesh.getChildByName
node_modules/pixi.js/pixi.js.d.ts:13718
▸ getChildIndex(child
): number
Returns the index position of a child DisplayObject instance
Name | Type | Description |
---|---|---|
child |
DisplayObject |
The DisplayObject instance to identify |
number
The index position of the child display object to identify
Mesh.getChildIndex
node_modules/pixi.js/pixi.js.d.ts:13607
▸ getGlobalPosition(point?
, skipUpdate?
): Point
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
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. |
Point
The updated point.
Method
getGlobalPosition
Memberof
PIXI.DisplayObject#
Mesh.getGlobalPosition
node_modules/pixi.js/pixi.js.d.ts:14198
▸ getLocalBounds(rect?
, skipChildrenUpdate?
): Rectangle
Retrieves the local bounds of the displayObject as a rectangle object.
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. |
Rectangle
The rectangular bounding area.
Mesh.getLocalBounds
node_modules/pixi.js/pixi.js.d.ts:13665
▸ listenerCount(event
): number
Return the number of listeners listening to a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
number
Mesh.listenerCount
node_modules/pixi.js/pixi.js.d.ts:25432
▸ listeners(event
): Function
[]
Return the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
Function
[]
Mesh.listeners
node_modules/pixi.js/pixi.js.d.ts:25424
▸ off(event
, fn?
, context?
): this
Name | Type |
---|---|
event |
string |
fn? |
Function |
context? |
any |
this
Mesh.off
node_modules/pixi.js/pixi.js.d.ts:25534
▸ on(event
, fn
, context?
): this
Name | Type |
---|---|
event |
"removed" | "added" |
fn |
(displayObject : DisplayObject ) => void |
context? |
any |
this
Mesh.on
node_modules/pixi.js/pixi.js.d.ts:25530
▸ on(event
, fn
, context?
): this
Name | Type |
---|---|
event |
string |
fn |
Function |
context? |
any |
this
Mesh.on
node_modules/pixi.js/pixi.js.d.ts:25532
▸ onChildrenChange(): void
Overridable method that can be used by Container subclasses whenever the children array is modified
void
Mesh.onChildrenChange
node_modules/pixi.js/pixi.js.d.ts:13576
▸ onStyleChange(): void
void
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:73
▸ once(event
, fn
, context?
): this
Name | Type |
---|---|
event |
"removed" | "added" |
fn |
(displayObject : DisplayObject ) => void |
context? |
any |
this
Mesh.once
node_modules/pixi.js/pixi.js.d.ts:25527
▸ once(event
, fn
, context?
): this
Name | Type |
---|---|
event |
string |
fn |
Function |
context? |
any |
this
Mesh.once
node_modules/pixi.js/pixi.js.d.ts:25529
▸ removeAllListeners(event?
): this
Name | Type |
---|---|
event? |
InteractionEventTypes |
this
Mesh.removeAllListeners
node_modules/pixi.js/pixi.js.d.ts:25516
▸ removeAllListeners(event?
): this
Name | Type |
---|---|
event? |
string | symbol |
this
Mesh.removeAllListeners
node_modules/pixi.js/pixi.js.d.ts:25517
▸ removeChild<TChildren
>(...children
): TChildren
[0
]
Removes one or more children from the container.
Name | Type |
---|---|
TChildren |
extends DisplayObject [] |
Name | Type | Description |
---|---|---|
...children |
TChildren |
The DisplayObject(s) to remove |
TChildren
[0
]
The first child that was removed.
Mesh.removeChild
node_modules/pixi.js/pixi.js.d.ts:13628
▸ removeChildAt(index
): DisplayObject
Removes a child from the specified index position.
Name | Type | Description |
---|---|---|
index |
number |
The index to get the child from |
DisplayObject
The child that was removed.
Mesh.removeChildAt
node_modules/pixi.js/pixi.js.d.ts:13635
▸ removeChildren(beginIndex?
, endIndex?
): DisplayObject
[]
Removes all children from this container that are within the begin and end indexes.
Name | Type | Description |
---|---|---|
beginIndex? |
number |
The beginning position. |
endIndex? |
number |
The ending position. Default value is size of the container. |
DisplayObject
[]
List of removed children
Mesh.removeChildren
node_modules/pixi.js/pixi.js.d.ts:13643
▸ removeListener(event
, fn?
, context?
): this
Name | Type |
---|---|
event |
InteractionEventTypes |
fn? |
(event : InteractionEvent ) => void |
context? |
any |
this
Mesh.removeListener
node_modules/pixi.js/pixi.js.d.ts:25513
▸ removeListener(event
, fn?
, context?
): this
Name | Type |
---|---|
event |
string | symbol |
fn? |
Function |
context? |
any |
this
Mesh.removeListener
node_modules/pixi.js/pixi.js.d.ts:25515
▸ render(renderer
): void
Renders the object using the WebGL renderer
Name | Type | Description |
---|---|---|
renderer |
Renderer |
The renderer |
void
Mesh.render
node_modules/pixi.js/pixi.js.d.ts:13671
▸ renderAdvanced(renderer
): void
Render the object using the WebGL renderer and advanced features.
Name | Type | Description |
---|---|---|
renderer |
Renderer |
The renderer |
void
Mesh.renderAdvanced
node_modules/pixi.js/pixi.js.d.ts:13678
▸ setChildIndex(child
, index
): void
Changes the position of an existing child in the display object container
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 |
void
Mesh.setChildIndex
node_modules/pixi.js/pixi.js.d.ts:13614
▸ setClippingDelta(width
, height
): void
Name | Type |
---|---|
width |
number |
height |
number |
void
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:259
▸ setParent(container
): Container
Set the parent Container of this DisplayObject.
Name | Type | Description |
---|---|---|
container |
Container |
The Container to add this DisplayObject to. |
Container
The Container that this DisplayObject was added to.
Mesh.setParent
node_modules/pixi.js/pixi.js.d.ts:13963
▸ setTransform(x?
, y?
, scaleX?
, scaleY?
, rotation?
, skewX?
, skewY?
, pivotX?
, pivotY?
): DisplayObject
Convenience function to set the position, scale, skew and pivot at once.
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 |
DisplayObject
The DisplayObject instance
Mesh.setTransform
node_modules/pixi.js/pixi.js.d.ts:13978
▸ sortChildren(): void
Sorts children by zIndex. Previous order is mantained for 2 children with the same zIndex.
void
Mesh.sortChildren
node_modules/pixi.js/pixi.js.d.ts:13647
▸ swapChildren(child
, child2
): void
Swaps the position of 2 Display Objects within this container.
Name | Type | Description |
---|---|---|
child |
DisplayObject |
First display object to swap |
child2 |
DisplayObject |
Second display object to swap |
void
Mesh.swapChildren
node_modules/pixi.js/pixi.js.d.ts:13600
▸ toGlobal(position
, point?
, skipUpdate?
): Point
Calculates the global position of the display object.
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. |
Point
A point object representing the position of this object.
Mesh.toGlobal
node_modules/pixi.js/pixi.js.d.ts:13945
▸ toLocal(position
, from?
, point?
, skipUpdate?
): Point
Calculates the local position of the display object relative to another point.
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 |
Point
A point object representing the position of this object
Mesh.toLocal
node_modules/pixi.js/pixi.js.d.ts:13956
▸ update(): void
void
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:159
▸ updateClipping(style
, modifier
): boolean
Name | Type |
---|---|
style |
DDynamicTextStyle |
modifier |
DDynamicTextModifier |
boolean
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:209
▸ updateTransform(): void
Updates the transform on all children of this container for rendering
void
Mesh.updateTransform
node_modules/pixi.js/pixi.js.d.ts:13651
▸ update_(): void
void
src/main/typescript/wcardinal/ui/d-dynamic-text.ts:80
▸ mixin(source
): void
Mixes all enumerable properties and methods from a source object to DisplayObject.
Name | Type | Description |
---|---|---|
source |
any |
The source of properties and methods to mix in. |
void
Mesh.mixin
node_modules/pixi.js/pixi.js.d.ts:9230