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;
}
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)
- ViewerHighlightAPI
Methods
dehighlight Entity
highlight Arc
- 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
highlight Circular Arc
- highlightCircularArc(
circularArcDescriptor: TopologyCircularArcDescriptor,
): number Parameters
- circularArcDescriptor: TopologyCircularArcDescriptor
Returns number
highlight Entity
- highlightEntity(
handle: TopologyHandle,
highlightParameters?: ViewerHighlightParameters,
): Promise<number> Enable highlighting of the entity , which matches the attributes informed in the viewerDataSelector
Parameters
- handle: TopologyHandle
: IViewerHighlightSelector
Optional
highlightParameters: ViewerHighlightParameters
Returns Promise<number>
the highlightHandle, which it reqed to remove the highlighting
- handle: TopologyHandle
Disable highlighting for the handle