libDXF 0.0.1
A library with DXF related functions written in C.
Data Structures | Typedefs | Functions

helix.h File Reference

Header file for a DXF helix entity (HELIX). More...

#include "global.h"
#include "spline.h"
#include "binary_graphics_data.h"
#include "point.h"
Include dependency graph for helix.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  dxf_helix_struct
 Definition of an AutoCAD helix entity (HELIX). More...

Typedefs

typedef struct dxf_helix_struct DxfHelix
 Definition of an AutoCAD helix entity (HELIX).

Functions

DxfHelixdxf_helix_new ()
 Allocate memory for a DXF HELIX.
DxfHelixdxf_helix_init (DxfHelix *helix)
 Allocate memory and initialize data fields in a DXF HELIX entity.
DxfHelixdxf_helix_read (DxfFile *fp, DxfHelix *helix)
 Read data from a DXF file into a DXF HELIX entity.
int dxf_helix_write (DxfFile *fp, DxfHelix *helix)
 Write DXF output for a DXF HELIX entity.
int dxf_helix_free (DxfHelix *helix)
 Free the allocated memory for a DXF HELIX and all it's data fields.
void dxf_helix_free_chain (DxfHelix *helices)
 Free the allocated memory for a chain of DXF HELIX entities and all their data fields.
int dxf_helix_get_id_code (DxfHelix *helix)
 Get the id_code from a DXF HELIX entity.
DxfHelixdxf_helix_set_id_code (DxfHelix *helix, int id_code)
 Set the id_code for a DXF HELIX entity.
char * dxf_helix_get_linetype (DxfHelix *helix)
 Get the linetype from a DXF HELIX entity.
DxfHelixdxf_helix_set_linetype (DxfHelix *helix, char *linetype)
 Set the linetype for a DXF HELIX entity.
char * dxf_helix_get_layer (DxfHelix *helix)
 Get the layer from a DXF HELIX entity.
DxfHelixdxf_helix_set_layer (DxfHelix *helix, char *layer)
 Set the layer for a DXF HELIX entity.
double dxf_helix_get_thickness (DxfHelix *helix)
 Get the thickness from a DXF HELIX entity.
DxfHelixdxf_helix_set_thickness (DxfHelix *helix, double thickness)
 Set the thickness for a DXF HELIX entity.
double dxf_helix_get_linetype_scale (DxfHelix *helix)
 Get the linetype_scale from a DXF HELIX entity.
DxfHelixdxf_helix_set_linetype_scale (DxfHelix *helix, double linetype_scale)
 Set the linetype_scale for a DXF HELIX entity.
int16_t dxf_helix_get_visibility (DxfHelix *helix)
 Get the visibility from a DXF HELIX entity.
DxfHelixdxf_helix_set_visibility (DxfHelix *helix, int16_t visibility)
 Set the visibility for a DXF HELIX entity.
int dxf_helix_get_color (DxfHelix *helix)
 Get the color from a DXF HELIX entity.
DxfHelixdxf_helix_set_color (DxfHelix *helix, int color)
 Set the color for a DXF HELIX entity.
int dxf_helix_get_paperspace (DxfHelix *helix)
 Get the paperspace flag value from a DXF HELIX entity.
DxfHelixdxf_helix_set_paperspace (DxfHelix *helix, int paperspace)
 Set the paperspace flag for a DXF HELIX entity.
int dxf_helix_get_graphics_data_size (DxfHelix *helix)
 Get the graphics_data_size value from a DXF HELIX entity.
DxfHelixdxf_helix_set_graphics_data_size (DxfHelix *helix, int graphics_data_size)
 Set the graphics_data_size value for a DXF HELIX entity.
int16_t dxf_helix_get_shadow_mode (DxfHelix *helix)
 Get the shadow_mode from a DXF HELIX entity.
DxfHelixdxf_helix_set_shadow_mode (DxfHelix *helix, int16_t shadow_mode)
 Set the shadow_mode for a DXF HELIX entity.
DxfBinaryGraphicsDatadxf_helix_get_binary_graphics_data (DxfHelix *helix)
 Get the pointer to the binary graphics data from a DXF HELIX entity.
DxfHelixdxf_helix_set_binary_graphics_data (DxfHelix *helix, DxfBinaryGraphicsData *data)
 Set the pointer to the binary_graphics_data for a DXF HELIX entity.
char * dxf_helix_get_dictionary_owner_soft (DxfHelix *helix)
 Get the pointer to the dictionary_owner_soft from a DXF HELIX entity.
DxfHelixdxf_helix_set_dictionary_owner_soft (DxfHelix *helix, char *dictionary_owner_soft)
 Set the pointer to the dictionary_owner_soft for a DXF HELIX entity.
