RAPointCloud

class ansys.rocky.app.ra_point_cloud.RAPointCloud

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem, ansys.rocky.app.ra_addins.ElementWithAddins, ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin

Rocky PrePost Scripting wrapper for a point cloud in the project.

The wrapper corresponds to an individual PointCloud in the project’s data tree, below the “Point Clouds” item. PointCloud can be retrieved from the RAStudy or the RAPointCloudCollection via:

point_cloud_1 = study.GetElement('Point Cloud 1')
point_cloud_2 = point_cloud_collection[1]

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetFilePath	Get the value of “File Path”.
SetFilePath	Set the path of the file that will be used to generate the point cloud
IsTransient	Returns True if the Point Cloud is transient, False otherwise.
GetEnablePeriodic	Get the value of “Enable Periodic”.
SetEnablePeriodic	Set the value of “Enable Periodic”.
EnablePeriodic	Set the value of “Periodic” to True.
DisablePeriodic	Set the value of “Periodic” to False.
IsPeriodicEnabled	Check if the “Periodic” is enabled.
GetPeriodicStartTime	Get the value of “Periodic Start Time”.
SetPeriodicStartTime	Set the value of “Periodic Start Time”.
GetPeriodicStopTime	Get the value of “Periodic Stop Time”.
SetPeriodicStopTime	Set the value of “Periodic Stop Time”.
GetSearchCutOff	Get the value of “Search Cut Off”.
SetSearchCutOff	Set the value of “Search Cut Off”.
GetSearchCutOffDistance	Get the value of “Search Cut Off Distance”.
SetSearchCutOffDistance	Set the value of “Search Cut Off Distance”.

Import detail

from ansys.rocky.app.ra_point_cloud import RAPointCloud

Method detail

classmethod RAPointCloud.GetWrappedClass() → type[rocky30.models.point_cloud.point_cloud.PointCloud]

classmethod RAPointCloud.GetClassName() → str

RAPointCloud.GetFilePath() → str

Get the value of “File Path”.

RAPointCloud.SetFilePath(file_path: str | pathlib.Path) → None

Set the path of the file that will be used to generate the point cloud described on the content of the file.

The accepted file extensions is “.txt”.

RAPointCloud.IsTransient() → bool

Returns True if the Point Cloud is transient, False otherwise.

RAPointCloud.GetEnablePeriodic() → bool

Get the value of “Enable Periodic”.

RAPointCloud.SetEnablePeriodic(value: bool) → None

Set the value of “Enable Periodic”.

Parameters:

value – The value to set.

RAPointCloud.EnablePeriodic() → None

Set the value of “Periodic” to True.

RAPointCloud.DisablePeriodic() → None

Set the value of “Periodic” to False.

RAPointCloud.IsPeriodicEnabled() → bool

Check if the “Periodic” is enabled.

RAPointCloud.GetPeriodicStartTime(unit: str | None = None) → float

Get the value of “Periodic Start Time”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RAPointCloud.SetPeriodicStartTime(value: str | float, unit: str | None = None) → None

Set the value of “Periodic Start Time”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RAPointCloud.GetPeriodicStopTime(unit: str | None = None) → float

Get the value of “Periodic Stop Time”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RAPointCloud.SetPeriodicStopTime(value: str | float, unit: str | None = None) → None

Set the value of “Periodic Stop Time”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RAPointCloud.GetSearchCutOff() → bool

Get the value of “Search Cut Off”.

RAPointCloud.SetSearchCutOff(value: bool) → None

Set the value of “Search Cut Off”.

Parameters:

value – The value to set.

RAPointCloud.GetSearchCutOffDistance(unit: str | None = None) → float

Get the value of “Search Cut Off Distance”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “m”.

RAPointCloud.SetSearchCutOffDistance(value: str | float, unit: str | None = None) → None

Set the value of “Search Cut Off Distance”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “m”.