RayfireOptions#

class ansys.geometry.core.misc.options.RayfireOptions#

Additional options for ray fire operations.

Parameters:
radiusDistance | Quantity | Real

The radius of the ray. If a Real is provided, it is assumed to be in the default length unit.

directionUnitVector3D

The direction for the ray to be fired in.

max_distanceDistance | Quantity | Real

The maximum distance the ray should travel. If a Real is provided, it is assumed to be in the default length unit.

min_distanceDistance | Quantity | Real

The minimum distance the ray should travel. If a Real is provided, it is assumed to be in the default length unit.

tight_tolerancebool, default=False

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

pick_back_facesbool, default=False

Whether to pick back faces during the ray fire operation.

max_hitsint, default=0

The maximum number of hits the ray should register.

request_paramsbool, default=False

Whether to request additional parameters for the ray fire operation.

request_secondarybool, default=False

Whether to request secondary hits for the ray fire operation.

Overview#

radius

direction

max_distance

min_distance

tight_tolerance

pick_back_faces

max_hits

request_params

request_secondary

__post_init__

Normalize measurement fields to Distance objects.

Import detail#

from ansys.geometry.core.misc.options import RayfireOptions

Attribute detail#

RayfireOptions.radius: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real#
RayfireOptions.direction: ansys.geometry.core.math.vector.UnitVector3D#
RayfireOptions.max_distance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real#
RayfireOptions.min_distance: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real#
RayfireOptions.tight_tolerance: bool = False#
RayfireOptions.pick_back_faces: bool = False#
RayfireOptions.max_hits: int = 0#
RayfireOptions.request_params: bool = False#
RayfireOptions.request_secondary: bool = False#

Method detail#

RayfireOptions.__post_init__()#

Normalize measurement fields to Distance objects.