char * dxf_helix_get_material (DxfHelix *helix)
 Get the pointer to the material from a DXF HELIX entity.
DxfHelixdxf_helix_set_material (DxfHelix *helix, char *material)
 Set the pointer to the material for a DXF HELIX entity.
char * dxf_helix_get_dictionary_owner_hard (DxfHelix *helix)
 Get the pointer to the dictionary_owner_hard from a DXF HELIX entity.
DxfHelixdxf_helix_set_dictionary_owner_hard (DxfHelix *helix, char *dictionary_owner_hard)
 Set the pointer to the dictionary_owner_hard for a DXF HELIX entity.
int16_t dxf_helix_get_lineweight (DxfHelix *helix)
 Get the lineweight from a DXF HELIX entity.
DxfHelixdxf_helix_set_lineweight (DxfHelix *helix, int16_t lineweight)
 Set the lineweight for a DXF HELIX entity.
char * dxf_helix_get_plot_style_name (DxfHelix *helix)
 Get the plot_style_name from a DXF HELIX entity.
DxfHelixdxf_helix_set_plot_style_name (DxfHelix *helix, char *plot_style_name)
 Set the plot_style_name for a DXF HELIX entity.
long dxf_helix_get_color_value (DxfHelix *helix)
 Get the color_value from a DXF HELIX entity.
DxfHelixdxf_helix_set_color_value (DxfHelix *helix, long color_value)
 Set the color_value for a DXF HELIX entity.
char * dxf_helix_get_color_name (DxfHelix *helix)
 Get the color_name from a DXF HELIX entity.
DxfHelixdxf_helix_set_color_name (DxfHelix *helix, char *color_name)
 Set the color_name for a DXF HELIX entity.
long dxf_helix_get_transparency (DxfHelix *helix)
 Get the transparency from a DXF HELIX entity.
DxfHelixdxf_helix_set_transparency (DxfHelix *helix, long transparency)
 Set the transparency for a DXF HELIX entity.
DxfPointdxf_helix_get_p0 (DxfHelix *helix)
 Get the axis base point p0 from a DXF HELIX entity.
DxfHelixdxf_helix_set_p0 (DxfHelix *helix, DxfPoint *p0)
 Set the axis base point p0 for a DXF HELIX entity.
double dxf_helix_get_x0 (DxfHelix *helix)
 Get the axis base point X-value x0 from a DXF HELIX.
DxfHelixdxf_helix_set_x0 (DxfHelix *helix, double x0)
 Set the axis base point X-value x0 for a DXF HELIX.
double dxf_helix_get_y0 (DxfHelix *helix)
 Get the axis base point Y-value y0 from a DXF HELIX.
DxfHelixdxf_helix_set_y0 (DxfHelix *helix, double y0)
 Set the axis base point Y-value y0 for a DXF HELIX.
double dxf_helix_get_z0 (DxfHelix *helix)
 Get the axis base point Z-value z0 from a DXF HELIX.
DxfHelixdxf_helix_set_z0 (DxfHelix *helix, double z0)
 Set the axis base point Z-value z0 for a DXF HELIX.
DxfPointdxf_helix_get_p1 (DxfHelix *helix)
 Get the start point p1 from a DXF HELIX entity.
DxfHelixdxf_helix_set_p1 (DxfHelix *helix, DxfPoint *p1)
 Set the start point p1 for a DXF HELIX entity.
double dxf_helix_get_x1 (DxfHelix *helix)
 Get the start point X-value x1 from a DXF HELIX.
DxfHelixdxf_helix_set_x1 (DxfHelix *helix, double x1)
 Set the start point X-value x1 for a DXF HELIX.
double dxf_helix_get_y1 (DxfHelix *helix)
 Get the start point Y-value y1 from a DXF HELIX.
DxfHelixdxf_helix_set_y1 (DxfHelix *helix, double y1)
 Set the start point Y-value y1 for a DXF HELIX.
double dxf_helix_get_z1 (DxfHelix *helix)
 Get the start point Z-value z1 from a DXF HELIX.
DxfHelixdxf_helix_set_z1 (DxfHelix *helix, double z1)
 Set the start point Z-value z1 for a DXF HELIX.
DxfPointdxf_helix_get_p2 (DxfHelix *helix)
 Get the axis vector point p2 from a DXF HELIX entity.
DxfHelixdxf_helix_set_p2 (DxfHelix *helix, DxfPoint *p2)
 Set the axis vector point p2 for a DXF HELIX entity.
double dxf_helix_get_x2 (DxfHelix *helix)
 Get the axis vector point X-value x2 from a DXF HELIX.
DxfHelixdxf_helix_set_x2 (DxfHelix *helix, double x2)
 Set the axis vector point X-value x2 for a DXF HELIX.
