ostk.mathematics.geometry.d3.object.Segment¶
- class Segment(
- self,
- first_point: ostk.mathematics.geometry.d3.object.Point,
- second_point: ostk.mathematics.geometry.d3.object.Point,
- first_point: ostk.mathematics.geometry.d3.object.Point,
Bases:
ObjectCreate a 3D segment between two points.
- Parameters:
Example
>>> point1 = Point(0.0, 0.0, 0.0) >>> point2 = Point(1.0, 1.0, 1.0) >>> segment = Segment(point1, point2)
Attributes
Apply a transformation to the segment in place.
Convert the object to a cone.
Convert the object to an ellipsoid.
Convert the object to a line.
Convert the object to a line string.
Convert the object to a plane.
Convert the object to a point.
Convert the object to a point set.
Convert the object to a polygon.
Convert the object to a pyramid.
Convert the object to a ray.
Convert the object to a segment.
Convert the object to a sphere.
Check if the segment contains a point.
Overloaded function.
Get the center point of the segment.
Get the direction vector of the segment.
Get the first endpoint of the segment.
Get the length of the segment.
Get the second endpoint of the segment.
Calculate the intersection of the segment with a plane.
Overloaded function.
Check if the object is a cone.
Check if the segment is degenerate (both endpoints are the same).
Check if the object is an ellipsoid.
Check if the object is a line.
Check if the object is a line string.
Check if the object is a plane.
Check if the object is a point.
Check if the object is a point set.
Check if the object is a polygon.
Check if the object is a pyramid.
Check if the object is a ray.
Check if the object is a segment.
Check if the object is a sphere.
Convert the segment to a line.
- apply_transformation¶
Apply a transformation to the segment in place.
- Parameters:
transformation (Transformation) -- The transformation to apply.
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(1.0, 1.0, 1.0)) >>> transformation = Translation([1.0, 1.0, 1.0]) >>> segment.apply_transformation(transformation)
- as_line_string¶
Convert the object to a line string.
- Returns:
The line string.
- Return type:
- contains¶
Check if the segment contains a point.
- Parameters:
point (Point) -- The point to check.
- Returns:
True if the segment contains the point, False otherwise.
- Return type:
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> segment.contains(Point(1.0, 0.0, 0.0)) # True (midpoint)
- distance_to¶
Overloaded function.
distance_to(self, point: ostk.mathematics.geometry.d3.object.Point) -> floatCalculate the distance from the segment to a point.
- Args:
point (Point): The point to calculate distance to.
- Returns:
float: The distance from the segment to the point.
- Example:
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> distance = segment.distance_to(Point(1.0, 0.0, 0.0)) # 1.0
distance_to(self, point_set: ostk.mathematics.geometry.d3.object.PointSet) -> floatCalculate the distance from the segment to a point set.
- Args:
point_set (PointSet): The point set to calculate distance to.
- Returns:
float: The distance from the segment to the point set.
- Example:
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> points = PointSet([Point(1.0, 0.0, 0.0), Point(3.0, 0.0, 0.0)]) >>> distance = segment.distance_to(points) # 1.0
- get_center¶
Get the center point of the segment.
- Returns:
The midpoint of the segment.
- Return type:
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 2.0, 2.0)) >>> center = segment.get_center() # Point(1.0, 1.0, 1.0)
- get_direction¶
Get the direction vector of the segment.
- Returns:
The normalized direction vector from first to second point.
- Return type:
Vector3d
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(1.0, 0.0, 0.0)) >>> direction = segment.get_direction() # [1.0, 0.0, 0.0]
- get_first_point¶
Get the first endpoint of the segment.
- Returns:
The first endpoint of the segment.
- Return type:
Example
>>> segment = Segment(Point(1.0, 2.0, 3.0), Point(4.0, 5.0, 6.0)) >>> first_point = segment.get_first_point() # Point(1.0, 2.0, 3.0)
- get_length¶
Get the length of the segment.
- Returns:
The distance between the two endpoints.
- Return type:
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(3.0, 4.0, 0.0)) >>> length = segment.get_length() # 5.0
- get_second_point¶
Get the second endpoint of the segment.
- Returns:
The second endpoint of the segment.
- Return type:
Example
>>> segment = Segment(Point(1.0, 2.0, 3.0), Point(4.0, 5.0, 6.0)) >>> second_point = segment.get_second_point() # Point(4.0, 5.0, 6.0)
- intersection_with¶
Calculate the intersection of the segment with a plane.
- Parameters:
plane (Plane) -- The plane to calculate intersection with.
- Returns:
The intersection of the segment with the plane.
- Return type:
Example
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> plane = Plane(Point(1.0, 0.0, 0.0), Vector3d(0.0, 0.0, 1.0)) >>> intersection = segment.intersection_with(plane) >>> intersection.get_point() # Point(1.0, 0.0, 0.0)
- intersects¶
Overloaded function.
intersects(self, plane: ostk.mathematics.geometry.d3.object.Plane) -> boolCheck if the segment intersects a plane.
- Args:
plane (Plane): The plane to check intersection with.
- Returns:
bool: True if the segment intersects the plane.
- Example:
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> segment.intersects(Plane(Point(1.0, 0.0, 0.0), Vector3d(0.0, 0.0, 1.0))) # True
intersects(self, sphere: ostk.mathematics.geometry.d3.object.Sphere) -> boolCheck if the segment intersects a sphere.
- Args:
sphere (Sphere): The sphere to check intersection with.
- Returns:
bool: True if the segment intersects the sphere.
- Example:
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> segment.intersects(Sphere(Point(1.0, 0.0, 0.0), 1.0)) # True
intersects(self, ellipsoid: ostk.mathematics.geometry.d3.object.Ellipsoid) -> boolCheck if the segment intersects an ellipsoid.
- Args:
ellipsoid (Ellipsoid): The ellipsoid to check intersection with.
- Returns:
bool: True if the segment intersects the ellipsoid.
- Example:
>>> segment = Segment(Point(0.0, 0.0, 0.0), Point(2.0, 0.0, 0.0)) >>> segment.intersects(Ellipsoid(Point(1.0, 0.0, 0.0), 1.0, 1.0, 1.0)) # True
- is_degenerate¶
Check if the segment is degenerate (both endpoints are the same).
- Returns:
True if the segment is degenerate, False otherwise.
- Return type:
Example
>>> point = Point(0.0, 0.0, 0.0) >>> degenerate_segment = Segment(point, point) >>> degenerate_segment.is_degenerate() # True
- is_ellipsoid¶
Check if the object is an ellipsoid.
- Returns:
True if the object is an ellipsoid.
- Return type:
- is_line_string¶
Check if the object is a line string.
- Returns:
True if the object is a line string.
- Return type:
- is_point_set¶
Check if the object is a point set.
- Returns:
True if the object is a point set.
- Return type:
- is_polygon¶
Check if the object is a polygon.
- Returns:
True if the object is a polygon.
- Return type:
- is_pyramid¶
Check if the object is a pyramid.
- Returns:
True if the object is a pyramid.
- Return type:
- is_segment¶
Check if the object is a segment.
- Returns:
True if the object is a segment.
- Return type:
- is_sphere¶
Check if the object is a sphere.
- Returns:
True if the object is a sphere.
- Return type: