Baillehache Pascal's personal website

LibCapy - sdfcsg

Sdf class.

Macros:

#define CAPY_SDFCSG_H

#define CAPY_MAX_NB_TRANSFORM_SDF 10

Maximum number of transformation per SdfShape

Enumerations:

typedef enum CapySdfTransformType {
  capySdfTransformType_none,
  capySdfTransformType_translate,
  capySdfTransformType_scale,
  capySdfTransformType_rotate,
  capySdfTransformType_extrusion,
  capySdfTransformType_symmetry,
  capySdfTransformType_revolution,
  capySdfTransformType_twist,
} CapySdfTransformType;

Types of transformation applied to a CapySdfShape or CapySdfCsg

typedef enum CapySdfType {
  capySdf_box, capySdf_sphere, capySdf_torus, capySdf_capsule,
  capySdf_ellipsoid, capySdf_cone, capySdf_plane,
  capySdf_merge, capySdf_union, capySdf_intersection, capySdf_difference,
  capySdf_user,
} CapySdfType;

Type of shape

typedef enum CapySdfParam {
  capySdfParam_radius = 0, capySdfParam_halfLength,
  capySdfParam_majorRadius = 0, capySdfParam_minorRadius,
  capySdfParam_radiusX = 0, capySdfParam_radiusY, capySdfParam_radiusZ,
  capySdfParam_halfWidth = 0, capySdfParam_halfHeight, capySdfParam_halfDepth,
  capySdfParam_baseRadius = 0, capySdfParam_topRadius, capySdfParam_height,
  capySdfParam_normX = 0, capySdfParam_normY, capySdfParam_normZ,
  capySdfParam_dist,
  capySdfParam_nbParam = 4
} CapySdfParam;

Indices of shape parameters

Typedefs:

typedef struct CapySdf CapySdf;

Predeclaration of CapySdf

Struct CapySdfTransform :

Struct CapySdfTransform's properties:

  CapySdfTransformType type;

Type of the transformation

  CapyPad(CapySdfTransformType, type);

  double vals[4];

Transformation's values. For translate, the 3 first values are used. For scale the first value is used. For rotation, the 4 values are the quaternion values (x,y,z and theta). For extrusion, the first value is used (distance from origin along z axis)

Struct CapySdfTransform's methods:

None.

Struct CapyRayMarchingRes :

Struct CapyRayMarchingRes's properties:

  bool flagIntersect;

Flag to memorise if the ray intersects the shape

  CapyPad(bool, flagIntersect);

  bool hasGaveUp;

Flag to memorise if the ray marching reached the maximum number of steps

  CapyPad(bool, hasGaveUp);

  CapySdf* shape;

Reference to the shape of the nearest intersection

  double dist;

Distance from the ray origin to the intersection

  double distMin;

Shortest observed signed distance between the ray and a shape during the steps of ray marching

  double pos[3];

Coordinates of the intersection in world coordinate system

  double posLocal[3];

Coordinates of the intersection in the shape local coordinate system

  double normal[3];

Normal at the intersection in world coordinate system

Struct CapyRayMarchingRes's methods:

None.

Functions:

double CapySdfGetEpsilon(void);

Getter and setter for the epsilon value

void CapySdfSetEpsilon(double epsilon);

size_t CapySdfGetRayMarchNbMaxStep(void);

Getter and setter for the maximum number of step (to avoid infinite loop) during ray marching.

void CapySdfSetRayMarchNbMaxStep(size_t const nb);

CapySdf CapySdfCreate(void);

Create a CapySdf (by defaut a unit box)

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAlloc(void);

Allocate memory for a new CapySdf and create it (by defaut a unit box)

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

void CapySdfFree(CapySdf** const that);

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

Input argument(s):

that: a pointer to the CapySdf to free

CapySdf CapySdfCreateBox(
  double const width,
  double const height,
  double const depth);

Create a CapySdf for a box of given dimensions Inputs: width: width of the box (x axis) height: height of the box (y axis) depth: depth of the box (z axis)

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocBox(
  double const width,
  double const height,
  double const depth);

Allocate memory for a new CapySdf for a box of given dimensions and create it Inputs: width: width of the box (x axis) height: height of the box (y axis) depth: depth of the box (z axis)

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreatePlane(
  double const norm[3],
  double const dist);

Create a CapySdf for a plane Inputs: norm: normal of the plane (toward the 'out' side of the plane) dist: distance from the origin in the direction of the normal

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocPlane(
  double const norm[3],
  double const dist);

