ostk.mathematics.geometry.d3.object.Ray

class Ray(

self: ostk.mathematics.geometry.d3.object.Ray,

origin: ostk.mathematics.geometry.d3.object.Point,

direction: numpy.ndarray[numpy.float64[3, 1]],

)

Bases: Object

Create a 3D ray with specified origin and direction.

Parameters:

• origin (Point) -- The origin point of the ray.

• direction (numpy.array) -- The direction vector of the ray.

Example

>>> origin = Point(0.0, 0.0, 0.0)
>>> direction = numpy.array([1.0, 0.0, 0.0])
>>> ray = Ray(origin, direction)

Methods

apply_transformation	Apply a transformation to the ray.
as_cone	Convert the object to a cone.
as_ellipsoid	Convert the object to an ellipsoid.
as_line	Convert the object to a line.
as_line_string	Convert the object to a line string.
as_plane	Convert the object to a plane.
as_point	Convert the object to a point.
as_point_set	Convert the object to a point set.
as_polygon	Convert the object to a polygon.
as_pyramid	Convert the object to a pyramid.
as_ray	Convert the object to a ray.
as_segment	Convert the object to a segment.
as_sphere	Convert the object to a sphere.
contains	Overloaded function.
distance_to	Calculate the distance from the ray to a point.
get_direction	Get the direction vector of the ray.
get_origin	Get the origin point of the ray.
intersection_with	Overloaded function.
intersects	Overloaded function.
is_cone	Check if the object is a cone.
is_defined	Check if the ray is defined.
is_ellipsoid	Check if the object is an ellipsoid.
is_line	Check if the object is a line.
is_line_string	Check if the object is a line string.
is_plane	Check if the object is a plane.
is_point	Check if the object is a point.
is_point_set	Check if the object is a point set.
is_polygon	Check if the object is a polygon.
is_pyramid	Check if the object is a pyramid.
is_ray	Check if the object is a ray.
is_segment	Check if the object is a segment.
is_sphere	Check if the object is a sphere.
undefined	Create an undefined ray.

apply_transformation(

self: ostk.mathematics.geometry.d3.object.Ray,

transformation: ostk::mathematics::geometry::d3::Transformation,

) → None

Apply a transformation to the ray.

Parameters:

transformation (Transformation) -- The transformation to apply.

Example

>>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
>>> transformation = Transformation.translation([1.0, 0.0])
>>> ray.apply_transformation(transformation)

