Class ClipStyle<T>

Type Parameters

T extends Sprite = Sprite

Hierarchy (view full)

ClipStyle
- TextStyle

Constructors

constructor

new ClipStyle<T>(options): ClipStyle<T>
Type Parameters
- T extends Sprite = Sprite
Parameters
- options: ClipStyleOptions
Returns ClipStyle<T>
- Defined in src/modules/clip/ClipStyle.ts:60

Methods

destroy

destroy(): void
Returns void
- Defined in src/modules/clip/ClipStyle.ts:369

getAlpha

getAlpha(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:184

getAnimationPositionOffset

getAnimationPositionOffset(): [number, number]
Returns [number, number]
- Defined in src/modules/clip/ClipStyle.ts:236

getAnimationRotationOffset

getAnimationRotationOffset(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:210

getAnimationScaleMultiplier

getAnimationScaleMultiplier(): [number, number]
Returns [number, number]
- Defined in src/modules/clip/ClipStyle.ts:154

getCornerRadius

getCornerRadius(): number[]
Returns number[]
- Defined in src/modules/clip/ClipStyle.ts:128

getHeight

getHeight(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:162

getPosition

getPosition(): [number, number]
Returns [number, number]
- Defined in src/modules/clip/ClipStyle.ts:224

getRawHeight

getRawHeight(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:170

getRawWidth

getRawWidth(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:166

getRotation

getRotation(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:198

getScale

getScale(): [number, number]
Returns [number, number]
- Defined in src/modules/clip/ClipStyle.ts:142

getWidth

getWidth(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:158

getZIndex

getZIndex(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:250

load

load(sprite): void
Parameters
- sprite: T
Returns void
- Defined in src/modules/clip/ClipStyle.ts:254

serialize

serialize(): {
    alpha: number;
    clipId: string;
    cornerRadius?: [number, number, number, number];
    height?: number;
    mediaDataId?: string;
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    width?: number;
    zIndex: number;
}
Returns {
    alpha: number;
    clipId: string;
    cornerRadius?: [number, number, number, number];
    height?: number;
    mediaDataId?: string;
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    width?: number;
    zIndex: number;
}
- alpha: number
- clipId: string
- Optional cornerRadius?: [number, number, number, number]
- Optional height?: number
- Optional mediaDataId?: string
- position: [number, number]
- relativeCornerRadius: boolean
- rotation: number
- scale: [number, number]
- Optional width?: number
- zIndex: number
- Defined in src/modules/clip/ClipStyle.ts:376

setAlpha

setAlpha(alpha): void
Parameters
- alpha: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:174

setAnimationPositionOffset

setAnimationPositionOffset(x, y): void
Parameters
- x: number
- y: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:228

setAnimationRotationOffset

setAnimationRotationOffset(rotation): void
Parameters
- rotation: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:202

setAnimationScaleMultiplier

setAnimationScaleMultiplier(multiplierX, multiplierY): void
Parameters
- multiplierX: number
- multiplierY: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:146

setCornerRadius

setCornerRadius(radii, relative?): void
Parameters
- radii: number | [number, number, number, number]
- relative: boolean = false
Returns void
- Defined in src/modules/clip/ClipStyle.ts:117

setPosition

setPosition(x, y): void
Parameters
- x: number
- y: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:214

setRotation

setRotation(rotation): void
Parameters
- rotation: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:188

setScale

setScale(scaleX, scaleY): void
Parameters
- scaleX: number
- scaleY: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:132

setZIndex

setZIndex(zIndex): void
Parameters
- zIndex: number
Returns void
- Defined in src/modules/clip/ClipStyle.ts:240

update

update(sprite): void
Parameters
- sprite: T
Returns void
- Defined in src/modules/clip/ClipStyle.ts:262

`Static` deserialize

deserialize(payload): ClipStyle<Sprite>
Parameters
- payload: object
Returns ClipStyle<Sprite>
- Defined in src/modules/clip/ClipStyle.ts:390

Class ClipStyle<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ClipStyle<T>

Methods

destroy

Returns void

getAlpha

Returns number

getAnimationPositionOffset

Returns [number, number]

getAnimationRotationOffset

Returns number

getAnimationScaleMultiplier

Returns [number, number]

getCornerRadius

Returns number[]

getHeight

Returns number

getPosition

Returns [number, number]

getRawHeight

Returns number

getRawWidth

Returns number

getRotation

Returns number

getScale

Returns [number, number]

getWidth

Returns number

getZIndex

Returns number

load

Parameters

Returns void

serialize

Returns { alpha: number; clipId: string; cornerRadius?: [number, number, number, number]; height?: number; mediaDataId?: string; position: [number, number]; relativeCornerRadius: boolean; rotation: number; scale: [number, number]; width?: number; zIndex: number; }

alpha: number

clipId: string

Optional cornerRadius?: [number, number, number, number]

Optional height?: number

Optional mediaDataId?: string

position: [number, number]

relativeCornerRadius: boolean

rotation: number

scale: [number, number]

Optional width?: number

zIndex: number

setAlpha

Parameters

Returns void

setAnimationPositionOffset

Parameters

Returns void

setAnimationRotationOffset

Parameters

Returns void

setAnimationScaleMultiplier

Parameters

Returns void

setCornerRadius

Parameters

Returns void

setPosition

Parameters

Returns void

setRotation

Parameters

Returns void

setScale

Parameters

Returns void

Returns {
alpha: number;
clipId: string;
cornerRadius?: [number, number, number, number];
height?: number;
mediaDataId?: string;
position: [number, number];
relativeCornerRadius: boolean;
rotation: number;
scale: [number, number];
width?: number;
zIndex: number;
}

`Optional` cornerRadius?: [number, number, number, number]

`Optional` height?: number

`Optional` mediaDataId?: string

`Optional` width?: number

`Static` deserialize