double dxf_helix_get_y2 (DxfHelix *helix)
 Get the axis vector point Y-value y2 from a DXF HELIX.
DxfHelixdxf_helix_set_y2 (DxfHelix *helix, double y2)
 Set the axis vector point Y-value y2 for a DXF HELIX.
double dxf_helix_get_z2 (DxfHelix *helix)
 Get the axis vector point Z-value z2 from a DXF HELIX.
DxfHelixdxf_helix_set_z2 (DxfHelix *helix, double z2)
 Set the axis vector point Z-value z2 for a DXF HELIX.
double dxf_helix_get_radius (DxfHelix *helix)
 Get the radius from a DXF HELIX entity.
DxfHelixdxf_helix_set_radius (DxfHelix *helix, double radius)
 Set the radius for a DXF HELIX.
double dxf_helix_get_number_of_turns (DxfHelix *helix)
 Get the number_of_turns from a DXF HELIX entity.
DxfHelixdxf_helix_set_number_of_turns (DxfHelix *helix, double number_of_turns)
 Set the number_of_turns for a DXF HELIX.
double dxf_helix_get_turn_height (DxfHelix *helix)
 Get the turn_height from a DXF HELIX entity.
DxfHelixdxf_helix_set_turn_height (DxfHelix *helix, double turn_height)
 Set the turn_height for a DXF HELIX.
long dxf_helix_get_major_release_number (DxfHelix *helix)
 Get the major_release_number from a DXF HELIX entity.
DxfHelixdxf_helix_set_major_release_number (DxfHelix *helix, long major_release_number)
 Set the major_release_number for a DXF HELIX.
long dxf_helix_get_maintainance_release_number (DxfHelix *helix)
 Get the maintainance_release_number from a DXF HELIX entity.
DxfHelixdxf_helix_set_maintainance_release_number (DxfHelix *helix, long maintainance_release_number)
 Set the maintainance_release_number for a DXF HELIX.
int dxf_helix_get_constraint_type (DxfHelix *helix)
 Get the constraint_type from a DXF HELIX.
DxfHelixdxf_helix_set_constraint_type (DxfHelix *helix, int constraint_type)
 Set the constraint_type for a DXF HELIX.
int dxf_helix_get_handedness (DxfHelix *helix)
 Get the handedness from a DXF HELIX.
DxfHelixdxf_helix_set_handedness (DxfHelix *helix, int handedness)
 Set the handedness for a DXF HELIX.
DxfSplinedxf_helix_get_spline (DxfHelix *helix)
 Get the spline from a DXF HELIX.
DxfHelixdxf_helix_set_spline (DxfHelix *helix, DxfSpline *spline)
 Set the spline for a DXF HELIX.
DxfHelixdxf_helix_get_next (DxfHelix *helix)
 Get the pointer to the next HELIX entity from a DXF HELIX entity.
DxfHelixdxf_helix_set_next (DxfHelix *helix, DxfHelix *next)
 Set the pointer to the next HELIX for a DXF HELIX entity.
DxfHelixdxf_helix_get_last (DxfHelix *helix)
 Get the pointer to the last HELIX entity from a linked list of DXF HELIX entity.

Detailed Description

Header file for a DXF helix entity (HELIX).

Author:
Copyright (C) 2013, 2014, 2015, 2016, 2017 by Bert Timmerman <bert.timmerman@xs4all.nl>.

Copyright Notices.


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 2 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:
Free Software Foundation, Inc.,
59 Temple Place,
Suite 330,
Boston,
MA 02111 USA.

Drawing eXchange Format (DXF) is a defacto industry standard for the exchange of drawing files between various Computer Aided Drafting programs.
DXF is an industry standard designed by Autodesk(TM).
For more details see http://www.autodesk.com.


Definition in file helix.h.


Typedef Documentation

typedef struct dxf_helix_struct DxfHelix

Definition of an AutoCAD helix entity (HELIX).


Function Documentation

DxfHelix* dxf_helix_new ( )

Allocate memory for a DXF HELIX.

Fill the memory contents with zeros.

Returns:
NULL when no memory was allocated, a pointer to the allocated memory when succesful.

Definition at line 50 of file helix.c.

References _, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_helix_init(), and dxf_helix_read().

DxfHelix* dxf_helix_init ( DxfHelix helix)
DxfHelix* dxf_helix_read ( DxfFile fp,
DxfHelix helix 
)

Read data from a DXF file into a DXF HELIX entity.

The last line read from file contained the string "HELIX".
Now follows some data for the HELIX, to be terminated with a " 0" string announcing the following entity, or the end of the ENTITY section marker ENDSEC.
While parsing the DXF file store data in helix.

