Interface AppearancePreview

interface AppearancePreview {
    begin(
        owner: AppearanceOwner,
        options?: AppearancePreviewOptions,
    ): AppearanceToken;
    cancel(token: AppearanceToken): void;
    commit(token: AppearanceToken): AppearanceChange;
    getParts?(owner: AppearanceOwner): readonly MeshData[] | undefined;
    prepareCommit(tokens: readonly AppearanceToken[]): () => AppearanceChange[];
    retainSource?(owner: AppearanceOwner): () => void;
    update(token: AppearanceToken, parts: readonly MeshData[]): void;
}

Index

Methods

begin cancel commit getParts? prepareCommit retainSource? update

Methods

begin

begin(
owner: AppearanceOwner,
options?: AppearancePreviewOptions,
): AppearanceToken
Requires finalized resident geometry, or canonical materializedOriginals for one retained GPU occurrence.
Parameters
- owner: AppearanceOwner
- Optionaloptions: AppearancePreviewOptions
Returns AppearanceToken

cancel

cancel(token: AppearanceToken): void
Parameters
- token: AppearanceToken
Returns void

commit

commit(token: AppearanceToken): AppearanceChange
Discard an uncommitted owner draft before replaying its committed history.
Parameters
- token: AppearanceToken
Returns AppearanceChange

`Optional`getParts

getParts?(owner: AppearanceOwner): readonly MeshData[] | undefined
Current canonical parts, including retained originals when an instance is active.
Parameters
- owner: AppearanceOwner
Returns readonly MeshData[] | undefined

prepareCommit

prepareCommit(tokens: readonly AppearanceToken[]): () => AppearanceChange[]
Validate a whole command before consuming any owner; returned commit is idempotent.
Parameters
- tokens: readonly AppearanceToken[]
Returns () => AppearanceChange[]

`Optional`retainSource

retainSource?(owner: AppearanceOwner): () => void
Retain an original occurrence for one host history command; release on disposal.
Parameters
- owner: AppearanceOwner
Returns () => void

update

update(token: AppearanceToken, parts: readonly MeshData[]): void
Full part list in source order. Geometry must preserve exact triangle corners. Mesh arrays are borrowed immutable data, including image pixels and UVs.
Parameters
- token: AppearanceToken
- parts: readonly MeshData[]
Returns void