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

Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: