Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ViewerHighlightAPI

Interface ViewerHighlightAPI

interface ViewerHighlightAPI {
    dehighlightEntity(highlightHandle?: number): void;
    highlightArc(
        pickedPt1: Float32Array<ArrayBufferLike> | [number, number, number],
        pickedPt3: Float32Array<ArrayBufferLike> | [number, number, number],
        center: Float32Array<ArrayBufferLike> | [number, number, number],
        axis: Float32Array<ArrayBufferLike> | [number, number, number],
        angle: number,
        measurementID: number,
    ): number;
    highlightBBox(
        center: Float32Array<ArrayBufferLike> | [number, number, number],
        size: Float32Array<ArrayBufferLike> | [number, number, number],
    ): number;
    highlightCircularArc(
        circularArcDescriptor: TopologyCircularArcDescriptor,
    ): number;
    highlightEntity(
        handle: TopologyHandle,
        highlightParameters?: ViewerHighlightParameters,
    ): Promise<number>;
    highlightLine(values: number[], scale: number, markerIndex: number): void;
    highlightPoint(
        position: Float32Array<ArrayBufferLike> | [number, number, number],
        markerIndex: number,
    ): void;
}

Hierarchy (View Summary)

Methods

dehighlightEntity highlightArc highlightBBox highlightCircularArc highlightEntity highlightLine highlightPoint

Methods

dehighlightEntity

  • dehighlightEntity(highlightHandle?: number): void

  • Disable highlighting for the handle

    Parameters

    • OptionalhighlightHandle: number

      : number

    Returns void

highlightArc

  • highlightArc(
        pickedPt1: Float32Array<ArrayBufferLike> | [number, number, number],
        pickedPt3: Float32Array<ArrayBufferLike> | [number, number, number],
        center: Float32Array<ArrayBufferLike> | [number, number, number],
        axis: Float32Array<ArrayBufferLike> | [number, number, number],
        angle: number,
        measurementID: number,
    ): number

  • Parameters

    • pickedPt1: Float32Array<ArrayBufferLike> | [number, number, number]
    • pickedPt3: Float32Array<ArrayBufferLike> | [number, number, number]
    • center: Float32Array<ArrayBufferLike> | [number, number, number]
    • axis: Float32Array<ArrayBufferLike> | [number, number, number]
    • angle: number
    • measurementID: number

    Returns number

highlightBBox

  • highlightBBox(
        center: Float32Array<ArrayBufferLike> | [number, number, number],
        size: Float32Array<ArrayBufferLike> | [number, number, number],
    ): number

  • Parameters

    • center: Float32Array<ArrayBufferLike> | [number, number, number]
    • size: Float32Array<ArrayBufferLike> | [number, number, number]

    Returns number

highlightCircularArc

highlightEntity

  • highlightEntity(
        handle: TopologyHandle,
        highlightParameters?: ViewerHighlightParameters,
    ): Promise<number>

  • Enable highlighting of the entity , which matches the attributes informed in the viewerDataSelector

    Parameters

    Returns Promise<number>

    the highlightHandle, which it reqed to remove the highlighting

highlightLine

  • highlightLine(values: number[], scale: number, markerIndex: number): void

  • Parameters

    • values: number[]
    • scale: number
    • markerIndex: number

    Returns void

highlightPoint

  • highlightPoint(
        position: Float32Array<ArrayBufferLike> | [number, number, number],
        markerIndex: number,
    ): void

  • Parameters

    • position: Float32Array<ArrayBufferLike> | [number, number, number]
    • markerIndex: number

    Returns void