capytaine.meshes.geometry module

Tools to describe geometric objects in 3D. Based on meshmagick <https://github.com/LHEEA/meshmagick> by François Rongère.

class capytaine.meshes.geometry.Abstract3DObject

Bases: ABC

Abstract class for 3d objects that can be transformed in 3d. The child classes have to define mirror, rotate and translate, then more routines such as translate_x and translated are automatically available.

abstract mirror(plane)

mirrored(*args, **kwargs)

abstract rotate(axis, angle)

rotate_around_center_to_align_vectors(*args, inplace=True, name=None, **kwargs)

rotate_x(*args, inplace=True, name=None, **kwargs)

rotate_y(*args, inplace=True, name=None, **kwargs)

rotate_z(*args, inplace=True, name=None, **kwargs)

rotated(*args, **kwargs)

rotated_around_center_to_align_vectors(*args, **kwargs)

rotated_x(*args, **kwargs)

rotated_y(*args, **kwargs)

rotated_z(*args, **kwargs)

abstract translate(vector)

translate_point_to_point(*args, inplace=True, name=None, **kwargs)

translate_x(*args, inplace=True, name=None, **kwargs)

translate_y(*args, inplace=True, name=None, **kwargs)

translate_z(*args, inplace=True, name=None, **kwargs)

translated(*args, **kwargs)

translated_point_to_point(*args, **kwargs)

translated_x(*args, **kwargs)

translated_y(*args, **kwargs)

translated_z(*args, **kwargs)

class capytaine.meshes.geometry.Axis(vector=(1, 0, 0), point=(0, 0, 0))

Bases: Abstract3DObject

angle_with_respect_to(other_axis: Axis) → float

Angle between two axes.

copy(name=None)

is_orthogonal_to(other)

is_parallel_to(other)

mirror(*args, inplace=True, name=None, **kwargs)

rotate(*args, inplace=True, name=None, **kwargs)

rotate_points(points, angle)

rotate_vectors(vectors, angle)

rotation_matrix(theta)

Rotation matrix around the vector according to Rodrigues’ formula.

translate(*args, inplace=True, name=None, **kwargs)

class capytaine.meshes.geometry.ClippableMixin

Bases: ABC

Abstract base class for object that can be clipped. The child classes should implement a clip method, then this abstract class will append the new methods clipped, keep_immersed_part and immersed_part, all based on clip.

abstract clip(plane)

clipped(plane, **kwargs)

immersed_part(free_surface=0.0, *, sea_bottom=None, water_depth=None)

keep_immersed_part(*args, inplace=True, name=None, **kwargs)

class capytaine.meshes.geometry.Plane(normal=(0.0, 0.0, 1.0), point=(0.0, 0.0, 0.0))

Bases: Abstract3DObject

3D plane, oriented by the direction of their normal.

property c

Distance from plane to origin.

copy(name=None)

distance_to_point(points)

Return the orthogonal distance of points with respect to the plane. The distance is counted positively on one side of the plane and negatively on the other.

Parameters:

points (ndarray) – Array of points coordinates

Returns:

dist – Array of distances of points with respect to the plane

Return type:

ndarray

get_edge_intersection(p0, p1)

Returns the coordinates of the intersection point between the plane and the edge P0P1.

Parameters:

• p0 (ndarray) – Coordinates of point p0

• p1 (ndarray) – Coordinates of point P1

Returns:

I – Coordinates of intersection point

Return type:

ndarray

is_orthogonal_to(other)

mirror(*args, inplace=True, name=None, **kwargs)

rotate(*args, inplace=True, name=None, **kwargs)

property s

Distance from origin to plane along the normal

translate(*args, inplace=True, name=None, **kwargs)

capytaine.meshes.geometry.inplace_transformation(inplace_function)

Decorator for methods transforming 3D objects: * Add the optional argument inplace to return a new object instead of doing the transformation in place. * If the object has properties cached in an “__internals__” dict, they are deleted.

capytaine.meshes.geometry.orthogonal_vectors(vec1, vec2) → bool

capytaine.meshes.geometry.parallel_vectors(vec1, vec2) → bool

capytaine.meshes.geometry.parallel_vectors_with_same_direction(vec1, vec2) → bool