IRaycastQuery#

class omni.kit.raycast.query.IRaycastQuery#

Bases: pybind11_object

Methods

__init__(*args, **kwargs)

add_raycast_sequence(self)

Add a sequence of raycast queries that maintains last valid value

get_latest_result_from_raycast_sequence(...)

Get latest result from a sequence of raycasts.

get_latest_result_from_raycast_sequence_array(...)

Get latest result from a sequence of raycasts.

get_raycast_sequence_array_size(self, arg0)

Get the size of the raycast sequence.

remove_raycast_sequence(self, arg0)

Remove a sequence of raycasts.

set_raycast_sequence_array_size(self, arg0, arg1)

Set the size of the raycast sequence.

submit_ray_to_raycast_sequence(self, arg0, arg1)

Submit a single ray request to a sequence of raycasts.

submit_ray_to_raycast_sequence_array(self, ...)

Submit an array of rays request to a sequence of raycasts.

submit_raycast_query(self, ray, callback)

This function adds a raycast query operation in the current scene.
__init__(*args, **kwargs)#
add_raycast_sequence(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
) → int#
Add a sequence of raycast queries that maintains last valid value

and will execute raycast on current scene.

Returns:

Sequence id in raycast sequence for added.

Return type:

int

get_latest_result_from_raycast_sequence(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
) → Tuple[omni.kit.raycast.query._omni_kit_raycast_query.Result, omni.kit.raycast.query._omni_kit_raycast_query.Ray, omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult]#

Get latest result from a sequence of raycasts.

Parameters:

sequenceId (int) – Sequence id returned by addRaycastSequence.

Returns:

obj:’Result’, :obj:’Ray’, :obj:’RayQueryResult’): Latest ray that was resolved and result of the ray request.

Return type:

Tuple(

get_latest_result_from_raycast_sequence_array(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
) → Tuple[omni.kit.raycast.query._omni_kit_raycast_query.Result, List[omni.kit.raycast.query._omni_kit_raycast_query.Ray], List[omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult]]#

Get latest result from a sequence of raycasts.

Parameters:

sequenceId (int) – Sequence id returned by addRaycastSequence.

Returns:

obj:’Result’, :obj:’Ray’, :obj:’RayQueryResult’): Latest ray that was resolved and result of the ray request.

Return type:

Tuple(

get_raycast_sequence_array_size(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
) → Tuple[omni.kit.raycast.query._omni_kit_raycast_query.Result, int]#

Get the size of the raycast sequence.

Parameters:

sequenceId (int) – Sequence id returned by addRaycastSequence.

Returns:

obj:’Result’, int): Result and size.

Return type:

Tuple(

remove_raycast_sequence(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
) → omni.kit.raycast.query._omni_kit_raycast_query.Result#

Remove a sequence of raycasts.

Parameters:

sequenceId (int) – Sequence id to removed from RaycastSequence.

Returns:

obj:’Result’: Error code if function failed.

set_raycast_sequence_array_size(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
arg1: int,
) → omni.kit.raycast.query._omni_kit_raycast_query.Result#

Set the size of the raycast sequence.

Parameters:

  • sequenceId (int) – Sequence id returned by addRaycastSequence.

  • size (int) – Number of ray casts in sequence.

Returns:

obj:’Result’: Error code if function failed.

submit_ray_to_raycast_sequence(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
arg1: omni.kit.raycast.query._omni_kit_raycast_query.Ray,
) → omni.kit.raycast.query._omni_kit_raycast_query.Result#

Submit a single ray request to a sequence of raycasts. The sequence must have a size of 1.

Parameters:

  • sequenceId (int) – Sequence id returned by addRaycastSequence.

  • ( (ray) – obj:’Ray’): The ray to submit.

Returns:

obj:’Result’: Error code if function failed.

submit_ray_to_raycast_sequence_array(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
arg0: int,
arg1: List[omni.kit.raycast.query._omni_kit_raycast_query.Ray],
) → omni.kit.raycast.query._omni_kit_raycast_query.Result#

Submit an array of rays request to a sequence of raycasts.

Parameters:

  • sequenceId (int) – Sequence id returned by addRaycastSequence.

  • (List[ (rays) – obj:’Ray’]): The rays array to submit.

Returns:

obj:’Result’: Error code if function failed.

submit_raycast_query(
self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery,
ray: omni.kit.raycast.query._omni_kit_raycast_query.Ray,
callback: Callable[[omni.kit.raycast.query._omni_kit_raycast_query.Ray, omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult], None],
) → None#

This function adds a raycast query operation in the current scene.

Parameters:

  • ( (ray) – obj:’Ray’): The ray to submit.

  • callback (Callable) – The callback lambda function to execute when resolved. function signature: void(Ray, RayQueryResult)