layouts.h

Go to the documentation of this file.

#ifndef VIENNA_RNA_PACKAGE_PLOT_LAYOUTS_H
#define VIENNA_RNA_PACKAGE_PLOT_LAYOUTS_H

#ifdef VRNA_WARN_DEPRECATED
# if defined(__clang__)
#  define DEPRECATED(func, msg) func __attribute__ ((deprecated("", msg)))
# elif defined(__GNUC__)
#  define DEPRECATED(func, msg) func __attribute__ ((deprecated(msg)))
# else
#  define DEPRECATED(func, msg) func
# endif
#else
# define DEPRECATED(func, msg) func
#endif

#include <ViennaRNA/datastructures/basic.h>
#include <ViennaRNA/plotting/naview.h>
#include "ViennaRNA/plotting/RNApuzzler/RNAturtle.h"
#include "ViennaRNA/plotting/RNApuzzler/RNApuzzler.h"


typedef struct vrna_plot_layout_s vrna_plot_layout_t;


#define VRNA_PLOT_TYPE_SIMPLE     0

#define VRNA_PLOT_TYPE_NAVIEW     1

#define VRNA_PLOT_TYPE_CIRCULAR   2

#define VRNA_PLOT_TYPE_TURTLE  3

#define VRNA_PLOT_TYPE_PUZZLER  4


struct vrna_plot_layout_s {
  unsigned int  length;
  float         *x;
  float         *y;
  double        *arcs;
  int           bbox[4];
};


vrna_plot_layout_t *
vrna_plot_layout(const char   *structure,
                 unsigned int plot_type);


vrna_plot_layout_t *
vrna_plot_layout_simple(const char *structure);


vrna_plot_layout_t *
vrna_plot_layout_naview(const char *structure);


vrna_plot_layout_t *
vrna_plot_layout_circular(const char *structure);


vrna_plot_layout_t *
vrna_plot_layout_turtle(const char *structure);


vrna_plot_layout_t *
vrna_plot_layout_puzzler(const char                   *structure,
                         vrna_plot_options_puzzler_t  *options);


void
vrna_plot_layout_free(vrna_plot_layout_t *layout);


int
vrna_plot_coords(const char *structure,
                 float      **x,
                 float      **y,
                 int        plot_type);


int
vrna_plot_coords_pt(const short *pt,
                    float       **x,
                    float       **y,
                    int         plot_type);


int
vrna_plot_coords_simple(const char  *structure,
                        float       **x,
                        float       **y);


int
vrna_plot_coords_simple_pt(const short  *pt,
                           float        **x,
                           float        **y);


int
vrna_plot_coords_circular(const char  *structure,
                          float       **x,
                          float       **y);


int
vrna_plot_coords_circular_pt(const short  *pt,
                             float        **x,
                             float        **y);


#ifndef VRNA_DISABLE_BACKWARD_COMPATIBILITY

typedef struct {
  float X;  /* X coords */
  float Y;  /* Y coords */
} COORDINATE;


extern int rna_plot_type;


DEPRECATED(int
           simple_xy_coordinates(short  *pair_table,
                                 float  *X,
                                 float  *Y),
           "Use vrna_plot_coords_simple_pt() instead!");


DEPRECATED(int
           simple_circplot_coordinates(short  *pair_table,
                                       float  *x,
                                       float  *y),
           "Use vrna_plot_coords_circular_pt() instead!");


#endif


#endif