class ClippingAttachment

package spine.attachments

extends VertexAttachment › Attachment

@:directlyUsed

Available with spine plugin

An attachment with vertices that make up a polygon used for clipping the rendering of other attachments.

Constructor

new(name:String)

Variables

endSlot:SlotData

@:value(new Color(0.2275, 0.2275, 0.8078, 1))color:Color = new Color(0.2275, 0.2275, 0.8078, 1)

Methods

getEndSlot():SlotData

Clipping is performed between the clipping attachment's slot and the end slot. If null clipping is done until the end of the skeleton's rendering.

setEndSlot(endSlot:SlotData):Void

getColor():Color

The color of the clipping attachment as it was in Spine, or a default color if nonessential data was not exported. Clipping attachments are not usually rendered at runtime.

Inherited Variables

Defined by VertexAttachment

Defined by Attachment

Inherited Methods

Defined by VertexAttachment

computeWorldVertices(slot:Slot, start:Int, count:Int, worldVertices:FloatArray, offset:Int, stride:Int):Void

Transforms the attachment's local {@link #getVertices()} to world coordinates. If the slot's {@link Slot#getDeform()} is not empty, it is used to deform the vertices.

See World transforms in the Spine Runtimes Guide. @link #getVertices()} value to transform. Each vertex has 2 values, x and y. @link #getWorldVerticesLength()} - start.

Parameters:

start

The index of the first {

count

The number of world vertex values to output. Must be <= {

worldVertices

The output world vertices. Must have a length >= offset + count * stride / 2.

offset

The worldVertices index to begin writing values.

stride

The number of worldVertices entries between the value pairs written.

getDeformAttachment():VertexAttachment

Deform keys for the deform attachment are also applied to this attachment.

Returns:

May be null if no deform keys should be applied.

setDeformAttachment(deformAttachment:VertexAttachment):Void

Parameters:

deformAttachment

May be null if no deform keys should be applied.

getBones():IntArray

The bones which affect the {@link #getVertices()}. The array entries are, for each vertex, the number of bones affecting the vertex followed by that many bone indices, which is the index of the bone in {@link Skeleton#getBones()}. Will be null if this attachment has no weights.

setBones(bones:IntArray):Void

Parameters:

bones

May be null if this attachment has no weights.

getVertices():FloatArray

The vertex positions in the bone's coordinate system. For a non-weighted attachment, the values are x,y entries for each vertex. For a weighted attachment, the values are x,y,weight entries for each bone affecting each vertex.

setVertices(vertices:FloatArray):Void

getWorldVerticesLength():Int

The maximum number of world vertex values that can be output by {@link #computeWorldVertices(Slot, int, int, float[], int, int)} using the count parameter.

setWorldVerticesLength(worldVerticesLength:Int):Void

getId():Int

Returns a unique ID for this attachment.

copyTo(attachment:VertexAttachment):Void

Does not copy id (generated) or name (set on construction).

Defined by Attachment

getName():String

The attachment's name.

toString():String