RayfireOptions

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

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

Properties

radius	Radius.
direction	Direction.
max_distance	Maximum distance.
min_distance	Minimum distance.
tight_tolerance	Tight tolerance.
pick_back_faces	Pick back faces.
max_hits	Maximum hits.
request_params	Request parameters.
request_secondary	Request secondary.

Import detail

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

Property detail

property RayfireOptions.radius: ansys.geometry.core.misc.measurements.Distance

Radius.

The radius of the ray.

property RayfireOptions.direction: ansys.geometry.core.math.vector.UnitVector3D

Direction.

The direction for the ray to be fired in.

property RayfireOptions.max_distance: ansys.geometry.core.misc.measurements.Distance

Maximum distance.

The maximum distance the ray should travel.

property RayfireOptions.min_distance: ansys.geometry.core.misc.measurements.Distance

Minimum distance.

The minimum distance the ray should travel.

property RayfireOptions.tight_tolerance: bool

Tight tolerance.

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

property RayfireOptions.pick_back_faces: bool

Pick back faces.

Whether to pick back faces during the ray fire operation.

property RayfireOptions.max_hits: int

Maximum hits.

The maximum number of hits the ray should register.

property RayfireOptions.request_params: bool

Request parameters.

Whether to request additional parameters for the ray fire operation.

property RayfireOptions.request_secondary: bool

Request secondary.

Whether to request secondary hits for the ray fire operation.