Graphical Elements - C API¶

elem_color¶: Used to express colors in RGBA format. Corresponds to an unsigned 32 bit integer type. The R, G, B and A corresponds respectively to the red, green, blue and alpha channel and each takes 8 bit. The alpha channel controls the transparency and its values corresponds to zero for completely transparent and 255, 0xff in hexadecimal, for completely opaque. The color can be given directly in hexadecimal format like, for example, 0x00ff00ff for green.

Color constants¶

The library provides a few color constants listed below.

color_red¶

color_blue¶

color_green¶

color_yellow¶

color_black¶

color_gray¶

color_white¶

color_none¶

Drawing Properties¶

The following are used when adding an element into a plot to specify if should be stroked, filled or possibly both. In addition some properties affect the way the object will be drawn on the screen. The values are meant tb be combined using logical bit operators.

elem_fill¶: Draw each closed polygon with a filling color.

elem_stroke¶: Draw the stroking of the path or contour.

elem_outline¶: Only the outline of the path will be drawn, without anti-aliasing.

elem_crisp¶

Graphics objects types and functions¶

elem_object¶: A graphical element that can be added to a plot. An instance of the elem_object cannot be directly created but it is the base class of other elements like, for example, a elem_path.

elem_path¶

A graphical path that can contain polygonal paths, open or closed. Can be cast into an object using the function path_as_object().

elem_path *elem_path_new()¶: Create a new empty path.

void elem_path_move_to(elem_path *path, double x, double y)¶: Move the path to the given location without a connecting line.

void elem_path_line_to(elem_path *path, double x, double y)¶: Add a straight line segment up to the given location.

void elem_path_close_polygon(elem_path *path)¶: Close the current polygon.

elem_object *path_as_object(elem_path *path)¶: This function is used to cast a pointer to elem_path into a pointer to elem_object in a type-safe way.

elem_curve¶

A graphical path similar to the elem_path but can additionally contain Bézier and elliptical arcs. More details about how exactly the arcs are drawn can be found from the official SVG documentation on Paths.

Please note that the elem_curve class does not inherit from elem_path even if it implements all the methods of the latter. This is due to the their internal representation.

elem_curve *elem_curve_new()¶: Create an new empty path that can contain Bézier and elliptic arcs.

elem_curve *elem_curve_copy(const elem_curve *source)¶: Create a copy of the elem_curve object.

void elem_curve_move_to(elem_curve *curve, double x, double y)¶: Move the path to the given location without a connecting line.

void elem_curve_line_to(elem_curve *curve, double x, double y)¶: Add a straight line segment up to the given location.

void elem_curve_curve3(elem_curve *curve, double x_ctrl, double y_ctrl, double x_to, double y_to)¶: Add a quadratic Bézier curve up to the point (x_to, y_to) with control point (x_ctrl, y_ctrl).

void elem_curve_curve4(elem_curve *curve, double x_ctrl1, double y_ctrl1, double x_ctrl2, double y_ctrl2, double x_to, double y_to)¶: Add a cubic Bézier curve up to the point (x_to, y_to) with control points (x_ctrl1, y_ctrl1) and (x_ctrl2, y_ctrl2).

elem_curve_arc_to(elem_curve *curve, double rx, double ry, double angle, bool large_arc_flag, bool sweep_flag, double x, double y)¶

Add an elliptical path up to the point (x, y). The other parameters are:

(rx, ry), x and y radius of the ellipse.
angle, rotation angle of the ellipse’s x axis.
large_arc_flag, if a large angle or small angle arc should be chosen.
bool sweep_flag, if the arc should be drawn in the sense of increasing angles.

void elem_curve_close_polygon()¶: Close the current polygon.

elem_markers¶

Like a path but instead of drawing a path it draws a marker at each vertex of the path.

elem_markers *elem_markers_new(double size, elem_object marker_symbol)¶: Create an empty Markers path that will draw markers of the specified size, in pixels, and using an object marker_symbol as a marker. The marker symbol should be an object that span a rectangular area of unit side and centered on zero.

elem_markers *elem_markers_copy(const elem_markers *markers)¶: Create a copy of an object of type canavs_markers.

void elem_markers_free(anvas_markers *markers)¶: Free an object of type c:type:canavs_markers.

elem_object *elem_marker_symbol_by_index(int index)¶: Returns a marker symbol from a standard list of symbol. The symbol is selected by the integer argument.

elem_object *elem_marker_symbol_by_name(const char *name)¶: Returns a marker symbol from a standard list of symbol. The symbol is selected by name.

class Text : public elem_object¶

An object that draws a text label. It is meant to be drawn with a fill color, without stroking.

Text(const char *text, double size = 10.0, double hjustif = 0.0, double vjustif = 0.0)¶: Create a text object with the given text. The size corresponds to the text size in pixel. The other parameters represents the horizontal and vertical justification. For the horizontal 0.0 corresponds to left justification and 1.0 to right justification. For the vertical 0.0 corresponds to alignment on the text’s bottom line and 1.0 to the text’s top line.

void SetAngle(double angle)¶: Set the angle, in radians, for the text orientation.

void SetPosition(double x, double y)¶: Set the position of the text.

class DashPath : public elem_path¶

A path object but it will be drawn as a dashed lines.

DashPath(std::initializer_list<double> lst)¶: Create a dashed path with the length of the dash and the gap given by the initializer list. The given lengths will be used for dashing in the screen coordinates space. The number of elements of the initializer list should be a multiple of two so that the elements represents consecutively the length of the dash and the following gap.

void AddDash(double a, double b)¶: Add a dash length and gap after the creation of the object.