SceneGetAllHitObjects(Ray, SceneNode, HitTestOptions) Method

public List<RayHitTestResult> GetAllHitObjects(
	Ray ray,
	SceneNode? rootSceneNode = null,
	HitTestOptions? customHitTestOptions = null
)

Parameters

ray  Ray

Ray object that defines the ray that is used for hit testing

rootSceneNode  SceneNode  (Optional)

SceneNode where the hit testing begins and continues to SceneNode's children. When not set or null, then DXScene.RootNode is used (optional)

customHitTestOptions  HitTestOptions  (Optional)

Optional HitTestOptions that will be used for this hit test. When null (by default), then DefaultHitTestOptions will be used.

Return Value

GetAllHitObjects method executes a hit testing on the SceneNodes in this Scene (or when specified on rootSceneNode and its children) and returns a list of RayHitTestResult objects sorted from the closest to the farthest object. When no triangle is hit, an empty list is returned.

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

To get only the closest hit result, use the GetClosestHitObject(Ray, SceneNode, HitTestOptions) method.

This method creates a new instance of List{RayHitTestResult}. To prevent generating new objects on each hit test and to reuse an existing List, call the GetAllHitObjects method that takes a List{RayHitTestResult} as the first parameter.

Reference