Returns:
a pointer to helix when successful, NULL when an error occurred.
Parameters:
fpDXF file pointer to an input file (or device).
helixDXF HELIX entity.

Definition at line 163 of file helix.c.

References _, dxf_helix_struct::binary_graphics_data, dxf_helix_struct::color, dxf_helix_struct::color_name, dxf_helix_struct::color_value, dxf_helix_struct::constraint_type, dxf_binary_graphics_data_struct::data_line, dxf_helix_struct::dictionary_owner_hard, dxf_helix_struct::dictionary_owner_soft, dxf_binary_graphics_data_init(), DXF_DEBUG_BEGIN, DXF_DEBUG_END, DXF_DEFAULT_LAYER, DXF_DEFAULT_LINETYPE, dxf_helix_init(), dxf_helix_new(), dxf_spline_read(), dxf_file_struct::filename, dxf_file_struct::fp, dxf_helix_struct::graphics_data_size, dxf_helix_struct::handedness, dxf_helix_struct::id_code, dxf_helix_struct::layer, dxf_file_struct::line_number, dxf_helix_struct::linetype, dxf_helix_struct::linetype_scale, dxf_helix_struct::lineweight, dxf_helix_struct::maintainance_release_number, dxf_helix_struct::major_release_number, dxf_helix_struct::material, dxf_binary_graphics_data_struct::next, dxf_helix_struct::number_of_turns, dxf_helix_struct::p0, dxf_helix_struct::p1, dxf_helix_struct::p2, dxf_helix_struct::paperspace, dxf_helix_struct::plot_style_name, dxf_helix_struct::radius, dxf_helix_struct::shadow_mode, dxf_helix_struct::spline, dxf_helix_struct::thickness, dxf_helix_struct::transparency, dxf_helix_struct::turn_height, dxf_helix_struct::visibility, dxf_point_struct::x0, dxf_point_struct::y0, and dxf_point_struct::z0.

Here is the call graph for this function:

int dxf_helix_write ( DxfFile fp,
DxfHelix helix 
)

Write DXF output for a DXF HELIX entity.

Returns:
EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.

Todo:
implement as a single linked list of double.
Todo:
implement as a single linked list of double.

Parameters:
fpDXF file pointer to an output file (or device).
helixDXF HELIX entity.

Definition at line 519 of file helix.c.

References _, dxf_file_struct::acad_version_number, AutoCAD_2007, dxf_helix_struct::binary_graphics_data, dxf_helix_struct::color, dxf_helix_struct::color_name, dxf_helix_struct::color_value, dxf_helix_struct::constraint_type, dxf_spline_struct::control_point_tolerance, dxf_binary_graphics_data_struct::data_line, dxf_spline_struct::degree, dxf_helix_struct::dictionary_owner_soft, dxf_binary_graphics_data_get_next(), DXF_COLOR_BYLAYER, DXF_DEBUG_BEGIN, DXF_DEBUG_END, DXF_DEFAULT_LAYER, DXF_DEFAULT_LINETYPE, DXF_MODELSPACE, DXF_PAPERSPACE, dxf_spline_struct::flag, dxf_file_struct::fp, dxf_helix_struct::graphics_data_size, dxf_helix_struct::handedness, dxf_helix_struct::id_code, dxf_spline_struct::knot_tolerance, dxf_spline_struct::knot_value, dxf_helix_struct::layer, dxf_helix_struct::linetype, dxf_helix_struct::linetype_scale, dxf_helix_struct::lineweight, dxf_helix_struct::maintainance_release_number, dxf_helix_struct::major_release_number, dxf_helix_struct::material, dxf_point_struct::next, dxf_spline_struct::number_of_control_points, dxf_spline_struct::number_of_fit_points, dxf_spline_struct::number_of_knots, dxf_helix_struct::number_of_turns, dxf_helix_struct::p0, dxf_spline_struct::p0, dxf_helix_struct::p1, dxf_spline_struct::p1, dxf_helix_struct::p2, dxf_spline_struct::p2, dxf_spline_struct::p3, dxf_helix_struct::paperspace, dxf_helix_struct::plot_style_name, dxf_helix_struct::radius, dxf_helix_struct::shadow_mode, dxf_helix_struct::spline, dxf_helix_struct::thickness, dxf_helix_struct::transparency, dxf_helix_struct::turn_height, dxf_double_struct::value, dxf_helix_struct::visibility, dxf_spline_struct::weight_value, dxf_point_struct::x0, dxf_point_struct::y0, and dxf_point_struct::z0.

Here is the call graph for this function:

int dxf_helix_free ( DxfHelix helix)

Free the allocated memory for a DXF HELIX and all it's data fields.

Returns:
EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.
Parameters:
helixPointer to the memory occupied by the DXF HELIX entity.

