c-interface-generic-objects.h

Go to the documentation of this file.

/* src/c-interface-generic-objects/.cc
 * 
 * Copyright 2011 by the University of Oxford
 * Copyright 2016 by Medical Research Council
 * Author: Paul Emsley
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#include <string>

#include "generic-display-objects-c.h"


/*  ----------------------------------------------------------------------- */
/*                  Generic Objects                                         */
/*  ----------------------------------------------------------------------- */
/* \{ */

int new_generic_object_number(const std::string &obj_name);

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

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);

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); 

void to_generic_object_add_point(int object_number,
                                 const char *colour,
                                 int point_width,
                                 float from_x1,
                                 float from_y1,
                                 float from_z1);

#ifndef SWIG
void to_generic_object_add_point_internal(int object_number,
                                 const std::string &colour_name, // needed for indexing objects by colour
                                 const coot::colour_holder &colour,
                                 int point_width,
                                 const clipper::Coord_orth &pt);
#endif // SWIG

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);

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); 

void set_display_generic_object(int object_number, short int istate);

void set_display_generic_object_simple(int object_number, short int istate);


int generic_object_is_displayed_p(int object_number);

int generic_object_index(const std::string &name);

#ifdef __cplusplus
#ifdef USE_GUILE
SCM generic_object_name_scm(int obj_number);
#endif /* USE_GUILE */
#ifdef USE_PYTHON
PyObject *generic_object_name_py(unsigned int obj_number);
PyObject *get_generic_object_py(unsigned int obj_number);
#endif /* USE_PYTHON */
#endif /*  __cplusplus */

int number_of_generic_objects();

void generic_object_info(); 

short int generic_object_has_objects_p(int obj_no); 

void close_generic_object(int object_number);

short int is_closed_generic_object_p(int object_number);

void generic_object_clear(int object_number);

void attach_generic_object_to_molecule(int obj_number, int imol);

void set_display_generic_objects_as_solid(int state);


/* \} */