Interface XGFStreamChunkRepSetOptions

Options for authoring one projected-size representation set inside each references-only stream chunk.

interface XGFStreamChunkRepSetOptions {
    allMinPixels?: number;
    allRepId?: string;
    coverageRatio?: number;
    dominantMaxPixels?: number;
    dominantObjectIds?: readonly string[];
    dominantRepId?: string;
    enabled?: boolean;
    hysteresisPixels?: number;
    idPrefix?: string;
    maxObjectRatio?: number;
    maxObjects?: number;
    minObjects?: number;
    regularMaxPixels?: number;
    regularMinPixels?: number;
    regularObjectIds?: readonly string[];
    regularRepId?: string;
}

Properties

allMinPixels? allRepId? coverageRatio? dominantMaxPixels? dominantObjectIds? dominantRepId? enabled? hysteresisPixels? idPrefix? maxObjectRatio? maxObjects? minObjects? regularMaxPixels? regularMinPixels? regularObjectIds? regularRepId?

Properties

OptionalallMinPixels

allMinPixels?: number

Minimum projected size for the all-objects representation. Defaults to 260.

OptionalallRepId

allRepId?: string

Default/all-objects representation ID. Defaults to "all".

OptionalcoverageRatio

coverageRatio?: number

Dominance score coverage target. Defaults to 0.72.

OptionaldominantMaxPixels

dominantMaxPixels?: number

Maximum projected size for the dominant representation. Defaults to 220.

OptionaldominantObjectIds

dominantObjectIds?: readonly string[]

Optional explicit reduced-representation object IDs.

When supplied, each chunk's reduced representation contains the IDs from this set that are already present in that chunk. When omitted, the exporter falls back to visual-dominance ranking over the chunk's objects.

OptionaldominantRepId

dominantRepId?: string

Reduced representation ID. Defaults to "dominant".

Optionalenabled

enabled?: boolean

Enables per-chunk representation-set creation.

OptionalhysteresisPixels

hysteresisPixels?: number

Projected-size hysteresis in pixels. Defaults to 16.

OptionalidPrefix

idPrefix?: string

Representation-set ID prefix. Defaults to "chunk-lod".

OptionalmaxObjectRatio

maxObjectRatio?: number

Maximum dominant object fraction per chunk. Defaults to 0.25.

OptionalmaxObjects

maxObjects?: number

Maximum dominant objects per chunk. Overrides maxObjectRatio when supplied.

OptionalminObjects

minObjects?: number

Minimum dominant objects per chunk. Defaults to 1.

OptionalregularMaxPixels

regularMaxPixels?: number

Maximum projected size for the middle-detail representation. Defaults to 260.

OptionalregularMinPixels

regularMinPixels?: number

Minimum projected size for the middle-detail representation. Defaults to 220.

OptionalregularObjectIds

regularObjectIds?: readonly string[]

Optional explicit middle-detail representation object IDs.

OptionalregularRepId

regularRepId?: string

Middle-detail representation ID. Defaults to "regular".

Settings

Member Visibility

On This Page

Properties