Definition at line 721 of file helix.c.

References _, dxf_binary_graphics_data_free_chain(), DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_get_binary_graphics_data(), dxf_helix_get_color_name(), dxf_helix_get_dictionary_owner_hard(), dxf_helix_get_dictionary_owner_soft(), dxf_helix_get_layer(), dxf_helix_get_linetype(), dxf_helix_get_material(), dxf_helix_get_p0(), dxf_helix_get_p1(), dxf_helix_get_p2(), dxf_helix_get_plot_style_name(), dxf_point_free(), and dxf_helix_struct::next.

Referenced by dxf_helix_free_chain().

Here is the call graph for this function:

void dxf_helix_free_chain ( DxfHelix helices)

Free the allocated memory for a chain of DXF HELIX entities and all their data fields.

Parameters:
helicespointer to the first entry in a chain of DXF HELIX entities.

Definition at line 771 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_free(), and dxf_helix_struct::next.

Here is the call graph for this function:

int dxf_helix_get_id_code ( DxfHelix helix)

Get the id_code from a DXF HELIX entity.

Returns:
id_code when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 806 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::id_code.

DxfHelix* dxf_helix_set_id_code ( DxfHelix helix,
int  id_code 
)

Set the id_code for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
id_codeIdentification number for the entity.
This is to be an unique (sequential) number in the DXF file.

Definition at line 844 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::id_code.

char* dxf_helix_get_linetype ( DxfHelix helix)

Get the linetype from a DXF HELIX entity.

Returns:
linetype when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 886 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::linetype.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_linetype ( DxfHelix helix,
char *  linetype 
)

Set the linetype for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
linetypea string containing the linetype for the entity.

Definition at line 924 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::linetype.

char* dxf_helix_get_layer ( DxfHelix helix)

Get the layer from a DXF HELIX entity.

Returns:
layer when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 964 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::layer.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_layer ( DxfHelix helix,
char *  layer 
)

Set the layer for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
layera string containing the layer for the entity.

Definition at line 1002 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::layer.

double dxf_helix_get_thickness ( DxfHelix helix)

Get the thickness from a DXF HELIX entity.

Returns:
thickness when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1043 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::thickness.

DxfHelix* dxf_helix_set_thickness ( DxfHelix helix,
double  thickness 
)

Set the thickness for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
thicknessthe thickness to be set for the entity.

Definition at line 1080 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::thickness.

double dxf_helix_get_linetype_scale ( DxfHelix helix)

Get the linetype_scale from a DXF HELIX entity.

Returns:
linetype_scale when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1120 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::linetype_scale.

DxfHelix* dxf_helix_set_linetype_scale ( DxfHelix helix,
double  linetype_scale 
)

Set the linetype_scale for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
linetype_scalethe linetype_scale to be set for the entity.

Definition at line 1158 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::linetype_scale.

int16_t dxf_helix_get_visibility ( DxfHelix helix)

Get the visibility from a DXF HELIX entity.

Returns:
visibility when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1199 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::visibility.

DxfHelix* dxf_helix_set_visibility ( DxfHelix helix,
int16_t  visibility 
)

Set the visibility for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
visibilitythe visibility to be set for the entity.

Definition at line 1244 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::visibility.

int dxf_helix_get_color ( DxfHelix helix)

Get the color from a DXF HELIX entity.

Returns:
color when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1292 of file helix.c.

References _, dxf_helix_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfHelix* dxf_helix_set_color ( DxfHelix helix,
int  color 
)

Set the color for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
colorthe color to be set for the entity.

Definition at line 1329 of file helix.c.

References _, dxf_helix_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_helix_get_paperspace ( DxfHelix helix)

Get the paperspace flag value from a DXF HELIX entity.

Returns:
paperspace flag value when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1371 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::paperspace.

DxfHelix* dxf_helix_set_paperspace ( DxfHelix helix,
int  paperspace 
)

Set the paperspace flag for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
paperspacethe paperspace flag value to be set for the entity.

Definition at line 1414 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::paperspace.

int dxf_helix_get_graphics_data_size ( DxfHelix helix)

Get the graphics_data_size value from a DXF HELIX entity.

Returns:
graphics_data_size value when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1463 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::graphics_data_size.

DxfHelix* dxf_helix_set_graphics_data_size ( DxfHelix helix,
int  graphics_data_size 
)

Set the graphics_data_size value for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
graphics_data_sizethe graphics_data_size value to be set for the entity.

Definition at line 1506 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::graphics_data_size.

int16_t dxf_helix_get_shadow_mode ( DxfHelix helix)

Get the shadow_mode from a DXF HELIX entity.

Returns:
shadow_mode when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1555 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::shadow_mode.

