Utility routines for manipulating libbv data structures. More...

Collaboration diagram for Utilities:

Files
file	util.h

file	view_sets.h

Macros
#define	BV_AUTOVIEW_SCALE_DEFAULT -1

#define	BV_KNOBS_ALL 0

#define	BV_KNOBS_RATE 1

#define	BV_KNOBS_ABS 2

#define	BV_IDLE 0x000

#define	BV_ROT 0x001

#define	BV_TRANS 0x002

#define	BV_SCALE 0x004

#define	BV_CENTER 0x008

#define	BV_CON_X 0x010

#define	BV_CON_Y 0x020

#define	BV_CON_Z 0x040

#define	BV_CON_GRID 0x080

#define	BV_CON_LINES 0x100

#define	BV_ENABLE_ENV_LOGGING 1

Functions
void	bv_init (struct bview v, struct bview_set s)

void	bv_free (struct bview *v)

void	bv_mat_aet (struct bview *v)

void	bv_settings_init (struct bview_settings *s)

void	bv_autoview (struct bview *v, fastf_t scale, int all_view_objs)

void	bv_sync (struct bview dest, struct bview src)

int	bv_obj_settings_sync (struct bv_obj_settings dest, struct bv_obj_settings src)

void	bv_update (struct bview *gvp)

int	bv_update_selected (struct bview *gvp)

void	bv_knobs_reset (struct bview_knobs *k, int category)

unsigned long long	bv_knobs_hash (struct bview_knobs k, struct bu_data_hash_state state)

int	bv_knobs_cmd_process (vect_t rvec, int do_rot, vect_t tvec, int do_tran, struct bview v, const char cmd, fastf_t f, char origin, int model_flag, int incr_flag)
	Process an individual libbv knob command.

void	bv_knobs_rot (struct bview *v, const vect_t rvec, char origin, char coords, const matp_t obj_rot, const pointp_t pvt_pt)
	Rotate the view based on an Euler angle triplet (degrees) specified in one of several coordinate frames, about one of several origins.

void	bv_knobs_tran (struct bview *v, const vect_t tvec, int model_flag)

void	bv_update_rate_flags (struct bview *v)

int	bv_differ (struct bview v1, struct bview v2)

unsigned long long	bv_hash (struct bview *v)

unsigned long long	bv_dl_hash (struct display_list *dl)

size_t	bv_clear (struct bview *v, int flags)

int	bv_adjust (struct bview *v, int dx, int dy, point_t keypoint, int mode, unsigned long long flags)

int	bv_screen_to_view (struct bview v, fastf_t fx, fastf_t *fy, fastf_t x, fastf_t y)

int	bv_screen_pt (point_t p, fastf_t x, fastf_t y, struct bview v)

int	bv_scene_obj_bound (struct bv_scene_obj s, struct bview v)

fastf_t	bv_vZ_calc (struct bv_scene_obj s, struct bview v, int mode)

void	bv_obj_sync (struct bv_scene_obj dest, struct bv_scene_obj src)

void	bv_obj_stale (struct bv_scene_obj *s)

struct bv_scene_obj *	bv_obj_create (struct bview *v, int type)

struct bv_scene_obj *	bv_obj_get (struct bview *v, int type)

struct bv_scene_obj *	bv_obj_get_child (struct bv_scene_obj *s)

void	bv_obj_reset (struct bv_scene_obj *s)

void	bv_obj_put (struct bv_scene_obj *o)

struct bv_scene_obj *	bv_find_child (struct bv_scene_obj s, const char vname)

struct bv_scene_obj *	bv_find_obj (struct bview v, const char vname)

void	bv_uniq_obj_name (struct bu_vls oname, const char seed, struct bview *v)

struct bv_scene_obj *	bv_obj_for_view (struct bv_scene_obj s, struct bview v)

struct bv_scene_obj *	bv_obj_get_vo (struct bv_scene_obj s, struct bview v)

int	bv_obj_have_vo (struct bv_scene_obj s, struct bview v)

int	bv_clear_view_obj (struct bv_scene_obj s, struct bview v)

int	bv_illum_obj (struct bv_scene_obj *s, char ill_state)

struct bu_ptbl *	bv_view_objs (struct bview *v, int type)

int	bv_view_plane (plane_t p, struct bview v)

void	bv_log (int level, const char *fmt,...) _BU_ATTR_PRINTF23

void	bv_view_print (const char title, struct bview v, int verbosity)

void	bv_set_init (struct bview_set *s)

void	bv_set_free (struct bview_set *s)

void	bv_set_add_view (struct bview_set s, struct bview v)

void	bv_set_rm_view (struct bview_set s, struct bview v)

struct bu_ptbl *	bv_set_views (struct bview_set *s)

