unreal.LidarPointCloudBlueprintLibrary
¶
-
class
unreal.
LidarPointCloudBlueprintLibrary
(outer=None, name='None')¶ Bases:
unreal.BlueprintFunctionLibrary
Blueprint library for the Point Cloud assets
C++ Source:
Plugin: LidarPointCloud
Module: LidarPointCloudRuntime
File: LidarPointCloud.h
-
classmethod
align_clouds
(point_clouds_to_align) → None¶ Aligns provided clouds based on the relative offset between their Original Coordinates. Retains overall centering of the group.
- Parameters
point_clouds_to_align (Array(LidarPointCloud)) –
-
classmethod
apply_color_to_first_point_by_ray
(world_context_object, new_color, origin, direction, radius, visible_only) → None¶ Applies the given color to the first point hit by the given ray
-
classmethod
apply_color_to_points_by_ray
(world_context_object, new_color, origin, direction, radius, visible_only) → None¶ Applies the given color to all points hit by the given ray
-
classmethod
apply_color_to_points_in_box
(world_context_object, new_color, center, extent, visible_only) → None¶ Applies the given color to all points within the box
-
classmethod
apply_color_to_points_in_sphere
(world_context_object, new_color, center, radius, visible_only) → None¶ Applies the given color to all points within the sphere
-
classmethod
are_points_by_ray
(world_context_object, origin, direction, radius, visible_only) → bool¶ Returns true if there are any points hit by the given ray.
-
classmethod
are_points_in_box
(world_context_object, center, extent, visible_only) → bool¶ Returns true if there are any points within the given box.
-
classmethod
are_points_in_sphere
(world_context_object, center, radius, visible_only) → bool¶ Returns true if there are any points within the given sphere.
-
classmethod
create_point_cloud_empty
() → LidarPointCloud¶ Returns new, empty Point Cloud object.
- Returns
- Return type
-
classmethod
create_point_cloud_from_data
(world_context_object, points, use_async, latent_info) -> (async_mode=LidarPointCloudAsyncMode, progress=float, point_cloud=LidarPointCloud)¶ Returns new Point Cloud object created from the data provided.
Warning: If using Async, make sure the data does not get invalidated during processing!
- Parameters
world_context_object (Object) –
points (Array(LidarPointCloudPoint)) –
use_async (bool) –
latent_info (LatentActionInfo) –
- Returns
async_mode (LidarPointCloudAsyncMode):
progress (float):
point_cloud (LidarPointCloud):
- Return type
tuple
-
classmethod
create_point_cloud_from_file
(world_context_object, filename, use_async, latent_info) -> (async_mode=LidarPointCloudAsyncMode, progress=float, point_cloud=LidarPointCloud)¶ Returns new Point Cloud object imported using default settings. If using Async, the process runs in the background without blocking the game thread.
- Parameters
world_context_object (Object) –
filename (str) –
use_async (bool) –
latent_info (LatentActionInfo) –
- Returns
async_mode (LidarPointCloudAsyncMode):
progress (float):
point_cloud (LidarPointCloud):
- Return type
tuple
-
classmethod
export_point_cloud_to_file
(point_cloud, filename) → bool¶ Exports the Point Cloud to the given filename. Consult supported export formats. Returns true if successful
- Parameters
point_cloud (LidarPointCloud) –
filename (str) –
- Returns
- Return type
-
classmethod
get_points_in_box_as_copies
(world_context_object, center, extent, visible_only)¶ Returns an array with copies of points within the given box
-
classmethod
get_points_in_sphere_as_copies
(world_context_object, center, radius, visible_only)¶ Returns an array with copies of points within the given sphere
-
classmethod
line_trace_multi
(world_context_object, origin, direction, radius, visible_only) → Array(LidarPointCloudTraceHit) or None¶ Does a collision trace along the given line and returns all hits encountered up to and including the first blocking hit.
-
classmethod
line_trace_single
(world_context_object, origin, direction, radius, visible_only) → LidarPointCloudTraceHit or None¶ Does a collision trace along the given line and returns the first blocking hit encountered.
-
classmethod
remove_first_point_by_ray
(world_context_object, origin, direction, radius, visible_only) → None¶ Removes the first point hit by the given ray
-
classmethod
remove_points_by_ray
(world_context_object, origin, direction, radius, visible_only) → None¶ Removes all points hit by the given ray
-
classmethod
remove_points_in_box
(world_context_object, center, extent, visible_only) → None¶ Removes all points within the given box
-
classmethod
remove_points_in_sphere
(world_context_object, center, radius, visible_only) → None¶ Removes all points within the given sphere
-
classmethod
set_visibility_of_first_point_by_ray
(world_context_object, new_visibility, origin, direction, radius) → None¶ Sets visibility of the first point hit by the given ray.
-
classmethod
set_visibility_of_points_by_ray
(world_context_object, new_visibility, origin, direction, radius) → None¶ Sets visibility of points hit by the given ray.