DxfHelix* dxf_helix_set_shadow_mode ( DxfHelix helix,
int16_t  shadow_mode 
)

Set the shadow_mode for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
shadow_modethe shadow mode to be set for the entity.

Definition at line 1600 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::shadow_mode.

DxfBinaryGraphicsData* dxf_helix_get_binary_graphics_data ( DxfHelix helix)

Get the pointer to the binary graphics data from a DXF HELIX entity.

Returns:
pointer to the binary graphics data.
Warning:
No checks are performed on the returned pointer.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1650 of file helix.c.

References _, dxf_helix_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_binary_graphics_data ( DxfHelix helix,
DxfBinaryGraphicsData data 
)

Set the pointer to the binary_graphics_data for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
dataa string containing the pointer to the binary_graphics_data for the entity.

Definition at line 1689 of file helix.c.

References _, dxf_helix_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_helix_get_dictionary_owner_soft ( DxfHelix helix)

Get the pointer to the dictionary_owner_soft from a DXF HELIX entity.

Returns:
pointer to the dictionary_owner_soft, or NULL when an error occurred.
Warning:
No checks are performed on the returned pointer (string).
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1734 of file helix.c.

References _, dxf_helix_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_dictionary_owner_soft ( DxfHelix helix,
char *  dictionary_owner_soft 
)

Set the pointer to the dictionary_owner_soft for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
dictionary_owner_softa string containing the pointer to the dictionary_owner_soft for the entity.

Definition at line 1773 of file helix.c.

References _, dxf_helix_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_helix_get_material ( DxfHelix helix)

Get the pointer to the material from a DXF HELIX entity.

Returns:
a pointer to material when successful, or NULL when an error occurred.
Warning:
No checks are performed on the returned pointer.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1817 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::material.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_material ( DxfHelix helix,
char *  material 
)

Set the pointer to the material for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
materiala string containing the pointer to the material for the entity.

Definition at line 1855 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::material.

char* dxf_helix_get_dictionary_owner_hard ( DxfHelix helix)

Get the pointer to the dictionary_owner_hard from a DXF HELIX entity.

Returns:
a pointer to dictionary_owner_hard when successful, or NULL when an error occurred.
Warning:
No checks are performed on the returned pointer.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1900 of file helix.c.

References _, dxf_helix_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_dictionary_owner_hard ( DxfHelix helix,
char *  dictionary_owner_hard 
)

Set the pointer to the dictionary_owner_hard for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
dictionary_owner_harda string containing the pointer to the dictionary_owner_hard for the entity.

Definition at line 1939 of file helix.c.

References _, dxf_helix_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int16_t dxf_helix_get_lineweight ( DxfHelix helix)

Get the lineweight from a DXF HELIX entity.

Returns:
lineweight when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 1981 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::lineweight.

DxfHelix* dxf_helix_set_lineweight ( DxfHelix helix,
int16_t  lineweight 
)

Set the lineweight for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
lineweightthe lineweight to be set for the entity.

Definition at line 2012 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::lineweight.

char* dxf_helix_get_plot_style_name ( DxfHelix helix)

Get the plot_style_name from a DXF HELIX entity.

Returns:
plot_style_name when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2046 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::plot_style_name.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_plot_style_name ( DxfHelix helix,
char *  plot_style_name 
)

Set the plot_style_name for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
plot_style_namea string containing the plot_style_name for the entity.

Definition at line 2084 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::plot_style_name.

long dxf_helix_get_color_value ( DxfHelix helix)

Get the color_value from a DXF HELIX entity.

Returns:
color_value when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2126 of file helix.c.

References _, dxf_helix_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfHelix* dxf_helix_set_color_value ( DxfHelix helix,
long  color_value 
)

Set the color_value for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
color_valuethe color_value to be set for the entity.

Definition at line 2157 of file helix.c.

References _, dxf_helix_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_helix_get_color_name ( DxfHelix helix)

Get the color_name from a DXF HELIX entity.

Returns:
color_name when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2191 of file helix.c.

References _, dxf_helix_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_color_name ( DxfHelix helix,
char *  color_name 
)

Set the color_name for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
color_namea string containing the color_name for the entity.

Definition at line 2229 of file helix.c.

References _, dxf_helix_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

long dxf_helix_get_transparency ( DxfHelix helix)

Get the transparency from a DXF HELIX entity.

Returns:
transparency when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2271 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::transparency.

DxfHelix* dxf_helix_set_transparency ( DxfHelix helix,
long  transparency 
)

Set the transparency for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
transparencythe transparency to be set for the entity.

Definition at line 2302 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::transparency.

DxfPoint* dxf_helix_get_p0 ( DxfHelix helix)

Get the axis base point p0 from a DXF HELIX entity.