struct bview *	bv_set_find_view (struct bview_set s, const char vname)

struct bv_scene_obj *	bv_set_fsos (struct bview_set *s)

Detailed Description

Utility routines for manipulating libbv data structures.

In applications with multiple views, those views typically share common scene objects and memory. To manage this sharing, we define view sets.

Macro Definition Documentation

◆ BV_AUTOVIEW_SCALE_DEFAULT

#define BV_AUTOVIEW_SCALE_DEFAULT -1

Definition at line 52 of file util.h.

◆ BV_KNOBS_ALL

#define BV_KNOBS_ALL 0

Definition at line 79 of file util.h.

◆ BV_KNOBS_RATE

#define BV_KNOBS_RATE 1

Definition at line 80 of file util.h.

◆ BV_KNOBS_ABS

#define BV_KNOBS_ABS 2

Definition at line 81 of file util.h.

◆ BV_IDLE

#define BV_IDLE 0x000

Definition at line 217 of file util.h.

◆ BV_ROT

#define BV_ROT 0x001

Definition at line 218 of file util.h.

◆ BV_TRANS

#define BV_TRANS 0x002

Definition at line 219 of file util.h.

◆ BV_SCALE

#define BV_SCALE 0x004

Definition at line 220 of file util.h.

◆ BV_CENTER

#define BV_CENTER 0x008

Definition at line 221 of file util.h.

◆ BV_CON_X

#define BV_CON_X 0x010

Definition at line 222 of file util.h.

◆ BV_CON_Y

#define BV_CON_Y 0x020

Definition at line 223 of file util.h.

◆ BV_CON_Z

#define BV_CON_Z 0x040

Definition at line 224 of file util.h.

◆ BV_CON_GRID

#define BV_CON_GRID 0x080

Definition at line 225 of file util.h.

◆ BV_CON_LINES

#define BV_CON_LINES 0x100

Definition at line 226 of file util.h.

◆ BV_ENABLE_ENV_LOGGING

#define BV_ENABLE_ENV_LOGGING 1

Definition at line 364 of file util.h.

Function Documentation

◆ bv_init()

void bv_init	(	struct bview *	v,
		struct bview_set *	s
	)

extern

◆ bv_free()

void bv_free ( struct bview * v )

extern

◆ bv_mat_aet()

void bv_mat_aet ( struct bview * v )

Todo:: this routine is suspect and needs investigating. if run during view initialization, the shaders regression test fails.

◆ bv_settings_init()

void bv_settings_init ( struct bview_settings * s )

extern

◆ bv_autoview()

void bv_autoview	(	struct bview *	v,
		fastf_t	scale,
		int	all_view_objs
	)

extern

Automatically set up the view to make the scene objects visible

◆ bv_sync()

void bv_sync	(	struct bview *	dest,
		struct bview *	src
	)

extern

◆ bv_obj_settings_sync()

int bv_obj_settings_sync	(	struct bv_obj_settings *	dest,
		struct bv_obj_settings *	src
	)

extern

◆ bv_update()

void bv_update ( struct bview * gvp )

extern

◆ bv_update_selected()

int bv_update_selected ( struct bview * gvp )

extern

◆ bv_knobs_reset()

void bv_knobs_reset	(	struct bview_knobs *	k,
		int	category
	)

extern

◆ bv_knobs_hash()

unsigned long long bv_knobs_hash	(	struct bview_knobs *	k,
		struct bu_data_hash_state *	state
	)

extern

◆ bv_knobs_cmd_process()

int bv_knobs_cmd_process	(	vect_t *	rvec,
		int *	do_rot,
		vect_t *	tvec,
		int *	do_tran,
		struct bview *	v,
		const char *	cmd,
		fastf_t	f,
		char	origin,
		int	model_flag,
		int	incr_flag
	)

extern

Process an individual libbv knob command.

Note that the reason rvec, do_rot, tvec and do_tran are set, rather than an immediate view update being performed, is to allow parent applications to process multiple commands before finally triggering the bv_knobs_rot or bv_knobs_tran functions to implement the accumulated instructions.

Parameters

[out]	rvec	Pointer to rotation vector
[out]	do_rot	Pointer to flag indicating whether the command implies a rotation op is needed
[out]	tvec	Pointer to translation vector
[out]	do_tran	Pointer to flag indicating whether the command implies a translation op is needed
[in]	v	bview structure
[in]	cmd	command string - valid entries are x, y, z, X, Y Z, ax, ay, az, aX, aY, aZ, S, aS
[in]	f	numerical parameter to cmd (i.e. aX 0.1 - required for all commands)
[in]	origin	char indicating origin - may be 'e' (eye_pt), 'm' (model origin) or 'v' (view origin - default)
[in]	model_flag	Manipulate view using model coordinates rather than view coordinates
[in]	incr_flag	Treat f parameter as an incremental change rather than an absolute setting

