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

#include <helix.h>

Collaboration diagram for dxf_helix_struct:

Data Fields
int	id_code
char *	linetype
char *	layer
double	thickness
double	linetype_scale
int16_t	visibility
int	color
int	paperspace
int	graphics_data_size
int16_t	shadow_mode
DxfBinaryGraphicsData *	binary_graphics_data
char *	dictionary_owner_soft
char *	material
char *	dictionary_owner_hard
int16_t	lineweight
char *	plot_style_name
long	color_value
char *	color_name
long	transparency
DxfPoint *	p0
DxfPoint *	p1
DxfPoint *	p2
double	radius
double	number_of_turns
double	turn_height
long	major_release_number
long	maintainance_release_number
int	constraint_type
int	handedness
DxfSpline *	spline
struct DxfHelix *	next

Detailed Description

Definition of an AutoCAD helix entity (HELIX).

Definition at line 54 of file helix.h.

Field Documentation

int dxf_helix_struct::id_code

Identification number for the entity.
This is to be an unique (sequential) number in the DXF file.
Group code = 5.

Definition at line 59 of file helix.h.

Referenced by dxf_helix_get_id_code(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_id_code(), dxf_helix_write(), and dxf_idbuffer_set_id_code().

char* dxf_helix_struct::linetype

The linetype of the entity.
Defaults to BYLAYER if ommitted in the DXF file.
Group code = 6.

Definition at line 64 of file helix.h.

Referenced by dxf_helix_get_linetype(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_linetype(), and dxf_helix_write().

char* dxf_helix_struct::layer

Layer on which the entity is drawn.
Defaults to layer "0" if no valid layername is given.
Group code = 8.

Definition at line 68 of file helix.h.

Referenced by dxf_helix_get_layer(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_layer(), and dxf_helix_write().

double dxf_helix_struct::thickness

Thickness of the arc in the local Z-direction.
Defaults to 0.0 if ommitted in the DXF file.
Group code = 39.

Definition at line 72 of file helix.h.

Referenced by dxf_helix_get_thickness(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_thickness(), and dxf_helix_write().

double dxf_helix_struct::linetype_scale

Linetype scale (optional).
Group code = 48.

Definition at line 76 of file helix.h.

Referenced by dxf_helix_get_linetype_scale(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_linetype_scale(), and dxf_helix_write().

int16_t dxf_helix_struct::visibility

Object visibility (optional):

Visible
Invisible

Group code = 60.

Definition at line 79 of file helix.h.

Referenced by dxf_helix_get_visibility(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_visibility(), and dxf_helix_write().

int dxf_helix_struct::color

Color of the entity.
Defaults to BYLAYER if ommitted in the DXF file.
Note that entities encapsulated in a block with the color BYBLOCK are represented in the "native" color of the BLOCK entity.
Group code = 62.

Definition at line 86 of file helix.h.

Referenced by dxf_helix_get_color(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_color(), and dxf_helix_write().

int dxf_helix_struct::paperspace

Entities are to be drawn on either PAPERSPACE or MODELSPACE.
Optional, defaults to DXF_MODELSPACE (0).
Group code = 67.

Definition at line 93 of file helix.h.

Referenced by dxf_helix_get_paperspace(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_paperspace(), and dxf_helix_write().

int dxf_helix_struct::graphics_data_size

Number of bytes in the proxy entity graphics represented in the sub-sequent 310 groups, which are binary chunk records (optional).
Group code = 92.

Warning:: On some 64 bit workstations output is generated with group code "160", thus omitting group code "92".

Definition at line 98 of file helix.h.

Referenced by dxf_helix_get_graphics_data_size(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_graphics_data_size(), and dxf_helix_write().

int16_t dxf_helix_struct::shadow_mode

Shadow mode:

Casts and receives shadows.
Casts shadows.
Receives shadows.
Ignores shadows.

Group code = 284.

Definition at line 108 of file helix.h.

Referenced by dxf_helix_get_shadow_mode(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_shadow_mode(), and dxf_helix_write().

DxfBinaryGraphicsData* dxf_helix_struct::binary_graphics_data

Proxy entity graphics data.
Multiple lines of 256 characters maximum per line (optional).
Group code = 310.

Definition at line 117 of file helix.h.

Referenced by dxf_helix_get_binary_graphics_data(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_binary_graphics_data(), and dxf_helix_write().

char* dxf_helix_struct::dictionary_owner_soft

Soft-pointer ID/handle to owner dictionary (optional).
Group code = 330.

Definition at line 122 of file helix.h.

Referenced by dxf_helix_get_dictionary_owner_soft(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_dictionary_owner_soft(), and dxf_helix_write().

char* dxf_helix_struct::material

Hard-pointer ID/handle to material object (present if not BYLAYER).
Group code = 347.

Definition at line 125 of file helix.h.

Referenced by dxf_helix_get_material(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_material(), and dxf_helix_write().

char* dxf_helix_struct::dictionary_owner_hard

Hard owner ID/handle to owner dictionary (optional).
Group code = 360.

Definition at line 129 of file helix.h.

Referenced by dxf_helix_get_dictionary_owner_hard(), dxf_helix_init(), dxf_helix_read(), and dxf_helix_set_dictionary_owner_hard().

int16_t dxf_helix_struct::lineweight

Lineweight enum value.
Stored and moved around as a 16-bit integer.
Group code = 370.

Definition at line 132 of file helix.h.

Referenced by dxf_helix_get_lineweight(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_lineweight(), and dxf_helix_write().

char* dxf_helix_struct::plot_style_name

Hard pointer ID / handle of PlotStyleName object.
Group code = 390.

Definition at line 136 of file helix.h.

Referenced by dxf_helix_get_plot_style_name(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_plot_style_name(), and dxf_helix_write().

long dxf_helix_struct::color_value

A 24-bit color value that should be dealt with in terms of bytes with values of 0 to 255.
The lowest byte is the blue value, the middle byte is the green value, and the third byte is the red value.
The top byte is always 0.
The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data.
Group code = 420.

Definition at line 139 of file helix.h.

Referenced by dxf_helix_get_color_value(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_color_value(), and dxf_helix_write().

char* dxf_helix_struct::color_name

Color name.
The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data.
Group code = 430.

Definition at line 150 of file helix.h.

Referenced by dxf_helix_get_color_name(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_color_name(), and dxf_helix_write().

long dxf_helix_struct::transparency

Transparency value.
The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data.
Group code = 440.

Definition at line 157 of file helix.h.

Referenced by dxf_helix_get_transparency(), dxf_helix_init(), dxf_helix_read(), dxf_helix_set_transparency(), and dxf_helix_write().