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

dxf_image_struct Struct Reference

Definition of an AutoCAD image entity (IMAGE). More...

#include <image.h>

Collaboration diagram for dxf_image_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
DxfBinaryGraphicsDatabinary_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
DxfPointp0
DxfPointp1
DxfPointp2
DxfPointp3
DxfPointp4
int image_display_properties
int clipping_boundary_type
long class_version
long number_of_clip_boundary_vertices
int clipping_state
int brightness
int contrast
int fade
char * imagedef_object
char * imagedef_reactor_object
struct DxfImagenext

Detailed Description

Definition of an AutoCAD image entity (IMAGE).

Definition at line 65 of file image.h.


Field Documentation

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

Definition at line 70 of file image.h.

Referenced by dxf_image_get_id_code(), dxf_image_read(), and dxf_image_set_id_code().

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

Definition at line 75 of file image.h.

Referenced by dxf_image_get_linetype(), dxf_image_read(), and dxf_image_set_linetype().

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

Definition at line 79 of file image.h.

Referenced by dxf_image_get_layer(), dxf_image_read(), and dxf_image_set_layer().

Elevation of the arc 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.

Definition at line 83 of file image.h.

Referenced by dxf_image_get_elevation(), dxf_image_read(), and dxf_image_set_elevation().

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 88 of file image.h.

Referenced by dxf_image_get_thickness(), dxf_image_read(), and dxf_image_set_thickness().

Linetype scale (optional).
Group code = 48.

Definition at line 92 of file image.h.

Referenced by dxf_image_get_linetype_scale(), dxf_image_read(), and dxf_image_set_linetype_scale().

Object visibility (optional):

  1. Visible
  2. Invisible

Group code = 60.

Since:
Introduced in version R13.

Definition at line 95 of file image.h.

Referenced by dxf_image_get_visibility(), dxf_image_read(), and dxf_image_set_visibility().

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 103 of file image.h.

Referenced by dxf_image_get_color(), dxf_image_read(), and dxf_image_set_color().

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 110 of file image.h.

Referenced by dxf_image_get_paperspace(), dxf_image_read(), and dxf_image_set_paperspace().

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 116 of file image.h.

Referenced by dxf_image_get_graphics_data_size(), and dxf_image_set_graphics_data_size().

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 125 of file image.h.

Referenced by dxf_image_get_shadow_mode(), and dxf_image_set_shadow_mode().

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

Since:
Introduced in version R2000.

Definition at line 135 of file image.h.

Referenced by dxf_image_get_binary_graphics_data(), and dxf_image_set_binary_graphics_data().

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

Since:
Introduced in version R14.

Definition at line 141 of file image.h.

Referenced by dxf_image_get_dictionary_owner_soft(), dxf_image_read(), and dxf_image_set_dictionary_owner_soft().

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

Since:
Introduced in version R2008.

Definition at line 145 of file image.h.

Referenced by dxf_image_get_material(), and dxf_image_set_material().

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

Since:
Introduced in version R14.

Definition at line 150 of file image.h.

Referenced by dxf_image_get_dictionary_owner_hard(), and dxf_image_set_dictionary_owner_hard().

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

Since:
Introduced in version R2002.

Definition at line 154 of file image.h.

Referenced by dxf_image_get_lineweight(), and dxf_image_set_lineweight().

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

Since:
Introduced in version R2009.

Definition at line 159 of file image.h.

Referenced by dxf_image_get_plot_style_name(), and dxf_image_set_plot_style_name().

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 163 of file image.h.

Referenced by dxf_image_get_color_value(), and dxf_image_set_color_value().

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 175 of file image.h.

Referenced by dxf_image_get_color_name(), and dxf_image_set_color_name().

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 183 of file image.h.

Referenced by dxf_image_get_transparency(), and dxf_image_set_transparency().

U-vector of a single pixel (points along the visual bottom of the image, starting at the insertion point) (in OCS).
Group codes = 11, 21 and 31.

Definition at line 195 of file image.h.