Returns: Returns BRLCAD_OK if command was successfully processed, BRLCAD_ERROR otherwise.

◆ bv_knobs_rot()

void bv_knobs_rot	(	struct bview *	v,
		const vect_t	rvec,
		char	origin,
		char	coords,
		const matp_t	obj_rot,
		const pointp_t	pvt_pt
	)

extern

Rotate the view based on an Euler angle triplet (degrees) specified in one of several coordinate frames, about one of several origins.

coords: Rotation input frame 'v' - rvec in view coordinates 'm' - rvec in model coordinates (converted via Rv * Rm * Rv^{-1}) 'o' - rvec in object coordinates (use obj_rot to map object->model->view, fallback to 'v' semantics if obj_rot is NULL)

origin: Rotation pivot specifier 'v' : view center (0,0,0 in view space) 'm' : model origin 'e' : eye point (0,0,1 in view space) 'k' : model-space custom pivot supplied via pvt_pt Any unrecognized value falls back to 'v'.

obj_rot: Accumulated object->model rotation matrix when coords=='o'. NULL otherwise.

pvt_pt: Model-space pivot point when origin=='k'. Ignored otherwise. NULL == model origin.

BEHAVIOR

rvec is converted into a pure view-space rotation matrix according to 'coords' (and obj_rot for 'o').
If origin != 'v', the view center (gv_center) is relocated so the specified pivot is invariant under the applied rotation.
gv_rotation is post-multiplied by the view rotation matrix.
bv_update(v) refreshes derived matrices. Absolute translation bookkeeping (tra_v_abs / tra_m_abs) is always recomputed

Parameters

[in,out]	v	target bview structure
[in]	rvec	rotation vector (Euler angles, degrees) expressed in the coordinate frame indicated by coords.
[in]	origin	char indicating origin - may be 'e' (eye_pt), 'm' (model origin), 'v' (view origin - default) or 'k' (keypoint)
[in]	coords	coordinate frame - may be 'm' (model), 'o' (obj coords via obj_rot), or 'v' (view)
[in]	obj_rot	pointer to accumulated object rotation matrix (may be NULL)
[in]	pvt_pt	model space pivot point

◆ bv_knobs_tran()

void bv_knobs_tran	(	struct bview *	v,
		const vect_t	tvec,
		int	model_flag
	)

extern

◆ bv_update_rate_flags()

void bv_update_rate_flags ( struct bview * v )

extern

◆ bv_differ()

int bv_differ	(	struct bview *	v1,
		struct bview *	v2
	)

extern

◆ bv_hash()

unsigned long long bv_hash ( struct bview * v )

extern

◆ bv_dl_hash()

unsigned long long bv_dl_hash ( struct display_list * dl )

extern

◆ bv_clear()

size_t bv_clear	(	struct bview *	v,
		int	flags
	)

extern

◆ bv_adjust()

int bv_adjust	(	struct bview *	v,
		int	dx,
		int	dy,
		point_t	keypoint,
		int	mode,
		unsigned long long	flags
	)

extern

◆ bv_screen_to_view()

int bv_screen_to_view	(	struct bview *	v,
		fastf_t *	fx,
		fastf_t *	fy,
		fastf_t	x,
		fastf_t	y
	)

extern

◆ bv_screen_pt()

int bv_screen_pt	(	point_t *	p,
		fastf_t	x,
		fastf_t	y,
		struct bview *	v
	)

extern

◆ bv_scene_obj_bound()

int bv_scene_obj_bound	(	struct bv_scene_obj *	s,
		struct bview *	v
	)

extern

◆ bv_vZ_calc()

fastf_t bv_vZ_calc	(	struct bv_scene_obj *	s,
		struct bview *	v,
		int	mode
	)

extern

◆ bv_obj_sync()

void bv_obj_sync	(	struct bv_scene_obj *	dest,
		struct bv_scene_obj *	src
	)

extern

◆ bv_obj_stale()

void bv_obj_stale ( struct bv_scene_obj * s )

◆ bv_obj_create()

struct bv_scene_obj * bv_obj_create	(	struct bview *	v,
		int	type
	)

◆ bv_obj_get()

struct bv_scene_obj * bv_obj_get	(	struct bview *	v,
		int	type
	)

◆ bv_obj_get_child()

struct bv_scene_obj * bv_obj_get_child ( struct bv_scene_obj * s )

◆ bv_obj_reset()

void bv_obj_reset ( struct bv_scene_obj * s )

◆ bv_obj_put()

void bv_obj_put ( struct bv_scene_obj * o )

◆ bv_find_child()

