Construct a DoorMesh by providing PrimarySpriteMesh constructor options and specific door configuration.
Internal_The currently rendered position of the door.
Internal_The original position of the door in its resting CLOSED state.
Internal_The transform ID.
Internal_The transform ID.
The indices of the geometry.
The texture alpha threshold used for point containment tests. If set to a value larger than 0, the texture alpha data is extracted from the texture at 25% resolution.
An amount of pixel padding surrounding the door texture.
Protected_The anchor point defines the normalized coordinates in the texture that map to the position of this sprite.
By default, this is (0,0) (or texture.defaultAnchor
if you have modified that), which means the position
(x,y) of this Sprite will be the top-left corner.
Note: Updating texture.defaultAnchor after
constructing a Sprite does not update its anchor.
https://docs.cocos2d-x.org/cocos2d-x/en/sprites/manipulation.html
Protected_Snapshot of some parameters of this display object to render in batched mode.
Protected_Cached tint value so we can tell when the tint is changed.
Protected_The height of the sprite (this is initially set by the texture)
Protected_Protected_Protected_The shader bound to this mesh.
Protected_The texture that the sprite is using.
Protected_The texture alpha data.
Protected_The texture ID.
Protected_The texture trimmed ID.
Protected_An instance of a texture uvs used for padded SpriteMesh. Instanced only when padding becomes non-zero.
Protected_Used to track a tint or alpha change to execute a recomputation of _cachedTint.
Protected_The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.
Protected_The tint applied to the sprite. This is a RGB value. A value of 0xFFFFFF will remove any tint effect.
Protected_The width of the sprite (this is initially set by the texture).
Protected#renderedLast renderer pass in which this mesh actually drew its own content.
ProtecteduvsThis is used to store the uvs data of the sprite, assigned at the same time as the vertexData in calculateVertices().
ProtectedvertexThis is used to store the vertex data of the sprite (basically a quad).
ProtectedvertexThis is used to calculate the bounds of the object IF it is a trimmed sprite.
StaticDOOR_The possible rendering styles for a door mesh.
Used to force an alpha mode on this sprite mesh. If this property is non null, this value will replace the texture alphaMode when computing color channels. Affects how tint, worldAlpha and alpha are computed each others.
The anchor sets the origin point of the sprite. The default value is taken from the texture and passed to the constructor.
The default is (0,0), this means the sprite's origin is the top left.
Setting the anchor to (0.5,0.5) means the sprite's origin is centered.
Setting the anchor to (1,1) would mean the sprite's origin point will be the bottom right corner.
If you pass only single parameter, it will set both x and y to the same value as shown in the example below.
The identifier for this door animation.
True if the mesh was culld (visited but not drawn) during the current pass.
The height of the Container, setting this will actually modify the scale to achieve the value set.
Is this SpriteMesh rendering a video texture?
The maximum x/y padding in pixels (must be a non-negative value.)
The x padding in pixels (must be a non-negative value.)
They y padding in pixels (must be a non-negative value.)
Returns the SpriteMesh associated batch plugin. By default the returned plugin is that of the associated shader. If a plugin is forced, it will returns the forced plugin. A null value means that this SpriteMesh has no associated plugin.
True if this mesh drew its own content during the current renderer pass.
If true PixiJS will Math.round() 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
The shader bound to this mesh.
The HTML source element for this SpriteMesh texture.
The texture that the sprite is using.
True if this mesh was visited by the renderer during the current pass.
The width of the Container, setting this will actually modify the scale to achieve the value set.
When the texture is updated, this event will fire to update the scale and frame.
InternalRender the sprite with ERASE blending. Note: The sprite must not have visible/renderable children.
The renderer
Update the batch data object.
Animate the door to its current rendered state.
Is the door now open or closed?
Calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData.
This is used to ensure that the true width and height of a trimmed texture is respected.
Calculates worldTransform * vertices, store it in vertexData.
Is the given point in canvas space contained in this object?
The point in canvas space
OptionaltextureAlphaThreshold: number = ...The minimum texture alpha required for containment
Is the given point in world space contained in this object?
The point in world space
OptionaltextureAlphaThreshold: number = ...The minimum texture alpha required for containment
Configure and initialize the DoorMesh. This is called automatically upon construction, but may be called manually later to update the DoorMesh.
An all-in-one helper method: Resizing the PCO according to desired dimensions and options. This helper computes the width and height based on the following factors:
Additionally, It takes into account the desired fit options:
You can also apply optional scaleX and scaleY options to both width and height. The scale is applied after fitting.
Important: By using this helper, you don't need to set the height, width, and scale properties of the DisplayObject.
Note: This is a helper method. Alternatively, you could assign properties as you would with a PIXI DisplayObject.
The base width used for computations.
The base height used for computations.
Optionaloptions: {The options.
Optionalfit?: "fill" | "width" | "height" | "cover" | "contain"The fit type.
OptionalscaleX?: numberThe scale on X axis.
OptionalscaleY?: numberThe scale on Y axis.
Initialize shader based on the shader class type.
The shader class
Update uvs and push vertices and uv buffers on GPU if necessary.
Protected_ProtectedCalled when the anchor position updates.
StaticanimateConfigure the "ascend" animation.
StaticanimateConfigure the "descend" animation.
StaticanimateConfigure the "slide" animation.
StaticanimateConfigure the "swing" animation.
StaticfromCreate a SpriteMesh from another source. You can specify texture options and a specific shader class derived from BaseSamplerShader.
Source to create texture from.
OptionaltextureOptions: objectSee PIXI.BaseTexture's constructor for options.
OptionalshaderClass: BaseSamplerShaderThe shader class to use. BaseSamplerShader by default.
StaticinitializeSpecial initialization needed for descending door types.
StaticpostWhen opening a descending door, shift its elevation to the background after animation.
StaticpreWhen closing a descending door, shift its elevation to the foreground before animation.
A special subclass of PrimarySpriteMesh used to render an interactive door.