Click or drag to resize
Ab4d.SharpEngine logo

SceneViewGetAllHitObjects(Single, Single, Boolean, HitTestOptions) Method

GetAllHitObjects method executes a hit testing from the specified x and y positions on the SceneNodes that are shown by this SceneView and returns a list of RayHitTestResult objects sorted from the closest to the farthest object. When no object is hit, an empty list is returned.

Namespace: Ab4d.SharpEngine
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
public List<RayHitTestResult> GetAllHitObjects(
	float x,
	float y,
	bool adjustForDpiScale = true,
	HitTestOptions? customHitTestOptions = null
)

Parameters

x  Single
x position in this view (for example, a mouse x position)
y  Single
y position in this view (for example, a mouse y position)
adjustForDpiScale  Boolean  (Optional)
when true (by default) the x and y positions are multiplied by the DpiScaleX and DpiScaleY. This should be used when x and y are get from mouse location on the SceneView object. When x any y are from the SceneView.Width and SceneView.Height, then this parameter needs to be false.
customHitTestOptions  HitTestOptions  (Optional)
Optional HitTestOptions that will be used for this hit test. When null (by default), then DefaultHitTestOptions from Scene will be used.

Return Value

ListRayHitTestResult
a list of RayHitTestResult objects or an empty list when no object is hit
Remarks

GetAllHitObjects method executes a hit testing on the SceneNodes that are shown by this SceneView and returns a list of RayHitTestResult objects sorted from the closest to the farthest object. When no object is hit, an empty list is returned.

This method first creates a ray by calling GetRayFromCamera(Single, Single, Boolean, Boolean) method and then calls the GetAllHitObjects(Ray, SceneNode, HitTestOptions) method.

To control advanced hit-testing options set the customHitTestOptions parameter (HitTestOptions) or change the Scene.[!:DefaultHitTestOptions] that is used when customHitTestOptions parameter is not set (null by default).

To get only the closest hit result, use the [!:GetClosestHitObject(float, float, bool)] or [!:GetClosestHitObject(Ray)] methods.

See Also