param_angle.h File Reference

#include "param.h"

Include dependency graph for param_angle.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct yac_param *	yac_param_angle_new (const char *name, double *value_ptr, double default_value, double value_min, double value_max, int has_default, int is_defined)
	Create an angle parameter (stored in radians)

Function Documentation

yac_param_angle_new()

struct yac_param * yac_param_angle_new	(	const char *	name,
		double *	value_ptr,
		double	default_value,
		double	value_min,
		double	value_max,
		int	has_default,
		int	is_defined )

Create an angle parameter (stored in radians)

Unit handling:

• Numeric setter/getter APIs use radians.
• String setter/getter APIs use degrees by default.
• String setter accepts optional unit suffixes deg, rad, d, r (case-insensitive); if present, conversion is applied accordingly.

Wrapping:

• All values provided via setter interfaces are wrapped to [-PI; PI) before range validation and storage.
• If has_default is non-zero, default_value is wrapped accordingly.
• If is_defined is non-zero, the current value behind value_ptr is wrapped accordingly.

Parameters

name	Name of the parameter
value_ptr	Pointer to the double value (in radians)
default_value	Default value (in radians, ignored if has_default is false)
value_min	Minimum allowed value (inclusive, in radians)
value_max	Maximum allowed value (inclusive, in radians)
has_default	If true, parameter has a default value; if false, value is undefined until set
is_defined	If true, initial value is considered defined; if false, initial value is considered undefined and user must set it before getting

Returns

Pointer to new parameter handle

Definition at line 148 of file param_angle.c.

Here is the call graph for this function:

Here is the caller graph for this function: