Expand description
This module contains the C foreign function interface for cavalier_contours.
Structs§
- cavc_
aabbindex - Opaque type that wraps a
StaticAABB2DIndex. - cavc_
pline - Opaque type that wraps a Polyline.
- cavc_
pline_ boolean_ o - FFI representation of
PlineBooleanOptions. - cavc_
pline_ contains_ o - FFI representation of
PlineContainsOptions. - cavc_
pline_ parallel_ offset_ o - FFI representation of
PlineOffsetOptions. - cavc_
pline_ self_ intersect_ o - FFI representation of
PlineSelfIntersectOptions. - cavc_
plinelist - Opaque type that represents a list of
cavc_pline. - cavc_
point - Represents a simple 2D point with x and y coordinate values.
- cavc_
shape - Opaque type that wraps a Shape.
- cavc_
shape_ offset_ o - FFI representation of
ShapeOffsetOptions. - cavc_
vertex - Represents a polyline vertex holding x, y, and bulge.
Constants§
- CAVC_
COINCIDENT_ SEGMENT_ BEHAVIOR_ DISCARD - CAVC_
COINCIDENT_ SEGMENT_ BEHAVIOR_ PRESERVE - CAVC_
CONTAINS_ RESULT_ DISJOINT - CAVC_
CONTAINS_ RESULT_ INTERSECTED - CAVC_
CONTAINS_ RESULT_ INVALID_ INPUT - FFI Representation of
PlineContainsResultenum - CAVC_
CONTAINS_ RESULT_ PLIN E1_ INSIDE_ PLIN E2 - CAVC_
CONTAINS_ RESULT_ PLIN E2_ INSIDE_ PLIN E1 - CAVC_
SELF_ INTERSECTS_ INCLUDE_ ALL - FFI representation of
SelfIntersectsIncludeenum - CAVC_
SELF_ INTERSECTS_ INCLUDE_ GLOBAL - CAVC_
SELF_ INTERSECTS_ INCLUDE_ LOCAL - CAVC_
TOUCHING_ LOOP_ BEHAVIOR_ PRESERVE - FFI values for
TouchingLoopBehaviorandCoincidentSegmentBehavior. - CAVC_
TOUCHING_ LOOP_ BEHAVIOR_ SEPARATE
Functions§
- cavc_
aabbindex_ ⚠f - Free an existing
cavc_aabbindexobject. - cavc_
aabbindex_ ⚠get_ extents - Wraps the
StaticAABB2DIndex::boundsmethod (gets total extents of the aabb index). Writes NaNs if the index is empty. - cavc_
pline_ ⚠add - Add a vertex to a polyline
plinewithx,y, andbulge. - cavc_
pline_ ⚠boolean - Wraps
PlineSource::boolean_opt. - cavc_
pline_ ⚠boolean_ o_ create - Create a new
cavc_pline_boolean_oobject. - cavc_
pline_ ⚠boolean_ o_ f - Free an existing
cavc_pline_boolean_oobject. - cavc_
pline_ ⚠boolean_ o_ init - Write default option values to a
cavc_pline_boolean_o. - cavc_
pline_ ⚠clear - Clears all of the vertexes of a polyline.
- cavc_
pline_ ⚠clone - Clones the polyline.
- cavc_
pline_ ⚠contains - Wraps
PlineSource::contains_opt. - cavc_
pline_ ⚠contains_ o_ create - Create a new
cavc_pline_contains_oobject. - cavc_
pline_ ⚠contains_ o_ f - Free an existing
cavc_pline_contains_oobject. - cavc_
pline_ ⚠contains_ o_ init - Write default option values to a
cavc_pline_contains_o. - cavc_
pline_ ⚠create - Create a new polyline object.
- cavc_
pline_ ⚠create_ aabbindex - Wraps
PlineSource::create_aabb_index. - cavc_
pline_ ⚠create_ approx_ aabbindex - Wraps
PlineSource::create_approx_aabb_index. - cavc_
pline_ ⚠eval_ area - Wraps
PlineSource::area. - cavc_
pline_ ⚠eval_ extents - Wraps
PlineSource::extents. - cavc_
pline_ ⚠eval_ path_ length - Wraps
PlineSource::path_length. - cavc_
pline_ ⚠eval_ wn - Wraps
PlineSource::winding_number. - cavc_
pline_ ⚠f - Free an existing
cavc_plineobject. - cavc_
pline_ ⚠get_ is_ closed - Get whether the polyline is closed or not.
- cavc_
pline_ ⚠get_ userdata_ count - Get the userdata value count of a polyline.
- cavc_
pline_ ⚠get_ userdata_ values - Get the userdata values of a pline
- cavc_
pline_ ⚠get_ vertex - Get a polyline vertex at a given index position.
- cavc_
pline_ ⚠get_ vertex_ count - Get the vertex count of a polyline.
- cavc_
pline_ ⚠get_ vertex_ data - Fills the buffer given with the vertex data of a polyline.
- cavc_
pline_ ⚠invert_ direction - Wraps
PlineSourceMut::invert_direction_mut. - cavc_
pline_ ⚠parallel_ offset - Wraps
PlineSource::parallel_offset_opt. - cavc_
pline_ ⚠parallel_ offset_ o_ create - Create a new
cavc_pline_parallel_offset_oobject. - cavc_
pline_ ⚠parallel_ offset_ o_ f - Free an existing
cavc_pline_parallel_offset_oobject. - cavc_
pline_ ⚠parallel_ offset_ o_ init - Write default option values to a
cavc_pline_parallel_offset_o. - cavc_
pline_ ⚠remove - Remove a vertex from a polyline at an index position.
- cavc_
pline_ ⚠remove_ redundant - Wraps
PlineSource::remove_redundantbut modifies in place rather than returning a result. - cavc_
pline_ ⚠remove_ repeat_ pos - Wraps
PlineSource::remove_repeat_posbut modifies in place rather than returning a result. - cavc_
pline_ ⚠reserve - Reserve space for an
additionalnumber of vertexes in thecavc_pline. - cavc_
pline_ ⚠scale - Wraps
PlineSourceMut::scale_mut. - cavc_
pline_ ⚠scan_ for_ self_ intersect - Wraps
PlineSource::scan_for_self_intersect_opt. - cavc_
pline_ ⚠self_ intersect_ o_ create - Create a new
cavc_pline_self_intersect_oobject. - cavc_
pline_ ⚠self_ intersect_ o_ f - Free an existing
cavc_pline_self_intersect_oobject. - cavc_
pline_ ⚠self_ intersect_ o_ init - Write default option values to a
cavc_pline_self_intersect_o. - cavc_
pline_ ⚠set_ is_ closed - Set whether the polyline is closed or not.
- cavc_
pline_ ⚠set_ userdata_ values - Set the userdata values of a pline
- cavc_
pline_ ⚠set_ vertex - Set a polyline vertex at a given index position.
- cavc_
pline_ ⚠set_ vertex_ data - Sets all of the vertexes of a polyline.
- cavc_
pline_ ⚠translate - Wraps
PlineSourceMut::translate_mut. - cavc_
plinelist_ ⚠create - Create a new
cavc_plinelistobject. - cavc_
plinelist_ ⚠f - Free an existing
cavc_plinelistobject and allcavc_plineowned by it. - cavc_
plinelist_ ⚠get_ count - Get the number of polylines inside a
cavc_plinelist. - cavc_
plinelist_ ⚠get_ pline - Get a polyline at the given index position in the
cavc_plinelist. - cavc_
plinelist_ ⚠pop - Efficiently release and return the last
cavc_plinefrom acavc_plinelist. - cavc_
plinelist_ ⚠push - Append a
cavc_plineto the end of acavc_plinelist. - cavc_
plinelist_ ⚠take - Release and return a
cavc_plinefrom acavc_plinelistat a given index position. - cavc_
shape_ ⚠create - Create a new
cavc_shapeobject. - cavc_
shape_ ⚠f - Free an existing
cavc_shapeobject. - cavc_
shape_ ⚠get_ ccw_ count - Get the count of counter-clockwise polylines in a shape.
- cavc_
shape_ ⚠get_ ccw_ pline_ userdata_ count - Get the userdata value count of a CCW polyline in a shape.
- cavc_
shape_ ⚠get_ ccw_ pline_ userdata_ values - Get the userdata values of a CCW pline in a shape
- cavc_
shape_ ⚠get_ ccw_ polyline_ count - Get the vertex count of a specific counter-clockwise polyline in a shape.
- cavc_
shape_ ⚠get_ ccw_ polyline_ is_ closed - Get whether a specific counter-clockwise polyline in a shape is closed.
- cavc_
shape_ ⚠get_ ccw_ polyline_ vertex_ data - Fills the buffer given with the vertex data of a ccw polyline in a shape.
- cavc_
shape_ ⚠get_ cw_ count - Get the count of clockwise polylines in a shape.
- cavc_
shape_ ⚠get_ cw_ pline_ userdata_ count - Get the userdata value count of a CW polyline in a shape.
- cavc_
shape_ ⚠get_ cw_ pline_ userdata_ values - Get the userdata values of a CW pline in a shape
- cavc_
shape_ ⚠get_ cw_ polyline_ count - Get the vertex count of a specific clockwise polyline in a shape.
- cavc_
shape_ ⚠get_ cw_ polyline_ is_ closed - Get whether a specific clockwise polyline in a shape is closed.
- cavc_
shape_ ⚠get_ cw_ polyline_ vertex_ data - Fills the buffer given with the vertex data of a cw polyline in a shape.
- cavc_
shape_ ⚠offset_ o_ init - Write default option values to a
cavc_shape_offset_o. - cavc_
shape_ ⚠parallel_ offset - Wraps
Shape::parallel_offset. - cavc_
shape_ ⚠set_ ccw_ pline_ userdata_ values - Set the userdata values of a CCW polyline in a shape
- cavc_
shape_ ⚠set_ cw_ pline_ userdata_ values - Set the userdata values of a CW polyline in a shape