Reference Source 
import {PointerCircle} from '@xeokit/xeokit-sdk/src/extras/PointerCircle/PointerCircle.js'
public class | source

PointerCircle

A PointerCircle shows a circle, centered at the position of the mouse or touch pointer.

Constructor Summary

Public Constructor
public

constructor(viewer: *, cfg: *)

Constructs a new PointerCircle.

Member Summary

Public Members
public set

durationMs(durationMs: *)

Sets the zoom factor for the lens.
public get

durationMs: *: *

Gets the zoom factor for the lens.
public

scene: *

public

viewer: *

Method Summary

Public Methods
public

Destroys this PointerCircle.
public

start(circlePos: *)

Show the circle at the given canvas coordinates and begin shrinking it.
public

stop()

Stop the shrinking circle and hide it.

Public Constructors

public constructor(viewer: *, cfg: *) source

Constructs a new PointerCircle.

Params:

NameTypeAttributeDescription
viewer *

The Viewer
cfg *
  • optional

PointerCircle configuration.
cfg.active *
  • optional
  • default: true

Whether PointerCircle is active. The PointerCircle can only be shown when this is true (default).

Public Members

public set durationMs(durationMs: *) source

Sets the zoom factor for the lens.

This is 2 by default.

public get durationMs: *: * source

Gets the zoom factor for the lens.

This is 2 by default.

Return:

*

Number

public scene: * source

public viewer: * source

Public Methods

public destroy() source

Destroys this PointerCircle.

public start(circlePos: *) source

Show the circle at the given canvas coordinates and begin shrinking it.

Params:

NameTypeAttributeDescription
circlePos *

public stop() source

Stop the shrinking circle and hide it.