as_cone(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Cone

Convert the object to a cone.

Returns:

The cone.

Return type:

Cone

as_ellipsoid(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Ellipsoid

Convert the object to an ellipsoid.

Returns:

The ellipsoid.

Return type:

Ellipsoid

as_line(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Line

Convert the object to a line.

Returns:

The line.

Return type:

Line

as_line_string(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::LineString

Convert the object to a line string.

Returns:

The line string.

Return type:

LineString

as_plane(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Plane

Convert the object to a plane.

Returns:

The plane.

Return type:

Plane

as_point(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Point

Convert the object to a point.

Returns:

The point.

Return type:

Point

as_point_set(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::PointSet

Convert the object to a point set.

Returns:

The point set.

Return type:

PointSet

as_polygon(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Polygon

Convert the object to a polygon.

Returns:

The polygon.

Return type:

Polygon

as_pyramid(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Pyramid

Convert the object to a pyramid.

Returns:

The pyramid.

Return type:

Pyramid

as_ray(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Ray

Convert the object to a ray.

Returns:

The ray.

Return type:

Ray

as_segment(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Segment

Convert the object to a segment.

Returns:

The segment.

Return type:

Segment

as_sphere(

self: ostk.mathematics.geometry.d3.Object,

) → ostk::mathematics::geometry::d3::object::Sphere

Convert the object to a sphere.

Returns:

The sphere.

Return type:

Sphere

contains(*args, **kwargs)

Overloaded function.

1. contains(self: ostk.mathematics.geometry.d3.object.Ray, point: ostk.mathematics.geometry.d3.object.Point) -> bool

   Check if the ray contains a point.

   Args:

   point (Point): The point to check.

   Returns:

   bool: True if the ray contains the point, False otherwise.

   Example:

   >>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
   >>> ray.contains(Point(2.0, 0.0, 0.0))  # True (point on ray)
   

2. contains(self: ostk.mathematics.geometry.d3.object.Ray, point_set: ostk.mathematics.geometry.d3.object.PointSet) -> bool

   Check if the ray contains a point set.

   Args:

   point_set (PointSet): The point set to check.

   Returns:

   bool: True if the ray contains the point set, False otherwise.

distance_to(

self: ostk.mathematics.geometry.d3.object.Ray,

point: ostk.mathematics.geometry.d3.object.Point,

) → ostk.core.type.Real

Calculate the distance from the ray to a point.

Parameters:

point (Point) -- The point to calculate distance to.

Returns:

The minimum distance from the ray to the point.

Return type:

float

Example

>>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
>>> distance = ray.distance_to(Point(1.0, 1.0, 0.0))  # 1.0

get_direction(

self: ostk.mathematics.geometry.d3.object.Ray,

) → numpy.ndarray[numpy.float64[3, 1]]

Get the direction vector of the ray.

Returns:

The normalized direction vector of the ray.

Return type:

Vector3d

Example

>>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
>>> direction = ray.get_direction()  # [1.0, 0.0, 0.0]

get_origin(

self: ostk.mathematics.geometry.d3.object.Ray,

) → ostk.mathematics.geometry.d3.object.Point

Get the origin point of the ray.

Returns:

The origin point of the ray.

Return type:

Point

Example

>>> ray = Ray(Point(1.0, 2.0, 3.0), numpy.array([1.0, 0.0, 0.0]))
>>> origin = ray.get_origin()  # Point(1.0, 2.0, 3.0)

intersection_with(*args, **kwargs)

Overloaded function.

1. intersection_with(self: ostk.mathematics.geometry.d3.object.Ray, plane: ostk::mathematics::geometry::d3::object::Plane) -> ostk::mathematics::geometry::d3::Intersection

   Compute the intersection of the ray with a plane.

   Args:

   plane (Plane): The plane to intersect with.

   Returns:

   Intersection: The intersection of the ray with the plane.

   Example:

   >>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([0.0, 0.0, -1.0]))
   >>> plane = Plane(Point(0.0, 0.0, 0.0), numpy.array([0.0, 0.0, 1.0]))
   >>> intersection = ray.intersection_with(plane)
   >>> intersection.get_point()  # Point(0.0, 0.0, 0.0)
   

2. intersection_with(self: ostk.mathematics.geometry.d3.object.Ray, sphere: ostk::mathematics::geometry::d3::object::Sphere, only_in_sight: bool = False) -> ostk::mathematics::geometry::d3::Intersection

   Compute the intersection of the ray with a sphere.

   Args:

   sphere (Sphere): The sphere to intersect with. only_in_sight (bool, optional): If true, only return intersection points that are in sight. Defaults to True.

   Returns:

   Intersection: The intersection of the ray with the sphere.

   Example:

   >>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
   >>> sphere = Sphere(Point(0.0, 0.0, 0.0), 1.0)
   >>> intersection = ray.intersection_with(sphere)
   >>> intersection.get_point()  # Point(0.0, 0.0, 0.0)
   

3. intersection_with(self: ostk.mathematics.geometry.d3.object.Ray, ellipsoid: ostk::mathematics::geometry::d3::object::Ellipsoid, only_in_sight: bool = False) -> ostk::mathematics::geometry::d3::Intersection

   Compute the intersection of the ray with an ellipsoid.

   Args:

   ellipsoid (Ellipsoid): The ellipsoid to intersect with. only_in_sight (bool, optional): If true, only return intersection points that are in sight. Defaults to True.

   Returns:

   Intersection: The intersection of the ray with the ellipsoid.

   Example:

   >>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
   >>> ellipsoid = Ellipsoid(Point(0.0, 0.0, 0.0), 1.0, 1.0, 1.0)
   >>> intersection = ray.intersection_with(ellipsoid)
   >>> intersection.get_point()  # Point(0.0, 0.0, 0.0)
   

intersects(*args, **kwargs)

Overloaded function.

1. intersects(self: ostk.mathematics.geometry.d3.object.Ray, point: ostk.mathematics.geometry.d3.object.Point) -> bool

2. intersects(self: ostk.mathematics.geometry.d3.object.Ray, plane: ostk::mathematics::geometry::d3::object::Plane) -> bool

3. intersects(self: ostk.mathematics.geometry.d3.object.Ray, sphere: ostk::mathematics::geometry::d3::object::Sphere) -> bool

4. intersects(self: ostk.mathematics.geometry.d3.object.Ray, ellipsoid: ostk::mathematics::geometry::d3::object::Ellipsoid) -> bool

is_cone(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a cone.

Returns:

True if the object is a cone.

Return type:

bool

is_defined(self: ostk.mathematics.geometry.d3.object.Ray) → bool

Check if the ray is defined.

Returns:

True if the ray is defined, False otherwise.

Return type:

bool

Example

>>> ray = Ray(Point(0.0, 0.0, 0.0), numpy.array([1.0, 0.0, 0.0]))
>>> ray.is_defined()  # True

is_ellipsoid(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is an ellipsoid.

Returns:

True if the object is an ellipsoid.

Return type:

bool

is_line(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a line.

Returns:

True if the object is a line.

Return type:

bool

is_line_string(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a line string.

Returns:

True if the object is a line string.

Return type:

bool

is_plane(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a plane.

Returns:

True if the object is a plane.

Return type:

bool

is_point(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a point.

Returns:

True if the object is a point.

Return type:

bool

is_point_set(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a point set.

Returns:

True if the object is a point set.

Return type:

bool

is_polygon(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a polygon.

Returns:

True if the object is a polygon.

Return type:

bool

is_pyramid(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a pyramid.

Returns:

True if the object is a pyramid.

Return type:

bool

is_ray(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a ray.

Returns:

True if the object is a ray.

Return type:

bool

is_segment(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a segment.

Returns:

True if the object is a segment.

Return type:

bool

is_sphere(self: ostk.mathematics.geometry.d3.Object) → bool

Check if the object is a sphere.

Returns:

True if the object is a sphere.

Return type:

bool

static undefined() → ostk.mathematics.geometry.d3.object.Ray

Create an undefined ray.

Returns:

An undefined ray object.

Return type:

Ray

Example

>>> undefined_ray = Ray.undefined()
>>> undefined_ray.is_defined()  # False