Returns:
axis base point p0 when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2336 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p0.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_p0 ( DxfHelix helix,
DxfPoint p0 
)

Set the axis base point p0 for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
p0an axis base point p0 for the * entity.

Definition at line 2374 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p0.

double dxf_helix_get_x0 ( DxfHelix helix)

Get the axis base point X-value x0 from a DXF HELIX.

Returns:
axis base point X-value x0 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2415 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::x0.

DxfHelix* dxf_helix_set_x0 ( DxfHelix helix,
double  x0 
)

Set the axis base point X-value x0 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
x0the axis base point X-value x0 to be set for the entity.

Definition at line 2446 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::x0.

double dxf_helix_get_y0 ( DxfHelix helix)

Get the axis base point Y-value y0 from a DXF HELIX.

Returns:
axis base point Y-value y0 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2481 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::y0.

DxfHelix* dxf_helix_set_y0 ( DxfHelix helix,
double  y0 
)

Set the axis base point Y-value y0 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
y0the axis base point Y-value y0 to be set for the entity.

Definition at line 2512 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::y0.

double dxf_helix_get_z0 ( DxfHelix helix)

Get the axis base point Z-value z0 from a DXF HELIX.

Returns:
axis base point Z-value z0 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2547 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::z0.

DxfHelix* dxf_helix_set_z0 ( DxfHelix helix,
double  z0 
)

Set the axis base point Z-value z0 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
z0the axis base point Z-value z0 to be set for the entity.

Definition at line 2578 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p0, and dxf_point_struct::z0.

DxfPoint* dxf_helix_get_p1 ( DxfHelix helix)

Get the start point p1 from a DXF HELIX entity.

Returns:
start point p1 when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2613 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p1.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_p1 ( DxfHelix helix,
DxfPoint p1 
)

Set the start point p1 for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
p1a start point p1 for the * entity.

Definition at line 2651 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p1.

double dxf_helix_get_x1 ( DxfHelix helix)

Get the start point X-value x1 from a DXF HELIX.

Returns:
start point X-value x1 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2692 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::x0.

DxfHelix* dxf_helix_set_x1 ( DxfHelix helix,
double  x1 
)

Set the start point X-value x1 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
x1the start point X-value x1 to be set for the entity.

Definition at line 2723 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::x0.

double dxf_helix_get_y1 ( DxfHelix helix)

Get the start point Y-value y1 from a DXF HELIX.

Returns:
start point Y-value y1 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2758 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::y0.

DxfHelix* dxf_helix_set_y1 ( DxfHelix helix,
double  y1 
)

Set the start point Y-value y1 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
y1the start point Y-value y1 to be set for the entity.

Definition at line 2789 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::y0.

double dxf_helix_get_z1 ( DxfHelix helix)

Get the start point Z-value z1 from a DXF HELIX.

Returns:
start point Z-value z1 when successful, or EXIT_FAILURE when an rror occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2823 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::z0.

DxfHelix* dxf_helix_set_z1 ( DxfHelix helix,
double  z1 
)

Set the start point Z-value z1 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
z1the start point Z-value z1 to be set for the entity.

Definition at line 2854 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p1, and dxf_point_struct::z0.

DxfPoint* dxf_helix_get_p2 ( DxfHelix helix)

Get the axis vector point p2 from a DXF HELIX entity.

Returns:
the axis vector point p2 when sucessful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 2889 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p2.

Referenced by dxf_helix_free().

DxfHelix* dxf_helix_set_p2 ( DxfHelix helix,
DxfPoint p2 
)

Set the axis vector point p2 for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
p2an axis vector point p2 for the DXF HELIX entity.

Definition at line 2927 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::p2.

double dxf_helix_get_x2 ( DxfHelix helix)

Get the axis vector point X-value x2 from a DXF HELIX.

Returns:
axis vector point X-value x2 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 2969 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::x0.

DxfHelix* dxf_helix_set_x2 ( DxfHelix helix,
double  x2 
)

Set the axis vector point X-value x2 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
x2the axis vector point X-value x2 to be set for the entity.

Definition at line 3000 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::x0.

double dxf_helix_get_y2 ( DxfHelix helix)

Get the axis vector point Y-value y2 from a DXF HELIX.

Returns:
axis vector point Y-value y2 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 3035 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::y0.

DxfHelix* dxf_helix_set_y2 ( DxfHelix helix,
double  y2 
)

Set the axis vector point Y-value y2 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
y2the axis vector point Y-value y2 to be set for the entity.

Definition at line 3066 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::y0.

double dxf_helix_get_z2 ( DxfHelix helix)

Get the axis vector point Z-value z2 from a DXF HELIX.

Returns:
axis vector point Z-value z2 when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 3101 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::z0.

