#include <edit.h>

Collaboration diagram for rt_edit_param_desc:

Data Fields
const char *	name

const char *	label

int	type

int	index

fastf_t	range_min

fastf_t	range_max

const char *	units

int	nenum

const char const	enum_labels

const int *	enum_ids

const char *	prim_field

Detailed Description

Describes a single input parameter for one edit command.

For scalar/integer/boolean/enum parameters the value is stored in s->e_para[index]. For POINT/VECTOR, three consecutive slots starting at e_para[index] are used. For MATRIX, e_para[0..15] are used. For STRING the value is in the primitive-specific edit struct; prim_field documents which field that is. For COLOR three fastf_t integer values (0-255) are stored in e_para[index], e_para[index+1], e_para[index+2].

Definition at line 585 of file edit.h.

Field Documentation

◆ name

const char* name

machine-readable id, e.g. "r1"

Definition at line 586 of file edit.h.

◆ label

const char* label

human-readable widget label, e.g. "Major Radius"

Definition at line 587 of file edit.h.

◆ type

int type

RT_EDIT_PARAM_* type code

Definition at line 588 of file edit.h.

◆ index

int index

offset into s->e_para[] (unused for STRING)

Definition at line 589 of file edit.h.

◆ range_min

fastf_t range_min

RT_EDIT_PARAM_NO_LIMIT = no lower bound

Definition at line 590 of file edit.h.

◆ range_max

fastf_t range_max

RT_EDIT_PARAM_NO_LIMIT = no upper bound

Definition at line 591 of file edit.h.

◆ units

const char* units

"length", "angle_deg", "angle_rad", "fraction", "count", "none", or NULL

Definition at line 592 of file edit.h.

◆ nenum

int nenum

number of choices

Definition at line 595 of file edit.h.

◆ enum_labels

const char* const* enum_labels

human-readable option strings

Definition at line 596 of file edit.h.

◆ enum_ids

const int* enum_ids

integer value stored in e_para[index]

Definition at line 597 of file edit.h.

◆ prim_field

const char* prim_field

name of the primitive struct field, e.g. "es_shader" or "dsp_name"

Definition at line 599 of file edit.h.

The documentation for this struct was generated from the following file:

include/rt/edit.h

Data Fields