← Back to carmenta.com
Carmenta Engine SDK Documentation
×

View.WhatsIn Methods

Finds features presented in the specified window rectangle.

Thread safety: This method is not thread-safe and it should only be called from the GUI thread. Show

Overload List

 NameDescription
Public methodWhatsIn(Rectangle rectangle)Finds features presented in the specified window rectangle.
Public methodWhatsIn(System.Int32 xMin, System.Int32 yMin, System.Int32 xMax, System.Int32 yMax)Finds features presented in the specified window rectangle.

WhatsIn(Rectangle rectangle)

Finds features presented in the specified window rectangle.

Syntax

C#
public PresentationObjectCollection WhatsIn (
    Rectangle rectangle
)

Parameters

rectangle
Type: Rectangle
The window rectangle to check.

Return Value

Type: A collection of PresentationObject elements.
A list of PresentationObject instances.

Remarks

This method finds what has been presented inside the specified rectangle.

The method returns a list of PresentationObject instances, for all presentations that overlap the rectangle, and that originate from selectable layers (see Layer.Selectable). The object that is drawn last (on top) is first in the list in 2D. In 3D, the closest object is first. Presentation objects created by selection visualizers sorted before all other presentation objects. The coordinates of the presentation objects are always in the coordinate reference system of the view.

WhatsIn(System.Int32 xMin, System.Int32 yMin, System.Int32 xMax, System.Int32 yMax)

Finds features presented in the specified window rectangle.

Syntax

C#
public PresentationObjectCollection WhatsIn (
    System.Int32 xMin,
    System.Int32 yMin,
    System.Int32 xMax,
    System.Int32 yMax
)

Parameters

xMin
Type: System.Int32
The x-coordinate of the upper left corner of the rectangle to check.
yMin
Type: System.Int32
The y-coordinate of the upper left corner of the rectangle to check.
xMax
Type: System.Int32
The x-coordinate of the lower right corner of the rectangle to check.
yMax
Type: System.Int32
The y-coordinate of the lower right corner of the rectangle to check.

Return Value

Type: A collection of PresentationObject elements.
A list of PresentationObject instances.

Remarks

This method finds what has been presented inside the specified rectangle.

The method returns a list of PresentationObject instances, for all presentations that overlap the rectangle, and that originate from selectable layers (see Layer.Selectable). The object that is drawn last (on top) is first in the list in 2D. In 3D, the closest object is first. Presentation objects created by selection visualizers sorted before all other presentation objects. The coordinates of the presentation objects are always in the coordinate reference system of the view.

Platforms

Windows, Linux, Android

See Also

Reference

View Class
Core Module

By accessing the information on this site you accept our terms and conditions and privacy policy.
This site uses cookies to enhance your experience and provide additional functionality.

Accept