OCCCurve

class compas_occ.geometry.OCCCurve(*args, **kwargs)

Bases: Curve

Class representing a general curve object.

Parameters:
namestr, optional

The name of the curve.

Attributes:
dimensionint, read-only

The dimension of the curve.

domaintuple[float, float], read-only

The domain of the parameter space of the curve.

endPoint, read-only

The end point of the curve.

is_closedbool, read-only

Flag indicating that the curve is closed.

is_periodicbool, read-only

Flag indicating that the curve is periodic.

startPoint, read-only

The start point of the curve.

Methods

aabb

Compute the axis aligned bounding box of the curve.

closest_parameters_curve

Computes the curve parameters where the curve is the closest to another given curve.

closest_point

Compute the closest point on the curve to a given point.

closest_points_curve

Computes the points on curves where the curve is the closest to another given curve.

copy

Make an independent copy of the current curve.

curvature_at

Compute the curvature vector at a curve parameter.

divide

Divide the curve into a specific number of equal length segments.

divide_by_count

Divide the curve into a specific number of equal length segments.

divide_by_length

Divide the curve into segments of a given length.

embedded

Return a new curve embedded in the parameter space of the surface.

frame_at

Compute the local frame at a curve parameter.

from_native

Construct a curve from an existing OCC BSplineCurve.

from_occ

Construct a curve from an existing OCC BSplineCurve.

length

Compute the length of the curve.

offset

Return a new curve that is the offset of this curve over the specified distance in the given direction.

parameter_at_distance

Compute the parameter of a point on the curve at a given distance along the curve from a point at a given parameter.

point_at

Compute the point at a curve parameter.

projected

Return a copy of the curve projected onto a surface.

reverse

Reverse the parametrisation of the curve.

tangent_at

Compute the tangent vector at a curve parameter.

to_polyline

Convert the curve to a polyline.

to_step

Write the curve geometry to a STP file.

transform

Transform this curve.

Inherited Methods

ToString

Converts the instance to a string.

compute_aabb

Compute the axis-aligned bounding box of the geometry.

compute_obb

Compute the oriented bounding box of the geometry.

fair

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

from_obj

Load a curve from an OBJ file.

from_step

Load a curve from a STP file.

normal_at

Compute the normal of the curve at a parameter.

reversed

Reverse a copy of the curve.

rotate

Rotate the geometry.

rotated

Returns a rotated copy of this geometry.

scale

Scale the geometry.

scaled

Returns a scaled copy of this geometry.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

smooth

split

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

to_obj

Write the curve geometry to an OBJ file.

to_points

Convert the curve to a list of points.

to_polygon

Convert the curve to a polygon.

transformed

Returns a transformed copy of this geometry.

translate

Translate the geometry.

translated

Returns a translated copy of this geometry.

trim

validate_data

Validate the data against the object's data schema.