Interface Effect`Advanced`

An effect that can be applied to a container. This is used to create effects such as filters/masks etc.

interface Effect {
    pipe: string;
    priority: number;
    addBounds(bounds: Bounds, skipUpdateTransform?: boolean): void;
    addLocalBounds(bounds: Bounds, localRoot: Container): void;
    containsPoint(
        point: PointData,
        hitTestFn: (container: Container, point: Point) => boolean,
    ): boolean;
    destroy(): void;
}

Implemented by

Index

Properties

Methods

addBounds? addLocalBounds? containsPoint? destroy

Properties

pipe

pipe: string

priority

priority: number

Methods

`Optional`addBounds

addBounds(bounds: Bounds, skipUpdateTransform?: boolean): void
Parameters
- bounds: Bounds
- OptionalskipUpdateTransform: boolean
Returns void

`Optional`addLocalBounds

addLocalBounds(bounds: Bounds, localRoot: Container): void
Parameters
- bounds: Bounds
- localRoot: Container
Returns void

`Optional`containsPoint

containsPoint(
point: PointData,
hitTestFn: (container: Container, point: Point) => boolean,
): boolean
Parameters
- point: PointData
- hitTestFn: (container: Container, point: Point) => boolean
Returns boolean

destroy

destroy(): void
Returns void