DXF definition of an AutoCAD oleframe entity (OLEFRAME). More...

#include <oleframe.h>

Collaboration diagram for dxf_oleframe_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
int	ole_version_number
long	length
DxfChar *	binary_data
struct DxfOleFrame *	next

Detailed Description

DXF definition of an AutoCAD oleframe entity (OLEFRAME).

Version:: According to DXF R13.; According to DXF R14.

Definition at line 57 of file oleframe.h.

Field Documentation

int dxf_oleframe_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 62 of file oleframe.h.

Referenced by dxf_oleframe_get_id_code(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_id_code(), and dxf_oleframe_write().

char* dxf_oleframe_struct::linetype

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

Definition at line 67 of file oleframe.h.

Referenced by dxf_oleframe_free(), dxf_oleframe_get_linetype(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_linetype(), and dxf_oleframe_write().

char* dxf_oleframe_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 71 of file oleframe.h.

Referenced by dxf_oleframe_free(), dxf_oleframe_get_layer(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_layer(), and dxf_oleframe_write().

double dxf_oleframe_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 75 of file oleframe.h.

Referenced by dxf_oleframe_get_elevation(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_elevation(), and dxf_oleframe_write().

double dxf_oleframe_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 81 of file oleframe.h.

Referenced by dxf_oleframe_get_thickness(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_thickness(), and dxf_oleframe_write().

double dxf_oleframe_struct::linetype_scale

Linetype scale (optional).
Group code = 48.

Since:: Introduced in version R13.

Definition at line 85 of file oleframe.h.

Referenced by dxf_oleframe_get_linetype_scale(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_linetype_scale(), and dxf_oleframe_write().

int16_t dxf_oleframe_struct::visibility

Object visibility (optional):

Visible
Invisible

Group code = 60.

Since:: Introduced in version R13.

Definition at line 89 of file oleframe.h.

Referenced by dxf_oleframe_get_visibility(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_visibility(), and dxf_oleframe_write().

int dxf_oleframe_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 97 of file oleframe.h.

Referenced by dxf_oleframe_get_color(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_color(), and dxf_oleframe_write().

int dxf_oleframe_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 104 of file oleframe.h.

Referenced by dxf_oleframe_get_paperspace(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_paperspace(), and dxf_oleframe_write().

int dxf_oleframe_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 110 of file oleframe.h.

Referenced by dxf_oleframe_get_graphics_data_size(), and dxf_oleframe_set_graphics_data_size().

int16_t dxf_oleframe_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 119 of file oleframe.h.

Referenced by dxf_oleframe_get_shadow_mode(), and dxf_oleframe_set_shadow_mode().

DxfBinaryGraphicsData* dxf_oleframe_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 129 of file oleframe.h.

Referenced by dxf_oleframe_get_binary_graphics_data(), and dxf_oleframe_set_binary_graphics_data().

char* dxf_oleframe_struct::dictionary_owner_soft

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

Since:: Introduced in version R14.

Definition at line 135 of file oleframe.h.

Referenced by dxf_oleframe_free(), dxf_oleframe_get_dictionary_owner_soft(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_dictionary_owner_soft(), and dxf_oleframe_write().

char* dxf_oleframe_struct::material

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

Since:: Introduced in version R2008.

Definition at line 139 of file oleframe.h.

Referenced by dxf_oleframe_get_material(), and dxf_oleframe_set_material().

char* dxf_oleframe_struct::dictionary_owner_hard

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

Since:: Introduced in version R14.

Definition at line 144 of file oleframe.h.

Referenced by dxf_oleframe_free(), dxf_oleframe_get_dictionary_owner_hard(), dxf_oleframe_init(), dxf_oleframe_read(), dxf_oleframe_set_dictionary_owner_hard(), and dxf_oleframe_write().

int16_t dxf_oleframe_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 148 of file oleframe.h.

Referenced by dxf_oleframe_get_lineweight(), and dxf_oleframe_set_lineweight().

char* dxf_oleframe_struct::plot_style_name

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

Since:: Introduced in version R2009.

Definition at line 153 of file oleframe.h.

Referenced by dxf_oleframe_get_plot_style_name(), and dxf_oleframe_set_plot_style_name().

long dxf_oleframe_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 157 of file oleframe.h.

Referenced by dxf_oleframe_get_color_value(), and dxf_oleframe_set_color_value().

char* dxf_oleframe_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 169 of file oleframe.h.

Referenced by dxf_oleframe_get_color_name(), and dxf_oleframe_set_color_name().

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