libDXF 0.0.1
A library with DXF related functions written in C.
Data Fields

dxf_mtext_struct Struct Reference

DXF definition of an AutoCAD mtext entity (MTEXT). More...

#include <mtext.h>

Collaboration diagram for dxf_mtext_struct:
Collaboration graph
[legend]

Data Fields

int id_code
char * linetype
char * layer
double elevation
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
char * text_value
char * text_additional_value [DXF_MAX_PARAM]
char * text_style
DxfPoint * p0
DxfPoint * p1
double height
double rectangle_width
double horizontal_width
double rectangle_height
double spacing_factor
double box_scale
double column_width
double column_gutter
double column_heights
double rot_angle
int background_color
int attachment_point
int drawing_direction
int spacing_style
int column_type
int column_count
int column_flow
int column_autoheight
int background_fill
double extr_x0
double extr_y0
double extr_z0
int32_t background_color_rgb
char * background_color_name
int32_t background_transparency
struct DxfMtext * next

Detailed Description

DXF definition of an AutoCAD mtext entity (MTEXT).

Definition at line 61 of file mtext.h.

Field Documentation

int dxf_mtext_struct::id_code

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

Definition at line 66 of file mtext.h.

Referenced by dxf_mtext_get_id_code(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_id_code(), and dxf_mtext_write().

char* dxf_mtext_struct::linetype

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

Definition at line 71 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_linetype(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_linetype(), and dxf_mtext_write().

char* dxf_mtext_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 75 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_layer(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_layer(), and dxf_mtext_write().

double dxf_mtext_struct::elevation

Elevation of the entity in the local Z-direction.
Defaults to 0.0 if omitted in the DXF file, or prior to DXF version R12, or DXF_FLATLAND equals 0 (default).
Group code = 38.

Deprecated:
As of version R11.

Definition at line 79 of file mtext.h.

Referenced by dxf_mtext_get_elevation(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_elevation(), and dxf_mtext_write().

double dxf_mtext_struct::thickness

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

Definition at line 85 of file mtext.h.

Referenced by dxf_mtext_get_thickness(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_thickness(), and dxf_mtext_write().

double dxf_mtext_struct::linetype_scale

Linetype scale (optional).
Group code = 48.

Since:
Introduced in version R13.

Definition at line 89 of file mtext.h.

Referenced by dxf_mtext_get_linetype_scale(), dxf_mtext_set_linetype_scale(), and dxf_mtext_write().

int16_t dxf_mtext_struct::visibility

Object visibility (optional):

  1. Visible
  2. Invisible

Group code = 60.

Since:
Introduced in version R13.

Definition at line 93 of file mtext.h.

Referenced by dxf_mtext_get_visibility(), dxf_mtext_set_visibility(), and dxf_mtext_write().

int dxf_mtext_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 101 of file mtext.h.

Referenced by dxf_mtext_get_color(), dxf_mtext_init(), dxf_mtext_set_color(), and dxf_mtext_write().

int dxf_mtext_struct::paperspace

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

Since:
Introduced in version R13.

Definition at line 108 of file mtext.h.

Referenced by dxf_mtext_get_paperspace(), dxf_mtext_init(), dxf_mtext_set_paperspace(), and dxf_mtext_write().

int dxf_mtext_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.

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

Definition at line 114 of file mtext.h.

Referenced by dxf_mtext_get_graphics_data_size(), and dxf_mtext_set_graphics_data_size().

int16_t dxf_mtext_struct::shadow_mode

Shadow mode:

  1. Casts and receives shadows.
  2. Casts shadows.
  3. Receives shadows.
  4. Ignores shadows.


Group code = 284.

Since:
Introduced in version R2009.

Definition at line 123 of file mtext.h.

Referenced by dxf_mtext_get_shadow_mode(), and dxf_mtext_set_shadow_mode().

DxfBinaryGraphicsData* dxf_mtext_struct::binary_graphics_data

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

Since:
Introduced in version R2000.

Definition at line 133 of file mtext.h.

Referenced by dxf_mtext_get_binary_graphics_data(), and dxf_mtext_set_binary_graphics_data().

char* dxf_mtext_struct::dictionary_owner_soft

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

Since:
Introduced in version R14.

Definition at line 139 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_dictionary_owner_soft(), dxf_mtext_set_dictionary_owner_soft(), and dxf_mtext_write().

char* dxf_mtext_struct::material

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

Since:
Introduced in version R2008.

Definition at line 143 of file mtext.h.

Referenced by dxf_mtext_get_material(), and dxf_mtext_set_material().

char* dxf_mtext_struct::dictionary_owner_hard

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

Since:
Introduced in version R14.

Definition at line 148 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_dictionary_owner_hard(), dxf_mtext_set_dictionary_owner_hard(), and dxf_mtext_write().

int16_t dxf_mtext_struct::lineweight

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

Since:
Introduced in version R2002.

Definition at line 152 of file mtext.h.

Referenced by dxf_mtext_get_lineweight(), and dxf_mtext_set_lineweight().

char* dxf_mtext_struct::plot_style_name

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

Since:
Introduced in version R2009.

Definition at line 157 of file mtext.h.

Referenced by dxf_mtext_get_plot_style_name(), and dxf_mtext_set_plot_style_name().

long dxf_mtext_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.

Since:
Introduced in version R2004.

Definition at line 161 of file mtext.h.

Referenced by dxf_mtext_get_color_value(), and dxf_mtext_set_color_value().

char* dxf_mtext_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.

Since:
Introduced in version R2004.

Definition at line 173 of file mtext.h.

Referenced by dxf_mtext_get_color_name(), and dxf_mtext_set_color_name().

long dxf_mtext_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.

Since:
Introduced in version R2004.

Definition at line 181 of file mtext.h.

Referenced by dxf_mtext_get_transparency(), and dxf_mtext_set_transparency().

char* dxf_mtext_struct::text_value

Text string.
If the text string is less than 250 characters, all characters appear in group 1.
If the text string is greater than 250 characters, the string is divided into 250-character chunks, which appear in one or more group 3 codes.
If group 3 codes are used, the last group is a group 1 and has fewer than 250 characters.
Group code = 1.

Definition at line 190 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_text_value(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_text_value(), and dxf_mtext_write().

char* dxf_mtext_struct::text_additional_value[DXF_MAX_PARAM]

Optional, only if the text string in group 1 is greater than 250 characters.
Group code = 3.

Definition at line 200 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_init(), and dxf_mtext_write().

char* dxf_mtext_struct::text_style

Text style.
Optional, defaults to STANDARD.
Group code = 7.

Definition at line 204 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_text_style(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_text_style(), and dxf_mtext_write().

DxfPoint* dxf_mtext_struct::p0

Insertion point.
Group codes = 10, 20 and 30.

Definition at line 208 of file mtext.h.

Referenced by dxf_mtext_get_p0(), dxf_mtext_get_x0(), dxf_mtext_get_y0(), dxf_mtext_get_z0(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_p0(), dxf_mtext_set_x0(), dxf_mtext_set_y0(), dxf_mtext_set_z0(), and dxf_mtext_write().

DxfPoint* dxf_mtext_struct::p1

Direction vector, expressed in World Coordinate System (WCS).
A group code 50 (rotation angle in radians) passed as DXF input is converted to the equivalent direction vector (if both a code 50 and codes 11, 21, 31 are passed, the last one wins).
This is provided as a convenience for conversions from text objects.
Group codes = 11, 21 and 31.

Definition at line 211 of file mtext.h.

Referenced by dxf_mtext_get_p1(), dxf_mtext_get_x1(), dxf_mtext_get_y1(), dxf_mtext_get_z1(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_p1(), dxf_mtext_set_x1(), dxf_mtext_set_y1(), dxf_mtext_set_z1(), and dxf_mtext_write().

double dxf_mtext_struct::height

Nominal (initial) text height.
Group code = 40.

Definition at line 221 of file mtext.h.

Referenced by dxf_mtext_get_height(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_height(), and dxf_mtext_write().

double dxf_mtext_struct::rectangle_width

Reference rectangle width.
Group code = 41.

Definition at line 224 of file mtext.h.

Referenced by dxf_mtext_get_rectangle_width(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_rectangle_width(), and dxf_mtext_write().

double dxf_mtext_struct::horizontal_width

Horizontal width of the characters that make up the mtext entity.
This value will always be equal to or less than the value of group code 41 (read-only, ignored if supplied).
Group code = 42.

Definition at line 227 of file mtext.h.

Referenced by dxf_mtext_get_horizontal_width(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_horizontal_width(), and dxf_mtext_write().

double dxf_mtext_struct::rectangle_height

Vertical height of the mtext entity (read-only, ignored if supplied).
Group code = 43.

Definition at line 234 of file mtext.h.

Referenced by dxf_mtext_get_rectangle_height(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_rectangle_height(), and dxf_mtext_write().

double dxf_mtext_struct::spacing_factor

Text line spacing factor (optional):
Percentage of default (3-on-5) line spacing to be applied.
Valid values range from 0.25 to 4.00.
Group code = 44.

Definition at line 238 of file mtext.h.

Referenced by dxf_mtext_get_spacing_factor(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_spacing_factor().

double dxf_mtext_struct::box_scale

Optional, fill box scale:
Determines how much border is around the text.
Group code = 45.

Definition at line 244 of file mtext.h.

Referenced by dxf_mtext_get_box_scale(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_box_scale().

double dxf_mtext_struct::column_width

Column width.
Group code = 48.

Definition at line 248 of file mtext.h.

Referenced by dxf_mtext_get_column_width(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_width().

double dxf_mtext_struct::column_gutter

Column gutter.
Group code = 49.

Definition at line 251 of file mtext.h.

Referenced by dxf_mtext_get_column_gutter(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_gutter().

double dxf_mtext_struct::column_heights

Column heights this code is followed by a column count (Int16), and then the number of column heights.
Group code = 50.

Definition at line 254 of file mtext.h.

Referenced by dxf_mtext_get_column_heights(), dxf_mtext_init(), and dxf_mtext_set_column_heights().

double dxf_mtext_struct::rot_angle

Rotation angle in radians.
Group code = 50.

Definition at line 258 of file mtext.h.

Referenced by dxf_mtext_get_rot_angle(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_rot_angle(), and dxf_mtext_write().

int dxf_mtext_struct::background_color

Background fill color (optional).
Color to use for background fill when group code 90 is 1.
Group code = 63.

Definition at line 261 of file mtext.h.

Referenced by dxf_mtext_get_background_color(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_background_color().

int dxf_mtext_struct::attachment_point

Attachment point:

  1. Top left.
  2. Top center.
  3. Top right.
  4. Middle left.
  5. Middle center.
  6. Middle right.
  7. Bottom left.
  8. Bottom center.
  9. Bottom right.

Group code = 71.

Definition at line 266 of file mtext.h.

Referenced by dxf_mtext_get_attachment_point(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_attachment_point(), and dxf_mtext_write().

int dxf_mtext_struct::drawing_direction

Drawing direction:

  1. Left to right.
  2. Right to left (obsolete as of R14).
  3. Top to bottom.
  4. Bottom to top (obsolete as of R14)
  5. By style (the flow direction is inherited from the associated text style, added as of R14).

Group code = 72.

Definition at line 280 of file mtext.h.

Referenced by dxf_mtext_get_drawing_direction(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_drawing_direction(), and dxf_mtext_write().

int dxf_mtext_struct::spacing_style

Optional, mtext line spacing style:

  1. At least (taller characters will override).
  2. Exact (taller characters will not override).

Group code = 73.

Definition at line 292 of file mtext.h.

Referenced by dxf_mtext_get_spacing_style(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_spacing_style().

int dxf_mtext_struct::column_type

Column type.
Group code = 75.

Definition at line 301 of file mtext.h.

Referenced by dxf_mtext_get_column_type(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_type().

int dxf_mtext_struct::column_count

Column count.
Group code = 76.

Definition at line 304 of file mtext.h.

Referenced by dxf_mtext_get_column_count(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_count().

int dxf_mtext_struct::column_flow

Column flow reversed.
Group code = 78.

Definition at line 307 of file mtext.h.

Referenced by dxf_mtext_get_column_flow(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_flow().

int dxf_mtext_struct::column_autoheight

Column autoheight.
Group code = 79.

Definition at line 310 of file mtext.h.

Referenced by dxf_mtext_get_column_autoheight(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_column_autoheight().

int dxf_mtext_struct::background_fill

Background fill setting:

  1. Background fill off.
  2. Use background fill color.
  3. Use drawing window color as background fill color.

Group code = 90.

Definition at line 313 of file mtext.h.

Referenced by dxf_mtext_get_background_fill(), dxf_mtext_init(), dxf_mtext_read(), and dxf_mtext_set_background_fill().

double dxf_mtext_struct::extr_x0

X-value of the extrusion direction.
Optional, defaults to 0.0.
Group code = 210.

Definition at line 322 of file mtext.h.

Referenced by dxf_mtext_get_extr_x0(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_extr_x0(), dxf_mtext_set_extrusion_vector(), dxf_mtext_set_extrusion_vector_from_point(), and dxf_mtext_write().

double dxf_mtext_struct::extr_y0

Y-value of the extrusion direction.
Optional, defaults to 0.0.
Group code = 220.

Definition at line 326 of file mtext.h.

Referenced by dxf_mtext_get_extr_y0(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_extr_y0(), dxf_mtext_set_extrusion_vector(), dxf_mtext_set_extrusion_vector_from_point(), and dxf_mtext_write().

double dxf_mtext_struct::extr_z0

Z-value of the extrusion direction.
Optional, defaults to 1.0.
Group code = 230.

Definition at line 330 of file mtext.h.

Referenced by dxf_mtext_get_extr_z0(), dxf_mtext_init(), dxf_mtext_read(), dxf_mtext_set_extr_z0(), dxf_mtext_set_extrusion_vector(), dxf_mtext_set_extrusion_vector_from_point(), and dxf_mtext_write().

int32_t dxf_mtext_struct::background_color_rgb

Background color (if RGB color).
Group code = 420-429.

Definition at line 334 of file mtext.h.

Referenced by dxf_mtext_get_background_color_rgb(), dxf_mtext_init(), and dxf_mtext_set_background_color_rgb().

char* dxf_mtext_struct::background_color_name

Background color (if color name).
Group code = 430-439.

Definition at line 337 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_get_background_color_name(), dxf_mtext_init(), and dxf_mtext_set_background_color_name().

int32_t dxf_mtext_struct::background_transparency

Transparency of background fill color.
Not yet implemented in AutoCAD.
Group code = 441.

Definition at line 340 of file mtext.h.

Referenced by dxf_mtext_get_background_transparency(), dxf_mtext_init(), and dxf_mtext_set_background_transparency().

struct DxfMtext* dxf_mtext_struct::next

pointer to the next DxfMtext.
NULL in the last DxfMtext.

Definition at line 343 of file mtext.h.

Referenced by dxf_mtext_free(), dxf_mtext_free_chain(), dxf_mtext_get_last(), dxf_mtext_get_next(), and dxf_mtext_set_next().

The documentation for this struct was generated from the following file:
Generated on Sun Nov 19 2017 for libDXF by  doxygen 1.7.3