Allocate memory for a new CapySdf for a plane and create it Inputs: norm: normal of the plane (toward the 'out' side of the plane) dist: distance from the origin in the direction of the normal

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateSphere(double const radius);

Create a CapySdf for a sphere of given dimensions Inputs: radius: radius of the sphere

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocSphere(double const radius);

Allocate memory for a new CapySdf for a sphere of given dimensions and create it Inputs: radius: radius of the sphere

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateCone(
  double const baseRadius,
  double const topRadius,
  double const height);

Create a CapySdf for a cone (center at the origin, rotation axis along the y axis, top toward +y) of given dimensions and create it Inputs: radius: radius of the sphere

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocCone(
  double const baseRadius,
  double const topRadius,
  double const height);

Allocate memory for a new CapySdf for a cone (center at the origin, rotation axis along the y axis, top toward +y) of given dimensions and create it Inputs: baseRadius: radius of the cone at

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateEllipsoid(
  double const radiusX,
  double const radiusY,
  double const radiusZ);

Create a CapySdf for an ellipsoid of given dimensions (aligned with x, y,z axis) Inputs: radiusX: radius of the ellipsoid along the x axis radiusY: radius of the ellipsoid along the y axis radiusZ: radius of the ellipsoid along the z axis

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocEllipsoid(
  double const radiusX,
  double const radiusY,
  double const radiusZ);

Allocate memory for a new CapySdf for an ellipsoid of given dimensions (aligned with x, y,z axis) and create it Inputs: radiusX: radius of the ellipsoid along the x axis radiusY: radius of the ellipsoid along the y axis radiusZ: radius of the ellipsoid along the z axis

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateTorus(
  double const majorRadius,
  double const minorRadius);

Create a CapySdf for a torus of given dimensions (in xz plane) Inputs: majorRadius: major radius of the torus minorRadius: minor radius of the torus

Output and side effect(s):

Return a CapySdf

CapySdf CapySdfCreateCapsule(
  double const radius,
  double const length);

Create a CapySdf for a capsule (aligned with y axis) of given dimensions Inputs: radius: radius of the capsule length: length of the capsule

Output and side effect(s):

Return a CapySdf

CapySdf* CapySdfAllocCapsule(
  double const radius,
  double const length);

Allocate memory for a new CapySdf for a capsule (aligned with y axis) of given dimensions and create it Inputs: radius: radius of the capsule length: length of the capsule

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf* CapySdfAllocTorus(
  double const majorRadius,
  double const minorRadius);

Allocate memory for a new CapySdf for a torus of given dimensions (in xz plane) and create it Inputs: majorRadius: major radius of the torus minorRadius: minor radius of the torus

Output and side effect(s):

Return a CapySdf

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateMerge(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Create a CapySdf for a merge of two shapes Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

CapySdf* CapySdfAllocMerge(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Allocate memory for a new CapySdf for a merge of two shapes and create it Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateUnion(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Create a CapySdf for an union of two shapes Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

CapySdf* CapySdfAllocUnion(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Allocate memory for a new CapySdf for an union of two shapes and create it Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateIntersection(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Create a CapySdf for an intersection of two shapes Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

CapySdf* CapySdfAllocIntersection(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Allocate memory for a new CapySdf for an intersection of two shapes and create it Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateDifference(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Create a CapySdf for a difference of two shapes Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

CapySdf* CapySdfAllocDifference(
  CapySdf* const shapeA,
  CapySdf* const shapeB);

Allocate memory for a new CapySdf for a difference of two shapes and create it Inputs: shapeA: the first shape shapeB: the second shape

Output and side effect(s):

Return a CapySdf. Component shapes can't be shared with between several CSG, they must be dynamically allocated, and they are free-d by their parent.

Exception(s):

May raise CapyExc_MallocFailed.

CapySdf CapySdfCreateUserDefined(sdfFun const sdf);

Create a CapySdf for a user defined distance field Inputs: sdf: the user defined signed distance field (canonical shape untransformed, taking a reference to the shape and a position in local coordinate system)

Output and side effect(s):

Return a CapySdf.

CapySdf* CapySdfAllocUserDefined(sdfFun const sdf);

Allocate memory for a new CapySdf for a user defined distance field and create it Inputs: sdf: the user defined signed distance field (canonical shape untransformed, taking a reference to the shape and a position in local coordinate system)

Output and side effect(s):

Return a CapySdf.

Exception(s):

May raise CapyExc_MallocFailed.

2023-08-04
in LibCapy,
3 views