Baillehache Pascal's personal website

LibCapy - lightray

LightRay class.

Macros:

#define CAPY_LIGHTRAY_H

#define CAPY_DEFAULT_WAVELENGTH 589.29

Default wavelength

Enumerations:

typedef enum CapyMaterialIdx {
  capyMaterialIdx_vacuum,
  capyMaterialIdx_air,
  capyMaterialIdx_glass,
  capyMaterialIdx_water,
  capyMaterialIdx_silver,
  capyMaterialIdx_gold,
  capyMaterialIdx_copper,
  capyMaterialIdx_diamond,
  capyMaterialIdx_nb,
} CapyMaterialIdx;

Predefined materials index

Typedefs:

typedef struct CapyLightRay CapyLightRay;

LightRay object

Struct CapyRefractiveCoeff :

Struct CapyRefractiveCoeff's properties:

  double vals[2];

Cauchy coefficients (for lambda in nanometers)

Struct CapyRefractiveCoeff's methods:

None.

Struct CapyRefractionValue :

Struct CapyRefractionValue's properties:

  union {

    double vals[3];

    struct __attribute__((packed)) { double reflective, transmissive, theta; };

};

Struct CapyRefractionValue's methods:

None.

Functions:

double CapyGetRefractiveIndex(
  CapyRefractiveCoeff const coeff,
               double const lambda);

Get the refractive index for given Cauchy coefficients and wavelength Inputs: coeff: the Cauchy coefficients lambda: the wavelength in nanometer

Output and side effect(s):

Return the refractive index

CapyRefractiveCoeff CapyEstimateRefractiveCoeffFromReflectiveIndex(
  double const reflective);

Estimate the Cauchy coefficients from the reflectivity Inputs: reflectivity: the reflectivity in [0,1]

Output and side effect(s):

Return the estimated Cauchy coefficients (B set to 0.0, relative to vacuum)

CapyRefractionValue CapyGetRefraction(
  CapyRefractiveCoeff const coeffFrom,
  CapyRefractiveCoeff const coeffTo,
               double const theta);

Get the refraction values for given refractive coefficients, angle of incidence and a default wavelength (CAPY_DEFAULT_WAVELENGTH) Inputs: coeffFrom: the Cauchy coefficients of the incoming material coeffTo: the Cauchy coefficients of the outgoing material theta: angle of incidence in radians (angle between the incoming ray of light and the normal of the interface of materials)

Output and side effect(s):

Return the refraction values when moving from a material with Cauchy coefficients 'coeffFrom' to a material with Cauchy coefficients 'coeffTo'. In other words, how much light traveling in the 'from' material goes back to the 'from' material after encountering the 'to' material.

CapyRefractionValue CapyGetRefractionForWavelength(
  CapyRefractiveCoeff const coeffFrom,
  CapyRefractiveCoeff const coeffTo,
               double const theta,
               double const lambda);

Get the refraction values for given refractive coefficients, angle of incidence and given wavelength Inputs: coeffFrom: the Cauchy coefficients of the incoming material coeffTo: the Cauchy coefficients of the outgoing material theta: angle of incidence in radians (angle between the incoming ray of light and the normal of the interface of materials) lambda: the wavelength (in nanometer)

Output and side effect(s):

Return the refractive coeffcients for the given wavelength when moving from a material with Cauchy coefficients 'coeffFrom' to a material with Cauchy coefficients 'coeffTo' In other words, how much light traveling in the 'from' material goes back to the 'from' material after encountering the 'to' material.

double CapyGetCriticalRefractiveAngle(
  CapyRefractiveCoeff const coeffFrom,
  CapyRefractiveCoeff const coeffTo,
               double const lambda);

Get the critical refractive angle given refractive coefficients and wavelength Inputs: coeffFrom: the Cauchy coefficients of the incoming material coeffTo: the Cauchy coefficients of the outgoing material lambda: the wavelength (in nanometer)

Output and side effect(s):

Return the critical angle in radians.

CapyLightRay CapyLightRayCreate(void);

Create a CapyLightRay

Output and side effect(s):

Return a CapyLightRay

CapyLightRay* CapyLightRayAlloc(void);

Allocate memory for a new CapyLightRay and create it

Output and side effect(s):

Return a CapyLightRay

Exception(s):

May raise CapyExc_MallocFailed.

void CapyLightRayFree(CapyLightRay** const that);

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

Input argument(s):

that: a pointer to the CapyLightRay to free

2024-07-24
in LibCapy,
19 views