Baillehache Pascal's personal website

LibCapy - geometricShape

Basic geometric shape classes.

Macros:

#define CAPY_GEOMETRICSHAPE_H

#define CapyGeometry2D_ struct {             \
  void (*destruct)(void);                    \
  double (*getArea)(void);                   \
  CapyBezierSpline (*getBezierSpline)(void); \
}

Definition of the parent class for 2D geometric shapes Destructor void (*destruct)(void); Get the area of the geometry

Output and side effect(s):

Return the area double (*getArea)(void);

Convert the geometry into a Bezier spline

Output and side effect(s):

Return the Bezier spline approximating the geometry. CapyBezierSpline (*getBezierSpline)(void);

Enumerations:

None.

Typedefs:

typedef CapyGeometry2D_ CapyGeometry2D;

Parent class for 2D geometric shapes

Struct CapyTriangleCorner :

Struct CapyTriangleCorner's properties:

  union {double coords[2]; struct {double x; double y;};};

Location of the corner

Struct CapyTriangleCorner's methods:

None.

Struct CapyTriangle :

Struct CapyTriangle's properties:

  CapyGeometry2D_;

Inherits CapyGeometry2D

  CapyTriangleCorner corners[3];

Array of three positions, the locations of the triangle's corners.

Struct CapyTriangle's methods:

  void (*destructCapyGeometry2D)(void);

Destructor

Struct CapyQuadrilateralCorner :

Struct CapyQuadrilateralCorner's properties:

  union {double coords[2]; struct {double x; double y;};};

Location of the corner

Struct CapyQuadrilateralCorner's methods:

None.

Struct CapyQuadrilateral :

Struct CapyQuadrilateral's properties:

  CapyGeometry2D_;

Inherits CapyGeometry2D

  CapyQuadrilateralCorner corners[4];

Array of four positions, the location of the quadrilateral's corners, in clockwise order.

Struct CapyQuadrilateral's methods:

  void (*destructCapyGeometry2D)(void);

Destructor

  void (*getBilinearCoords)(
    double const* const pos,
          double* const coords);

Get the bilinear coordinates of a point in the quadirlateral from its coordinates in world coordinate system

Input argument(s):

pos: the position in world coordinate system
coords: double[2] updated with the bilinear coordinates

Struct CapyCircleCenter :

Struct CapyCircleCenter's properties:

  union {double coords[2]; struct {double x; double y;};};

Location of the center

Struct CapyCircleCenter's methods:

None.

Struct CapyCircle :

Struct CapyCircle's properties:

  CapyGeometry2D_;

Inherits CapyGeometry2D

  CapyCircleCenter center;

Center

  double radius;

Radius

Struct CapyCircle's methods:

  void (*destructCapyGeometry2D)(void);

Destructor

Functions:

CapyGeometry2D CapyGeometry2DCreate(void);

Create a CapyGeometry2D

Output and side effect(s):

Return a CapyGeometry2D

CapyTriangle CapyTriangleCreate(void);

Create a CapyTriangle

Output and side effect(s):

Return a CapyTriangle, corners initialised to ((0, 0), (0, 1), (1, 0))

CapyTriangle* CapyTriangleAlloc(void);

Allocate memory for a new CapyTriangle and create it

Output and side effect(s):

Return a CapyTriangle, corners initialised to ((0, 0), (0, 1), (1, 0))

Exception(s):

May raise CapyExc_MallocFailed.

void CapyTriangleFree(CapyTriangle** const that);

Free the memory used by a CapyTriangle* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyTriangle to free

CapyQuadrilateral CapyQuadrilateralCreate(void);

Create a CapyQuadrilateral

Output and side effect(s):

Return a CapyQuadrilateral, corners initialised to ((0, 0), (0, 1), (1, 1), (1, 0))

CapyQuadrilateral* CapyQuadrilateralAlloc(void);

Allocate memory for a new CapyQuadrilateral and create it

Output and side effect(s):

Return a CapyQuadrilateral, corners initialised to ((0, 0), (0, 1), (1, 1), (1, 0))

Exception(s):

May raise CapyExc_MallocFailed.

void CapyQuadrilateralFree(CapyQuadrilateral** const that);

Free the memory used by a CapyQuadrilateral* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyQuadrilateral to free

CapyCircle CapyCircleCreate(void);

Create a CapyCircle

Output and side effect(s):

Return a CapyCircle, center initialised to (0, 0) and radius initialised to 1.

CapyCircle* CapyCircleAlloc(void);

Allocate memory for a new CapyCircle and create it

Output and side effect(s):

Return a CapyCircle, center initialised to (0, 0) and radius initialised to 1.

Exception(s):

May raise CapyExc_MallocFailed.

void CapyCircleFree(CapyCircle** const that);

Free the memory used by a CapyCircle* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyCircle to free

2022-06-21
in LibCapy,
14 views