struct bv_scene_obj * bv_find_child	(	struct bv_scene_obj *	s,
		const char *	vname
	)

◆ bv_find_obj()

struct bv_scene_obj * bv_find_obj	(	struct bview *	v,
		const char *	vname
	)

◆ bv_uniq_obj_name()

void bv_uniq_obj_name	(	struct bu_vls *	oname,
		const char *	seed,
		struct bview *	v
	)

◆ bv_obj_for_view()

struct bv_scene_obj * bv_obj_for_view	(	struct bv_scene_obj *	s,
		struct bview *	v
	)

◆ bv_obj_get_vo()

struct bv_scene_obj * bv_obj_get_vo	(	struct bv_scene_obj *	s,
		struct bview *	v
	)

◆ bv_obj_have_vo()

int bv_obj_have_vo	(	struct bv_scene_obj *	s,
		struct bview *	v
	)

◆ bv_clear_view_obj()

int bv_clear_view_obj	(	struct bv_scene_obj *	s,
		struct bview *	v
	)

◆ bv_illum_obj()

int bv_illum_obj	(	struct bv_scene_obj *	s,
		char	ill_state
	)

◆ bv_view_objs()

struct bu_ptbl * bv_view_objs	(	struct bview *	v,
		int	type
	)

◆ bv_view_plane()

int bv_view_plane	(	plane_t *	p,
		struct bview *	v
	)

◆ bv_log()

void bv_log	(	int	level,
		const char *	fmt,
			...
	)

◆ bv_view_print()

void bv_view_print	(	const char *	title,
		struct bview *	v,
		int	verbosity
	)

◆ bv_set_init()

void bv_set_init ( struct bview_set * s )

Initialize an empty view set

◆ bv_set_free()

void bv_set_free ( struct bview_set * s )

Free view set

◆ bv_set_add_view()

void bv_set_add_view	(	struct bview_set *	s,
		struct bview *	v
	)

Add view v to set s, handling shared memory assignments.

◆ bv_set_rm_view()

void bv_set_rm_view	(	struct bview_set *	s,
		struct bview *	v
	)

Remove view v from set s. If v == NULL, all views are removed from the set.

◆ bv_set_views()

struct bu_ptbl * bv_set_views ( struct bview_set * s )

Return a bu_ptbl holding pointers to all views in set s

◆ bv_set_find_view()

struct bview * bv_set_find_view	(	struct bview_set *	s,
		const char *	vname
	)

Return a pointer to the view with name vname, if it is present in s. If not found, returns NULL

◆ bv_set_fsos()

struct bv_scene_obj * bv_set_fsos ( struct bview_set * s )

Files

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ BV_AUTOVIEW_SCALE_DEFAULT

◆ BV_KNOBS_ALL

◆ BV_KNOBS_RATE

◆ BV_KNOBS_ABS

◆ BV_IDLE

◆ BV_ROT

◆ BV_TRANS

◆ BV_SCALE

◆ BV_CENTER

◆ BV_CON_X

◆ BV_CON_Y

◆ BV_CON_Z

◆ BV_CON_GRID

◆ BV_CON_LINES

◆ BV_ENABLE_ENV_LOGGING

Function Documentation

◆ bv_init()

◆ bv_free()

◆ bv_mat_aet()

◆ bv_settings_init()

◆ bv_autoview()

◆ bv_sync()

◆ bv_obj_settings_sync()

◆ bv_update()

◆ bv_update_selected()

◆ bv_knobs_reset()

◆ bv_knobs_hash()

◆ bv_knobs_cmd_process()

◆ bv_knobs_rot()

◆ bv_knobs_tran()

◆ bv_update_rate_flags()

◆ bv_differ()

◆ bv_hash()

◆ bv_dl_hash()

◆ bv_clear()

◆ bv_adjust()

◆ bv_screen_to_view()

◆ bv_screen_pt()

◆ bv_scene_obj_bound()

◆ bv_vZ_calc()

◆ bv_obj_sync()

◆ bv_obj_stale()

◆ bv_obj_create()

◆ bv_obj_get()

◆ bv_obj_get_child()

◆ bv_obj_reset()

◆ bv_obj_put()

◆ bv_find_child()

◆ bv_find_obj()

◆ bv_uniq_obj_name()

◆ bv_obj_for_view()

◆ bv_obj_get_vo()

◆ bv_obj_have_vo()

◆ bv_clear_view_obj()

◆ bv_illum_obj()

◆ bv_view_objs()

◆ bv_view_plane()

◆ bv_log()

◆ bv_view_print()

◆ bv_set_init()

◆ bv_set_free()

◆ bv_set_add_view()

◆ bv_set_rm_view()

◆ bv_set_views()

◆ bv_set_find_view()

◆ bv_set_fsos()