Coot Scripting Interface - Generic Objects interface. More...

Functions
Generic Objects
int	new_generic_object_number (const std::string &obj_name)
	create a new generic object with name objname More...

int	new_generic_object_number_for_molecule (const std::string &obj_name, int imol)
	create a new generic object with name objname and attach it to the given molecule More...

void	to_generic_object_add_line (int object_number, const char *colour, int line_width, float from_x1, float from_y1, float from_z1, float to_x2, float to_y2, float to_z2)
	add line to generic object object_number

void	to_generic_object_add_dashed_line (int object_number, const char *colour, int line_width, float dash_density, float from_x1, float from_y1, float from_z1, float to_x2, float to_y2, float to_z2)
	add a dashed line to generic object object_number More...

void	to_generic_object_add_point (int object_number, const char *colour, int point_width, float from_x1, float from_y1, float from_z1)
	add point to generic object object_number

void	to_generic_object_add_point_internal (int object_number, const std::string &colour_name, const coot::colour_holder &colour, int point_width, const clipper::Coord_orth &pt)

void	to_generic_object_add_arc (int object_number, const char *colour, float radius, float radius_inner, float from_angle, float to_angle, float start_point_x, float start_point_y, float start_point_z, float start_dir_x, float start_dir_y, float start_dir_z, float normal_x1, float normal_y1, float normal_z1)
	add point to generic object object_number

void	to_generic_object_add_dodecahedron (int object_number, const char *colour, float radius, float x, float y, float z)

void	to_generic_object_add_pentakis_dodecahedron (int object_number, const char *colour, float stellation_factor, float radius_factor, float x, float y, float z)

void	to_generic_object_add_display_list_handle (int object_number, int display_list_id)
	add a display list handle generic object

void	set_display_generic_object (int object_number, short int istate)
	set the display status of object number object_number, More...

void	set_display_generic_object_simple (int object_number, short int istate)
	set the display status of object number object_number, More...

int	generic_object_is_displayed_p (int object_number)
	is generic display object displayed? More...

int	generic_object_index (const std::string &name)
	return the index of the object with name name, if not, return -1;

SCM	generic_object_name_scm (int obj_number)
	what is the name of generic object number obj_number? More...

PyObject *	generic_object_name_py (unsigned int obj_number)

PyObject *	get_generic_object_py (unsigned int obj_number)

int	number_of_generic_objects ()
	return the number of generic display objects

void	generic_object_info ()
	print to the console the name and display status of the generic display objects

short int	generic_object_has_objects_p (int obj_no)
	does generic display object number obj_no have things to display? (predicate name) More...

void	close_generic_object (int object_number)
	close generic object, clear the lines/points etc, not available for buttons/displaying etc

short int	is_closed_generic_object_p (int object_number)
	has the generic object been closed? More...

void	generic_object_clear (int object_number)
	clear out the lines and points from object_number, but keep it displayable (not closed).

void	attach_generic_object_to_molecule (int obj_number, int imol)
	attach the generic object to a particular molecule More...

void	set_display_generic_objects_as_solid (int state)

Detailed Description

Coot Scripting Interface - Generic Objects interface.

Function Documentation

void attach_generic_object_to_molecule	(	int	obj_number,
		int	imol
	)

attach the generic object to a particular molecule

one might do this if the generic object is specific to a molecule.

short int generic_object_has_objects_p ( int obj_no )

does generic display object number obj_no have things to display? (predicate name)

Returns: 0 for no things, 1 for things.

int generic_object_is_displayed_p ( int object_number )

is generic display object displayed?

Returns: 1 for yes, otherwise 0

SCM generic_object_name_scm ( int obj_number )

what is the name of generic object number obj_number?

Returns: 0 (NULL) (scheme False) on obj_number not available

short int is_closed_generic_object_p ( int object_number )

has the generic object been closed?

Returns: 1 for yes, 0 othersize

int new_generic_object_number ( const std::string & obj_name )

create a new generic object with name objname

return the index of the object

int new_generic_object_number_for_molecule	(	const std::string &	obj_name,
		int	imol
	)

create a new generic object with name objname and attach it to the given molecule

Returns: the index of the object

void set_display_generic_object	(	int	object_number,
		short int	istate
	)

set the display status of object number object_number,

when they are created, by default objects are not displayed, so we generally need this function.

void set_display_generic_object_simple	(	int	object_number,
		short int	istate
	)

set the display status of object number object_number,

set the state of a generic object to be drawn, but no redraw. Use when enabling multiple generic objects.

void to_generic_object_add_dashed_line	(	int	object_number,
		const char *	colour,
		int	line_width,
		float	dash_density,
		float	from_x1,
		float	from_y1,
		float	from_z1,
		float	to_x2,
		float	to_y2,
		float	to_z2
	)

add a dashed line to generic object object_number

dash_density is number of dashes per Angstrom.

Functions

Detailed Description

Function Documentation