RayfireTools

class ansys.geometry.core.tools.rayfire_tools.RayfireTools(grpc_client: ansys.geometry.core.connection.client.GrpcClient, modeler: ansys.geometry.core.modeler.Modeler, _internal_use: bool = False)

Rayfire tools for PyAnsys Geometry.

Parameters:

grpc_clientGrpcClient

Active supporting geometry service instance for design modeling.

modelerModeler

The parent modeler instance.

_internal_usebool, optional

Internal flag to prevent direct instantiation by users. This parameter is for internal use only.

Raises:

GeometryRuntimeError

If the class is instantiated directly by users instead of through the modeler.

Notes

This class should not be instantiated directly. Use modeler.rayfire_tools instead.

Overview

Methods

rayfire	Perform rayfire operation.
rayfire_faces	Perform the rayfire operation on faces.
rayfire_ordered	Perform a rayfire ordered operation.
rayfire_ordered_uv	Perform a rayfire ordered operation.

Import detail

from ansys.geometry.core.tools.rayfire_tools import RayfireTools

Method detail

RayfireTools.rayfire(body: ansys.geometry.core.designer.body.Body, faces: list[ansys.geometry.core.designer.face.Face], direction: ansys.geometry.core.math.vector.UnitVector3D, points: list[ansys.geometry.core.math.point.Point3D], max_distance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real) → list[RayfireImpact]

Perform rayfire operation.

Parameters:

bodyBody

Body to perform rayfire on.

faceslist[Face]

Faces to consider.

directionUnitVector3D

Direction of the ray.

pointslist[Point3D]

Starting points for rays.

max_distanceDistance | Quantity | Real

Maximum distance to check.

Returns:

list[RayFireImpact]

Rayfire results.

RayfireTools.rayfire_faces(body: ansys.geometry.core.designer.body.Body, faces: list[ansys.geometry.core.designer.face.Face], points: list[ansys.geometry.core.math.point.Point3D], options: ansys.geometry.core.misc.options.RayfireOptions | None = None) → list[RayfireImpact]

Perform the rayfire operation on faces.

Parameters:

bodyBody

Body to perform rayfire on.

faceslist[Face]

Faces to consider.

pointslist[Point3D]

Starting points for rays.

optionsRayfireOptions, default: None

Options for the rayfire operation.

Returns:

list[RayfireImpact]

Rayfire results.

RayfireTools.rayfire_ordered(body: ansys.geometry.core.designer.body.Body, faces: list[ansys.geometry.core.designer.face.Face], direction: ansys.geometry.core.math.vector.UnitVector3D, ray_radius: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real, points: list[ansys.geometry.core.math.point.Point3D], max_distance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real, tight_tolerance: bool = False) → list[list[RayfireImpact]]

Perform a rayfire ordered operation.

Parameters:

bodyBody

Body to perform rayfire on.

faceslist[Face]

Faces to consider.

directionUnitVector3D

Direction of the ray.

ray_radiusDistance | Quantity | Real

The radius of the ray.

pointslist[Point3D]

Starting points for rays.

max_distanceDistance | Quantity | Real

Maximum distance to check.

tight_tolerancebool, default: False

Whether to use a tight tolerance for the ray fire operation.

Returns:

list[list[RayfireImpact]]

Rayfire results, with one list of impacts per input point.

RayfireTools.rayfire_ordered_uv(body: ansys.geometry.core.designer.body.Body, faces: list[ansys.geometry.core.designer.face.Face], direction: ansys.geometry.core.math.vector.UnitVector3D, ray_radius: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real, points: list[ansys.geometry.core.math.point.Point3D], max_distance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real, tight_tolerance: bool = False) → list[list[RayfireImpact]]

Perform a rayfire ordered operation.

Parameters:

bodyBody

Body to perform rayfire on.

faceslist[Face]

Faces to consider.

directionUnitVector3D

Direction of the ray.

ray_radiusDistance | Quantity | Real

The radius of the ray.

pointslist[Point3D]

Starting points for rays.

max_distanceDistance | Quantity | Real

Maximum distance to check.

tight_tolerancebool

Whether to use a tight tolerance for the ray fire operation.

Returns:

list[list[RayfireImpact]]

Rayfire results, with one list of impacts per input point.