Class ClipStyle<T>

Type Parameters

T extends Sprite = Sprite

Hierarchy (View Summary)

ClipStyle
- ShapeStyle
- TextStyle

Constructors

constructor

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

Methods

destroy

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

getAlpha

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

getAnimationAlphaMultiplier

getAnimationAlphaMultiplier(): number
Returns number
- Defined in src/modules/clip/ClipStyle.ts:230

getAnimationPositionOffset

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

getAnimationRotationOffset

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

getAnimationScaleMultiplier

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

getCornerRadius

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

getCornerRadiusRelative

getCornerRadiusRelative(): boolean
Returns boolean
- Defined in src/modules/clip/ClipStyle.ts:154

getHeight

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

getPosition

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

getRawHeight

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

getRawWidth

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

getRotation

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

getScale

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

getWidth

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

getZIndex

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

load

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

positionToCenter

positionToCenter(): void
Returns void
- Defined in src/modules/clip/ClipStyle.ts:97

replaceMediaDataId

replaceMediaDataId(mediaDataId: string): void
Parameters
- mediaDataId: string
Returns void
- Defined in src/modules/clip/ClipStyle.ts:129

scaleDownToFit

scaleDownToFit(): void
Returns void
- Defined in src/modules/clip/ClipStyle.ts:104

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;
}
- Defined in src/modules/clip/ClipStyle.ts:480

setAlpha

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

setAnimationAlphaMultiplier

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

setAnimationPositionOffset

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

setAnimationRotationOffset

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

setAnimationScaleMultiplier

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

setCornerRadius

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

setPosition

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

setRotation

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

setScale

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

setZIndex

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

update

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

`Static`deserialize

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