Referenced by dxf_image_get_p1(), dxf_image_get_x1(), dxf_image_get_y1(), dxf_image_get_z1(), dxf_image_read(), dxf_image_set_p1(), dxf_image_set_x1(), dxf_image_set_y1(), and dxf_image_set_z1().

V-vector of a single pixel (points along the visual left side of the image, starting at the insertion point) (in OCS).
Group codes = 12, 22 and 32.

Definition at line 200 of file image.h.

Referenced by dxf_image_get_p2(), dxf_image_get_x2(), dxf_image_get_y2(), dxf_image_get_z2(), dxf_image_read(), dxf_image_set_p2(), dxf_image_set_x2(), dxf_image_set_y2(), and dxf_image_set_z2().

U- and V-value of image size in pixels.
Group codes = 13 and 23.

Definition at line 205 of file image.h.

Referenced by dxf_image_get_p3(), dxf_image_get_x3(), dxf_image_get_y3(), dxf_image_read(), dxf_image_set_p3(), dxf_image_set_x3(), and dxf_image_set_y3().

Rectangular clip boundary type, two opposite corners must be specified.
Default is (-0.5,-0.5), (size.x-0.5, size.y-0.5).
For polygonal clip boundary type, three or more vertices must be specified.
Group codes = 14 and 24.

Note:
Polygonal vertices must be listed sequentially.

Definition at line 208 of file image.h.

Referenced by dxf_image_get_p4(), dxf_image_get_x4(), dxf_image_get_y4(), dxf_image_read(), dxf_image_set_p4(), dxf_image_set_x4(), and dxf_image_set_y4().

Image display properties.
bit coded:

  1. Show image.
  2. Show image when not aligned with screen.
  3. Use clipping boundary
  4. Transparency is on.


Group code = 70.

Definition at line 216 of file image.h.

Referenced by dxf_image_get_image_display_properties(), dxf_image_read(), and dxf_image_set_image_display_properties().

Clipping boundary type.

  1. Rectangular.
  2. Polygonal.


Group code = 71.

Definition at line 226 of file image.h.

Referenced by dxf_image_get_clipping_boundary_type(), dxf_image_read(), and dxf_image_set_clipping_boundary_type().

Class version.
Group code = 90.

Definition at line 233 of file image.h.

Referenced by dxf_image_get_class_version(), dxf_image_read(), and dxf_image_set_class_version().

Number of clip boundary vertices that follow.
Group code = 91.

Definition at line 236 of file image.h.

Referenced by dxf_image_get_number_of_clip_boundary_vertices(), dxf_image_read(), and dxf_image_set_number_of_clip_boundary_vertices().

Clipping state: 0 = off, 1 = on.
Group code = 280.

Definition at line 239 of file image.h.

Referenced by dxf_image_get_clipping_state(), dxf_image_read(), and dxf_image_set_clipping_state().

Brightness value (0 ... 100; default = 50).
Group code = 281.

Definition at line 242 of file image.h.

Referenced by dxf_image_get_brightness(), dxf_image_read(), and dxf_image_set_brightness().

Contrast value (0 ... 100; default = 50).
Group code = 282.

Definition at line 245 of file image.h.

Referenced by dxf_image_get_contrast(), dxf_image_read(), and dxf_image_set_contrast().

Fade value (0 ... 100; default = 50).
Group code = 283.

Definition at line 248 of file image.h.

Referenced by dxf_image_get_fade(), dxf_image_read(), and dxf_image_set_fade().

Hard reference to imagedef object.
Group code = 340.

Definition at line 251 of file image.h.

Referenced by dxf_image_get_imagedef_object(), dxf_image_read(), and dxf_image_set_imagedef_object().

Hard reference to imagedef_reactor object.
Group code = 360.

Definition at line 254 of file image.h.

Referenced by dxf_image_get_imagedef_reactor_object(), dxf_image_read(), and dxf_image_set_imagedef_reactor_object().

Pointer to the next DxfImage.
NULL in the last DxfImage.

Definition at line 256 of file image.h.

Referenced by dxf_image_free(), dxf_image_free_chain(), dxf_image_get_last(), dxf_image_get_next(), and dxf_image_set_next().


The documentation for this struct was generated from the following file: