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

#include <image.h>

Collaboration diagram for dxf_image_struct:

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
DxfPoint *	p0
DxfPoint *	p1
DxfPoint *	p2
DxfPoint *	p3
DxfPoint *	p4
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 DxfImage *	next

Detailed Description

Definition of an AutoCAD image entity (IMAGE).

Definition at line 65 of file image.h.

Field Documentation

int dxf_image_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 70 of file image.h.

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

char* dxf_image_struct::linetype

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().

char* dxf_image_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 79 of file image.h.

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

double dxf_image_struct::elevation

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().

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

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

double dxf_image_struct::linetype_scale

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().

int16_t dxf_image_struct::visibility

Object visibility (optional):

Visible
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().

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

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

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

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

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

Referenced by dxf_image_get_graphics_data_size(), and dxf_image_set_graphics_data_size().

int16_t dxf_image_struct::shadow_mode

Shadow mode:

Casts and receives shadows.
Casts shadows.
Receives shadows.
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().

DxfBinaryGraphicsData* dxf_image_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 135 of file image.h.

Referenced by dxf_image_get_binary_graphics_data(), and dxf_image_set_binary_graphics_data().

char* dxf_image_struct::dictionary_owner_soft

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().

char* dxf_image_struct::material

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().

char* dxf_image_struct::dictionary_owner_hard

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().

int16_t dxf_image_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 154 of file image.h.

Referenced by dxf_image_get_lineweight(), and dxf_image_set_lineweight().

char* dxf_image_struct::plot_style_name

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().

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

Referenced by dxf_image_get_color_value(), and dxf_image_set_color_value().

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

Referenced by dxf_image_get_color_name(), and dxf_image_set_color_name().

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

Referenced by dxf_image_get_transparency(), and dxf_image_set_transparency().

DxfPoint* dxf_image_struct::p0

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

Definition at line 192 of file image.h.

Referenced by dxf_image_get_p0(), dxf_image_get_x0(), dxf_image_get_y0(), dxf_image_get_z0(), dxf_image_read(), dxf_image_set_p0(), dxf_image_set_x0(), dxf_image_set_y0(), and dxf_image_set_z0().

DxfPoint* dxf_image_struct::p1

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().

DxfPoint* dxf_image_struct::p2

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().

DxfPoint* dxf_image_struct::p3

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().

DxfPoint* dxf_image_struct::p4

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.