Class SVGSkin

Hierarchy (View Summary)

Skin
- SVGSkin

Constructors

constructor

new SVGSkin(): SVGSkin
Returns SVGSkin
Inherited from Skin.constructor

Properties

_canvas

_canvas: HTMLCanvasElement

_context

_context: CanvasRenderingContext2D

_id

_id: number

_largestMIPScale

_largestMIPScale: number

_maxTextureScale

_maxTextureScale: number

_renderer

_renderer: RenderWebGL

_rotationCenter

_rotationCenter: V3

_scaledMIPs

_scaledMIPs: WebGLTexture[]

_silhouette

_silhouette: Silhouette

_size

_size: [number, number]

_svgImage

_svgImage: HTMLImageElement

_svgImageLoaded

_svgImageLoaded: boolean

_texture

_texture: WebGLTexture | null

_uniforms

_uniforms: { u_skin: WebGLTexture | null; u_skinSize: [number, number] }

Accessors

id

get id(): number
Returns number
Inherited from Skin.id
- Defined in scratch-render.d.ts:121

rotationCenter

get rotationCenter(): V3
Returns V3
Inherited from Skin.rotationCenter
- Defined in scratch-render.d.ts:126

size

get size(): [number, number]
Returns [number, number]
Inherited from Skin.size
- Defined in scratch-render.d.ts:123

Methods

_setTexture

_setTexture(image: BitmapData): void
Parameters
- image: BitmapData
Returns void
Inherited from Skin._setTexture
- Defined in scratch-render.d.ts:158

addListener

addListener<K extends "WasAltered">(
event: K,
callback: EventEmitterCallback<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- callback: EventEmitterCallback<SkinEventMap, K>
Returns void
Inherited from Skin.addListener
- Defined in events.d.ts:9

calculateRotationCenter

calculateRotationCenter(): [number, number]
Always returns the middle of the skin (size / 2). No relation to Skin._rotationCenter or Skin.rotationCenter.

Returns [number, number]
Inherited from Skin.calculateRotationCenter
- Defined in scratch-render.d.ts:132

createMIP

createMIP(scale: number): WebGLTexture
Parameters
- scale: number
Returns WebGLTexture
- Defined in scratch-render.d.ts:199

dispose

dispose(): void
Returns void
Inherited from Skin.dispose
- Defined in scratch-render.d.ts:167

emit

emit<K extends "WasAltered">(
event: K,
...args: EventEmitterArgs<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- ...args: EventEmitterArgs<SkinEventMap, K>
Returns void
Inherited from Skin.emit
- Defined in events.d.ts:14

getFenceBounds

getFenceBounds(
drawable: Drawable,
result?: RenderWebGL.Rectangle,
): RenderWebGL.Rectangle
Get the bounds of the drawable for determining its fenced position. For compatibility with Scratch 2, we always use getAABB.
Parameters
- drawable: Drawable
- Optionalresult: RenderWebGL.Rectangle
Returns RenderWebGL.Rectangle
Inherited from Skin.getFenceBounds
- Defined in scratch-render.d.ts:165

getTexture

getTexture(scale?: [number, number]): WebGLTexture
Parameters
- Optionalscale: [number, number]
Returns WebGLTexture
Inherited from Skin.getTexture
- Defined in scratch-render.d.ts:157

getUniforms

getUniforms(
scale?: [number, number],
): { u_skin: WebGLTexture | null; u_skinSize: [number, number] }
Parameters
- Optionalscale: [number, number]
Returns { u_skin: WebGLTexture | null; u_skinSize: [number, number] }
Inherited from Skin.getUniforms
- Defined in scratch-render.d.ts:140

isTouchingLinear

isTouchingLinear(textureCoordinate: V3): boolean
Parameters
- textureCoordinate: V3
Returns boolean
See
Inherited from Skin.isTouchingLinear
- Defined in scratch-render.d.ts:153

isTouchingNearest

isTouchingNearest(textureCoordinate: V3): boolean
Parameters
- textureCoordinate: V3
Returns boolean
See
Inherited from Skin.isTouchingNearest
- Defined in scratch-render.d.ts:148

listeners

listeners<K extends "WasAltered">(
event: K,
): EventEmitterCallback<SkinEventMap, K>[]
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
Returns EventEmitterCallback<SkinEventMap, K>[]
Inherited from Skin.listeners
- Defined in events.d.ts:13

off

off<K extends "WasAltered">(
event: K,
callback: EventEmitterCallback<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- callback: EventEmitterCallback<SkinEventMap, K>
Returns void
Inherited from Skin.off
- Defined in events.d.ts:11

on

on<K extends "WasAltered">(
event: K,
callback: EventEmitterCallback<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- callback: EventEmitterCallback<SkinEventMap, K>
Returns void
Inherited from Skin.on
- Defined in events.d.ts:8

once

once<K extends "WasAltered">(
event: K,
callback: EventEmitterCallback<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- callback: EventEmitterCallback<SkinEventMap, K>
Returns void
Inherited from Skin.once
- Defined in events.d.ts:10

removeListener

removeListener<K extends "WasAltered">(
event: K,
callback: EventEmitterCallback<SkinEventMap, K>,
): void
Type Parameters
- K extends "WasAltered"
Parameters
- event: K
- callback: EventEmitterCallback<SkinEventMap, K>
Returns void
Inherited from Skin.removeListener
- Defined in events.d.ts:12

resetMIPs

resetMIPs(): void
Returns void
- Defined in scratch-render.d.ts:200

setEmptyImageData

setEmptyImageData(): void
Returns void
Inherited from Skin.setEmptyImageData
- Defined in scratch-render.d.ts:159

setSVG

setSVG(svgData: string, rotationCenter?: [number, number]): void
Asynchronously update the content of the skin. May take a couple frames for changes to appear.
Parameters
- svgData: string
  SVG source code
- OptionalrotationCenter: [number, number]
  Defaults to the center of the image.
Returns void
- Defined in scratch-render.d.ts:207

updateSilhouette

updateSilhouette(): void
Returns void
Inherited from Skin.updateSilhouette
- Defined in scratch-render.d.ts:143

useNearest

useNearest(scale: [number, number], drawable: Drawable): boolean
Parameters
- scale: [number, number]
- drawable: Drawable
Returns boolean
Inherited from Skin.useNearest
- Defined in scratch-render.d.ts:155