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.

Index

Methods

• destroy
• getVisibleObjectsInRectangle

Methods

cee.ug.VisibleObjectPicker.destroy()

destroy(): void

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

Returns: void

cee.ug.VisibleObjectPicker.getVisibleObjectsInRectangle()

getVisibleObjectsInRectangle(cssPixCoordX: number, cssPixCoordY: number, cssPixWidth: number, cssPixHeight: number, acceptPartiallyContainedObjects: boolean): VisibleObjectItem[]

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

Parameters

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

Note that the coordinates are relative to the top left corner of the Canvas element, as in the MouseEvent.offsetX/offsetY if the target of the event is the Canvas Element.

If using multiple Views, they will not be local to the given View the VisibleObjectPicker belongs to, but to the parent Viewer.

acceptPartiallyContainedObjects: boolean

Returns: VisibleObjectItem[]