Interface RestyleableComponent

An interface to be implemented by components with a changable color or TextRenderingStyle.

All such classes must have a member variable, isRestylableComponent that is set to true to allow testing whether the class is a RestylableComponent (see isRestylableComponent).

interface RestyleableComponent {
    contentBBox: Rect2;
    isRestylableComponent: true;
    lastChangedTime: number;
    applyTransformation(affineTransfm: Mat33): void;
    attachLoadSaveData(key: string, data: LoadSaveData): void;
    clone(): AbstractComponent;
    createClone(): AbstractComponent;
    description(localizationTable: ImageComponentLocalization): string;
    forceStyle(style: RestyleableComponentStyle, editor: null | Editor): void;
    getBBox(): Rect2;
    getExactBBox(): Rect2;
    getId(): string;
    getLoadSaveData(): LoadSaveDataTable;
    getProportionalRenderingTime(): number;
    getSizingMode(): ComponentSizingMode;
    getStyle(): RestyleableComponentStyle;
    getZIndex(): number;
    intersects(lineSegment: LineSegment2): boolean;
    intersectsRect(rect: Rect2): boolean;
    isBackground(): boolean;
    isSelectable(): boolean;
    occludesEverythingBelowWhenRenderedInRect(_visibleRect: Rect2): boolean;
    onAddToImage(_image: EditorImage): void;
    onRemoveFromImage(): void;
    render(canvas: AbstractRenderer, visibleRect?: Rect2): void;
    serialize(): {
        data: string
        | number
        | any[]
        | Record<string, any>;
        id: string;
        loadSaveData: LoadSaveDataTable;
        name: string;
        zIndex: number;
    };
    serializeToJSON(): null | string | number | any[] | Record<string, any>;
    setZIndex(newZIndex: number): SerializableCommand;
    transformBy(affineTransfm: Mat33): SerializableCommand;
    updateStyle(style: RestyleableComponentStyle): SerializableCommand;
    withRegionErased(shape: Path, viewport: Viewport): AbstractComponent[];
}

Hierarchy (View Summary)

Implemented by

Properties

contentBBox isRestylableComponent lastChangedTime

Methods

applyTransformation attachLoadSaveData clone createClone description forceStyle getBBox getExactBBox getId getLoadSaveData getProportionalRenderingTime getSizingMode getStyle getZIndex intersects intersectsRect isBackground isSelectable occludesEverythingBelowWhenRenderedInRect onAddToImage onRemoveFromImage render serialize serializeToJSON setZIndex transformBy updateStyle withRegionErased?

Properties

Protected AbstractcontentBBox

contentBBox: Rect2

The bounding box of this component. getBBox, by default, returns contentBBox. This must be set by components.

If this changes, EditorImage.queueRerenderOf should be called for this object (provided that this object has been added to the editor.)

Note: This value is ignored if getSizingMode returns FillScreen or FillImage.

isRestylableComponent

isRestylableComponent: true

ProtectedlastChangedTime

lastChangedTime: number

The timestamp (milliseconds) at which the component was last changed (i.e. created/translated).

Deprecated

Methods

Protected AbstractapplyTransformation

attachLoadSaveData

clone

Protected AbstractcreateClone

Abstractdescription

  • description(localizationTable: ImageComponentLocalization): string

  • Parameters

    • localizationTable: ImageComponentLocalization

    Returns string

    a description that could be read by a screen reader (e.g. when adding/erasing the component)

forceStyle

getBBox

getExactBBox

getId

getLoadSaveData

getProportionalRenderingTime

  • getProportionalRenderingTime(): number

  • Returns number

    an approximation of the proportional time it takes to render this component. This is intended to be a rough estimate, but, for example, a stroke with two points sould have a renderingWeight approximately twice that of a stroke with one point.

getSizingMode

getStyle

getZIndex

Abstractintersects

intersectsRect

  • intersectsRect(rect: Rect2): boolean

  • Parameters

    Returns boolean

    true if this component intersects rect -- it is entirely contained within the rectangle or one of the rectangle's edges intersects this component.

    The default implementation assumes that this.getExactBBox() returns a tight bounding box -- that any horiziontal/vertical line that intersects this' boounding box also intersects a point in this component. If this is not the case, components must override this function.

isBackground

isSelectable

occludesEverythingBelowWhenRenderedInRect

onAddToImage

onRemoveFromImage

Abstractrender

  • render(canvas: AbstractRenderer, visibleRect?: Rect2): void

  • Renders this component onto the given canvas.

    If visibleRect is given, it should be the region of canvas that is visible -- rendering anything outside of visibleRect should have no visible effect on the resultant image.

    For optimal performance, implementers should call canvas.startObject and canvas.endObject before and after rendering.

    Parameters

    Returns void

serialize

  • serialize(): {
        data: string
        | number
        | any[]
        | Record<string, any>;
        id: string;
        loadSaveData: LoadSaveDataTable;
        name: string;
        zIndex: number;
    }

  • Convert the component to an object that can be passed to JSON.stringify.

    Do not rely on the output of this function to take a particular form — this function's output can change form without a major version increase.

    Returns {
        data: string | number | any[] | Record<string, any>;
        id: string;
        loadSaveData: LoadSaveDataTable;
        name: string;
        zIndex: number;
    }

Protected AbstractserializeToJSON

setZIndex

transformBy

updateStyle

OptionalwithRegionErased

Settings

Member Visibility

On This Page

Properties
Methods
OpenSource licenses