DxfHelix* dxf_helix_set_z2 ( DxfHelix helix,
double  z2 
)

Set the axis vector point Z-value z2 for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
z2the axis vector point Z-value z2 to be set for the entity.

Definition at line 3132 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_helix_struct::p2, and dxf_point_struct::z0.

double dxf_helix_get_radius ( DxfHelix helix)

Get the radius from a DXF HELIX entity.

Returns:
radius when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3167 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::radius.

DxfHelix* dxf_helix_set_radius ( DxfHelix helix,
double  radius 
)

Set the radius for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
radiusthe radius to be set for the entity.

Definition at line 3198 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::radius.

double dxf_helix_get_number_of_turns ( DxfHelix helix)

Get the number_of_turns from a DXF HELIX entity.

Returns:
number_of_turns when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3232 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::number_of_turns.

DxfHelix* dxf_helix_set_number_of_turns ( DxfHelix helix,
double  number_of_turns 
)

Set the number_of_turns for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
number_of_turnsthe number_of_turns to be set for the entity.

Definition at line 3263 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::number_of_turns.

double dxf_helix_get_turn_height ( DxfHelix helix)

Get the turn_height from a DXF HELIX entity.

Returns:
turn_height when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3297 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::turn_height.

DxfHelix* dxf_helix_set_turn_height ( DxfHelix helix,
double  turn_height 
)

Set the turn_height for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
turn_heightthe turn_height to be set for the entity.

Definition at line 3328 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::turn_height.

long dxf_helix_get_major_release_number ( DxfHelix helix)

Get the major_release_number from a DXF HELIX entity.

Returns:
major_release_number when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3362 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::major_release_number.

DxfHelix* dxf_helix_set_major_release_number ( DxfHelix helix,
long  major_release_number 
)

Set the major_release_number for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
major_release_numberthe major_release_number to be set for the entity.

Definition at line 3393 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::major_release_number.

long dxf_helix_get_maintainance_release_number ( DxfHelix helix)

Get the maintainance_release_number from a DXF HELIX entity.

Returns:
maintainance_release_number when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3429 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::maintainance_release_number.

DxfHelix* dxf_helix_set_maintainance_release_number ( DxfHelix helix,
long  maintainance_release_number 
)

Set the maintainance_release_number for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
maintainance_release_numberthe maintainance_release_number to be set for the entity.

Definition at line 3460 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::maintainance_release_number.

int dxf_helix_get_constraint_type ( DxfHelix helix)

Get the constraint_type from a DXF HELIX.

Returns:
constraint_type when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 3495 of file helix.c.

References _, dxf_helix_struct::constraint_type, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfHelix* dxf_helix_set_constraint_type ( DxfHelix helix,
int  constraint_type 
)

Set the constraint_type for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
constraint_typethe constraint_type to be set for the entity.

Definition at line 3540 of file helix.c.

References _, dxf_helix_struct::constraint_type, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_helix_get_handedness ( DxfHelix helix)

Get the handedness from a DXF HELIX.

Returns:
handedness when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 3588 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::handedness.

DxfHelix* dxf_helix_set_handedness ( DxfHelix helix,
int  handedness 
)

Set the handedness for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
handednessthe handedness to be set for the entity.

Definition at line 3633 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::handedness.

DxfSpline* dxf_helix_get_spline ( DxfHelix helix)

Get the spline from a DXF HELIX.

Returns:
spline when successful, or EXIT_FAILURE when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.

Definition at line 3681 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::spline.

DxfHelix* dxf_helix_set_spline ( DxfHelix helix,
DxfSpline spline 
)

Set the spline for a DXF HELIX.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX.
splinethe spline to be set for the entity.

Definition at line 3719 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::spline.

DxfHelix* dxf_helix_get_next ( DxfHelix helix)

Get the pointer to the next HELIX entity from a DXF HELIX entity.

Returns:
pointer to the next HELIX entity.
Warning:
No checks are performed on the returned pointer.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3762 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::next.

DxfHelix* dxf_helix_set_next ( DxfHelix helix,
DxfHelix next 
)

Set the pointer to the next HELIX for a DXF HELIX entity.

Returns:
a pointer to helix when successful, or NULL when an error occurred.
Parameters:
helixa pointer to a DXF HELIX entity.
nexta pointer to the next HELIX for the entity.

Definition at line 3801 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::next.

DxfHelix* dxf_helix_get_last ( DxfHelix helix)

Get the pointer to the last HELIX entity from a linked list of DXF HELIX entity.

Returns:
pointer to the last HELIX entity.
Warning:
No checks are performed on the returned pointer.
Parameters:
helixa pointer to a DXF HELIX entity.

Definition at line 3844 of file helix.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_helix_struct::next.