VisibleObjectPicker

class cee.ug.VisibleObjectPicker()

Client-side visible object picker. This class can be used to get objects that are currently visible in the view, within a specified rectangular region.

Use RemoteModel.createVisibleObjectPicker to create instances of this class.

It is the programmer’s responsibility to call destroy on pickers that are no longer needed, in order to release resources.

Note that a VisibleObjectPicker is only valid while the model is in the same state as when the picker was created. A new picker must be created whenever any display properties are changed on the model, such as current frame or draw style, or when a new state is loaded.

Methods

Methods

destroy

cee.ug.VisibleObjectPicker.destroy()

Release WebGL resources. Once called this object can no longer be used.

Return type

void

getVisibleObjectsInRectangle

cee.ug.VisibleObjectPicker.getVisibleObjectsInRectangle(cssPixCoordX, cssPixCoordY, cssPixWidth, cssPixHeight, acceptPartiallyContainedObjects)

Returns visible objects currently located within the given rectangular region of the view

Arguments

  • cssPixCoordX (number) – The left side of the rectangle in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.

  • cssPixCoordY (number) – The top side of the rectangle in css pixel coordinates. This is relative to the top left corner of the Viewer’s Canvas element.

  • cssPixWidth (number) – The width of the rectangle in css pixels

  • cssPixHeight (number) – The height of the rectangle in css pixels

  • acceptPartiallyContainedObjects (boolean) –

Return type

[cee.ug.VisibleObjectItem]