Header file for a DXF region entity (REGION). More...

#include "global.h"
#include "point.h"
#include "binary_graphics_data.h"
#include "util.h"

Include dependency graph for region.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	dxf_region_struct
	DXF definition of an AutoCAD region entity (`REGION`). More...
Typedefs
typedef struct dxf_region_struct	DxfRegion
	DXF definition of an AutoCAD region entity (`REGION`).
Functions
DxfRegion *	dxf_region_new ()
	Allocate memory for a `DxfRegion`.
DxfRegion *	dxf_region_init (DxfRegion *region)
	Allocate memory and initialize data fields in a `REGION` entity.
DxfRegion *	dxf_region_read (DxfFile fp, DxfRegion region)
	Read data from a DXF file into a DXF `REGION` entity.
int	dxf_region_write (DxfFile fp, DxfRegion region)
	Write DXF output to a file for a DXF `REGION` entity.
int	dxf_region_free (DxfRegion *region)
	Free the allocated memory for a DXF `REGION` and all it's data fields.
void	dxf_region_free_chain (DxfRegion *regions)
	Free the allocated memory for a chain of DXF `REGION` entities and all their data fields.
int	dxf_region_get_id_code (DxfRegion *region)
	Get the `id_code` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_id_code (DxfRegion *region, int id_code)
	Set the `id_code` for a DXF `REGION` entity.
char *	dxf_region_get_linetype (DxfRegion *region)
	Get the `linetype` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_linetype (DxfRegion region, char linetype)
	Set the `linetype` for a DXF `REGION` entity.
char *	dxf_region_get_layer (DxfRegion *region)
	Get the `layer` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_layer (DxfRegion region, char layer)
	Set the `layer` for a DXF `REGION` entity.
double	dxf_region_get_elevation (DxfRegion *region)
	Get the `elevation` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_elevation (DxfRegion *region, double elevation)
	Set the `elevation` for a DXF `REGION` entity.
double	dxf_region_get_thickness (DxfRegion *region)
	Get the `thickness` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_thickness (DxfRegion *region, double thickness)
	Set the `thickness` for a DXF `REGION` entity.
double	dxf_region_get_linetype_scale (DxfRegion *region)
	Get the `linetype_scale` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_linetype_scale (DxfRegion *region, double linetype_scale)
	Set the `linetype_scale` for a DXF `REGION` entity.
int16_t	dxf_region_get_visibility (DxfRegion *region)
	Get the `visibility` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_visibility (DxfRegion *region, int16_t visibility)
	Set the `visibility` for a DXF `REGION` entity.
int	dxf_region_get_color (DxfRegion *region)
	Get the `color` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_color (DxfRegion *region, int color)
	Set the `color` for a DXF `REGION` entity.
int	dxf_region_get_paperspace (DxfRegion *region)
	Get the `paperspace` flag value from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_paperspace (DxfRegion *region, int paperspace)
	Set the `paperspace` flag for a DXF `REGION` entity.
int	dxf_region_get_graphics_data_size (DxfRegion *region)
	Get the `graphics_data_size` value from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_graphics_data_size (DxfRegion *region, int graphics_data_size)
	Set the `graphics_data_size` value for a DXF `REGION` entity.
int16_t	dxf_region_get_shadow_mode (DxfRegion *region)
	Get the `shadow_mode` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_shadow_mode (DxfRegion *region, int16_t shadow_mode)
	Set the `shadow_mode` for a DXF `REGION` entity.
DxfBinaryGraphicsData *	dxf_region_get_binary_graphics_data (DxfRegion *region)
	Get the pointer to the `binary_graphics_data` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_binary_graphics_data (DxfRegion region, DxfBinaryGraphicsData data)
	Set the pointer to the `binary_graphics_data` for a DXF `REGION` entity.
char *	dxf_region_get_dictionary_owner_soft (DxfRegion *region)
	Get the pointer to the `dictionary_owner_soft` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_dictionary_owner_soft (DxfRegion region, char dictionary_owner_soft)
	Set the pointer to the `dictionary_owner_soft` for a DXF `REGION` entity.
char *	dxf_region_get_material (DxfRegion *region)
	Get the pointer to the `material` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_material (DxfRegion region, char material)
	Set the pointer to the `material` for a DXF `REGION` entity.
char *	dxf_region_get_dictionary_owner_hard (DxfRegion *region)
	Get the pointer to the `dictionary_owner_hard` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_dictionary_owner_hard (DxfRegion region, char dictionary_owner_hard)
	Set the pointer to the `dictionary_owner_hard` for a DXF `REGION` entity.
int16_t	dxf_region_get_lineweight (DxfRegion *region)
	Get the `lineweight` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_lineweight (DxfRegion *region, int16_t lineweight)
	Set the `lineweight` for a DXF `REGION` entity.
char *	dxf_region_get_plot_style_name (DxfRegion *region)
	Get the `plot_style_name` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_plot_style_name (DxfRegion region, char plot_style_name)
	Set the `plot_style_name` for a DXF `REGION` entity.
long	dxf_region_get_color_value (DxfRegion *region)
	Get the `color_value` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_color_value (DxfRegion *region, long color_value)
	Set the `color_value` for a DXF `REGION` entity.
char *	dxf_region_get_color_name (DxfRegion *region)
	Get the `color_name` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_color_name (DxfRegion region, char color_name)
	Set the `color_name` for a DXF `REGION` entity.
long	dxf_region_get_transparency (DxfRegion *region)
	Get the `transparency` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_transparency (DxfRegion *region, long transparency)
	Set the `transparency` for a DXF `REGION` entity.
DxfChar *	dxf_region_get_proprietary_data (DxfRegion *region)
	Get the `proprietary_data` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_proprietary_data (DxfRegion region, DxfChar proprietary_data)
	Set the `proprietary_data` for a DXF `REGION` entity.
DxfChar *	dxf_region_get_additional_proprietary_data (DxfRegion *region)
	Get the `additional_proprietary_data` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_additional_proprietary_data (DxfRegion region, DxfChar additional_proprietary_data)
	Set the `additional_proprietary_data` for a DXF `REGION` entity.
int	dxf_region_get_modeler_format_version_number (DxfRegion *region)
	Get the `modeler_format_version_number` from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_modeler_format_version_number (DxfRegion *region, int modeler_format_version_number)
	Set the `modeler_format_version_number` for a DXF `REGION` entity.
DxfRegion *	dxf_region_get_next (DxfRegion *region)
	Get the pointer to the next `REGION` entity from a DXF `REGION` entity.
DxfRegion *	dxf_region_set_next (DxfRegion region, DxfRegion next)
	Set the pointer to the next `REGION` for a DXF `REGION` entity.
DxfRegion *	dxf_region_get_last (DxfRegion *region)
	Get the pointer to the last `REGION` entity from a linked list of DXF `REGION` entities.

Detailed Description

Header file for a DXF region entity (REGION).

Author:: Copyright (C) 2013, 2014, 2015, 2016, 2017 by Bert Timmerman <bert.timmerman@xs4all.nl>.

Since:: The region entity was introduced in DXF version R13.

Version:: According to DXF R10 (backward compatibility).; According to DXF R11 (backward compatibility).; According to DXF R12 (backward compatibility).; According to DXF R13.; According to DXF R14.

Copyright Notices.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to:
Free Software Foundation, Inc.,
59 Temple Place,
Suite 330,
Boston,
MA 02111 USA.

Drawing eXchange Format (DXF) is a defacto industry standard for the exchange of drawing files between various Computer Aided Drafting programs.
DXF is an industry standard designed by Autodesk(TM).
For more details see http://www.autodesk.com.

Definition in file region.h.

Typedef Documentation

typedef struct dxf_region_struct DxfRegion

DXF definition of an AutoCAD region entity (REGION).

Function Documentation

DxfRegion* dxf_region_new ( )

Allocate memory for a DxfRegion.

Fill the memory contents with zeros.

Definition at line 53 of file region.c.

References _, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_region_init(), and dxf_region_read().

DxfRegion* dxf_region_init ( DxfRegion * region )

Allocate memory and initialize data fields in a REGION entity.

Returns:: NULL when no memory was allocated, a pointer to the allocated memory when succesful.

Parameters:

region a pointer to the DXF REGION entity.

Definition at line 91 of file region.c.

Referenced by dxf_region_read().

Here is the call graph for this function:

DxfRegion* dxf_region_read	(	DxfFile *	fp,
		DxfRegion *	region
	)

Read data from a DXF file into a DXF REGION entity.

The last line read from file contained the string "REGION".
Now follows some data for the REGION, to be terminated with a " 0" string announcing the following entity, or the end of the ENTITY section marker ENDSEC.
While parsing the DXF file store data in region.

Returns:: EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.

Parameters:

fp	DXF file pointer to an input file (or device).
region	a pointer to the DXF `REGION` entity.

Definition at line 159 of file region.c.

Here is the call graph for this function:

int dxf_region_write	(	DxfFile *	fp,
		DxfRegion *	region
	)

Write DXF output to a file for a DXF REGION entity.

Returns:: EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred while reading from the input file.

Todo:: for version R14.
Implementing the start of application-defined group "{application_name", with Group code 102.
For example: "{ACAD_REACTORS" indicates the start of the AutoCAD persistent reactors group.

application-defined codes: Group codes and values within the 102 groups are application defined (optional).

End of group, "}" (optional), with Group code 102.

Parameters:

fp	DXF file pointer to an output file (or device).
region	a pointer to the DXF `REGION` entity.

Definition at line 364 of file region.c.

int dxf_region_free ( DxfRegion * region )

Free the allocated memory for a DXF REGION and all it's data fields.

Returns:: EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to the memory occupied by the DXF REGION entity.

Definition at line 540 of file region.c.

References _, dxf_region_struct::additional_proprietary_data, dxf_region_struct::binary_graphics_data, dxf_region_struct::color_name, dxf_region_struct::dictionary_owner_hard, dxf_region_struct::dictionary_owner_soft, dxf_binary_graphics_data_free(), dxf_char_free_chain(), DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_region_struct::layer, dxf_region_struct::linetype, dxf_region_struct::material, dxf_region_struct::next, dxf_region_struct::plot_style_name, and dxf_region_struct::proprietary_data.

Referenced by dxf_region_free_chain().

Here is the call graph for this function:

void dxf_region_free_chain ( DxfRegion * regions )

Free the allocated memory for a chain of DXF REGION entities and all their data fields.

Parameters:

regions a pointer to the chain of DXF REGION entities.

Definition at line 589 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_region_free(), and dxf_region_struct::next.

Here is the call graph for this function:

int dxf_region_get_id_code ( DxfRegion * region )

Get the id_code from a DXF REGION entity.

Returns:: id_code.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 622 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::id_code.

DxfRegion* dxf_region_set_id_code	(	DxfRegion *	region,
		int	id_code
	)

Set the id_code for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
id_code	the `id_code` to be set for the entity. This is to be an unique (sequential) number in the DXF file.

Definition at line 656 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::id_code.

char* dxf_region_get_linetype ( DxfRegion * region )

Get the linetype from a DXF REGION entity.

Returns:: linetype when sucessful, NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 697 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::linetype.

DxfRegion* dxf_region_set_linetype	(	DxfRegion *	region,
		char *	linetype
	)

Set the linetype for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
linetype	a pointer to a string containing the `linetype` to be set for the entity.

Definition at line 732 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::linetype.

char* dxf_region_get_layer ( DxfRegion * region )

Get the layer from a DXF REGION entity.

Returns:: layer when sucessful, NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 773 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::layer.

DxfRegion* dxf_region_set_layer	(	DxfRegion *	region,
		char *	layer
	)

Set the layer for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
layer	a pointer to a string containing the `layer` to be set for the entity.

Definition at line 808 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::layer.

double dxf_region_get_elevation ( DxfRegion * region )

Get the elevation from a DXF REGION entity.

Returns:: elevation.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 849 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::elevation.

DxfRegion* dxf_region_set_elevation	(	DxfRegion *	region,
		double	elevation
	)

Set the elevation for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
elevation	the `elevation` to be set for the entity.

Definition at line 877 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::elevation.

double dxf_region_get_thickness ( DxfRegion * region )

Get the thickness from a DXF REGION entity.

Returns:: thickness.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 910 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::thickness.

DxfRegion* dxf_region_set_thickness	(	DxfRegion *	region,
		double	thickness
	)

Set the thickness for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
thickness	the `thickness` to be set for the entity.

Definition at line 945 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::thickness.

double dxf_region_get_linetype_scale ( DxfRegion * region )

Get the linetype_scale from a DXF REGION entity.

Returns:: linetype_scale.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 985 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::linetype_scale.

DxfRegion* dxf_region_set_linetype_scale	(	DxfRegion *	region,
		double	linetype_scale
	)

Set the linetype_scale for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
linetype_scale	the `linetype_scale` to be set for the entity.

Definition at line 1020 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::linetype_scale.

int16_t dxf_region_get_visibility ( DxfRegion * region )

Get the visibility from a DXF REGION entity.

Returns:: visibility.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1060 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::visibility.

DxfRegion* dxf_region_set_visibility	(	DxfRegion *	region,
		int16_t	visibility
	)

Set the visibility for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
visibility	the `visibility` to be set for the entity.

Definition at line 1102 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::visibility.

int dxf_region_get_color ( DxfRegion * region )

Get the color from a DXF REGION entity.

Returns:: color.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1149 of file region.c.

References _, dxf_region_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_color	(	DxfRegion *	region,
		int	color
	)

Set the color for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
color	the `color` to be set for the entity.

Definition at line 1183 of file region.c.

References _, dxf_region_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_region_get_paperspace ( DxfRegion * region )

Get the paperspace flag value from a DXF REGION entity.

Returns:: paperspace flag value.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1222 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::paperspace.

DxfRegion* dxf_region_set_paperspace	(	DxfRegion *	region,
		int	paperspace
	)

Set the paperspace flag for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
paperspace	the `paperspace` flag value to be set for the entity.

Definition at line 1262 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::paperspace.

int dxf_region_get_graphics_data_size ( DxfRegion * region )

Get the graphics_data_size value from a DXF REGION entity.

Returns:: graphics_data_size value when successful, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1312 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::graphics_data_size.

DxfRegion* dxf_region_set_graphics_data_size	(	DxfRegion *	region,
		int	graphics_data_size
	)

Set the graphics_data_size value for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
graphics_data_size	the `graphics_data_size` value to be set for the entity.

Definition at line 1355 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::graphics_data_size.

int16_t dxf_region_get_shadow_mode ( DxfRegion * region )

Get the shadow_mode from a DXF REGION entity.

Returns:: shadow_mode when successful, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1403 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::shadow_mode.

DxfRegion* dxf_region_set_shadow_mode	(	DxfRegion *	region,
		int16_t	shadow_mode
	)

Set the shadow_mode for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
shadow_mode	the `shadow_mode` to be set for the entity.

Definition at line 1448 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::shadow_mode.

DxfBinaryGraphicsData* dxf_region_get_binary_graphics_data ( DxfRegion * region )

Get the pointer to the binary_graphics_data from a DXF REGION entity.

Returns:: pointer to the binary_graphics_data.

Warning:: No checks are performed on the returned pointer.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1498 of file region.c.

References _, dxf_region_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_binary_graphics_data	(	DxfRegion *	region,
		DxfBinaryGraphicsData *	data
	)

Set the pointer to the binary_graphics_data for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
data	a string containing the pointer to the `binary_graphics_data` for the entity.

Definition at line 1534 of file region.c.

References _, dxf_region_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_region_get_dictionary_owner_soft ( DxfRegion * region )

Get the pointer to the dictionary_owner_soft from a DXF REGION entity.

Returns:: pointer to the dictionary_owner_soft.

Warning:: No checks are performed on the returned pointer (string).

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1578 of file region.c.

References _, dxf_region_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_dictionary_owner_soft	(	DxfRegion *	region,
		char *	dictionary_owner_soft
	)

Set the pointer to the dictionary_owner_soft for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
dictionary_owner_soft	a string containing the pointer to the `dictionary_owner_soft` for the entity.

Definition at line 1614 of file region.c.

References _, dxf_region_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_region_get_material ( DxfRegion * region )

Get the pointer to the material from a DXF REGION entity.

Returns:: a pointer to material when successful, or NULL when an error occurred.

Warning:: No checks are performed on the returned pointer.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1658 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::material.

DxfRegion* dxf_region_set_material	(	DxfRegion *	region,
		char *	material
	)

Set the pointer to the material for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
material	a string containing the pointer to the `material` for the entity.

Definition at line 1696 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::material.

char* dxf_region_get_dictionary_owner_hard ( DxfRegion * region )

Get the pointer to the dictionary_owner_hard from a DXF REGION entity.

Returns:: pointer to the dictionary_owner_hard.

Warning:: No checks are performed on the returned pointer (string).

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1740 of file region.c.

References _, dxf_region_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_dictionary_owner_hard	(	DxfRegion *	region,
		char *	dictionary_owner_hard
	)

Set the pointer to the dictionary_owner_hard for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
dictionary_owner_hard	a string containing the pointer to the `dictionary_owner_hard` for the entity.

Definition at line 1776 of file region.c.

References _, dxf_region_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int16_t dxf_region_get_lineweight ( DxfRegion * region )

Get the lineweight from a DXF REGION entity.

Returns:: lineweight when successful, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1818 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::lineweight.

DxfRegion* dxf_region_set_lineweight	(	DxfRegion *	region,
		int16_t	lineweight
	)

Set the lineweight for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
lineweight	the `lineweight` to be set for the entity.

Definition at line 1849 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::lineweight.

char* dxf_region_get_plot_style_name ( DxfRegion * region )

Get the plot_style_name from a DXF REGION entity.

Returns:: a pointer to plot_style_name when sucessful, or NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1883 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::plot_style_name.

DxfRegion* dxf_region_set_plot_style_name	(	DxfRegion *	region,
		char *	plot_style_name
	)

Set the plot_style_name for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
plot_style_name	a string containing the `plot_style_name` for the entity.

Definition at line 1921 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::plot_style_name.

long dxf_region_get_color_value ( DxfRegion * region )

Get the color_value from a DXF REGION entity.

Returns:: color_value when successful, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 1963 of file region.c.

References _, dxf_region_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_color_value	(	DxfRegion *	region,
		long	color_value
	)

Set the color_value for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
color_value	the `color_value` to be set for the entity.

Definition at line 1994 of file region.c.

References _, dxf_region_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_region_get_color_name ( DxfRegion * region )

Get the color_name from a DXF REGION entity.

Returns:: color_name when sucessful, or NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2028 of file region.c.

References _, dxf_region_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfRegion* dxf_region_set_color_name	(	DxfRegion *	region,
		char *	color_name
	)

Set the color_name for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
color_name	a string containing the `color_name` for the entity.

Definition at line 2066 of file region.c.

References _, dxf_region_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

long dxf_region_get_transparency ( DxfRegion * region )

Get the transparency from a DXF REGION entity.

Returns:: transparency when successful, or EXIT_FAILURE when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2108 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::transparency.

DxfRegion* dxf_region_set_transparency	(	DxfRegion *	region,
		long	transparency
	)

Set the transparency for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
transparency	the `transparency` to be set for the entity.

Definition at line 2139 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::transparency.

DxfChar* dxf_region_get_proprietary_data ( DxfRegion * region )

Get the proprietary_data from a DXF REGION entity.

Returns:: proprietary_data when sucessful, or NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2173 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_region_struct::proprietary_data, and dxf_char_struct::value.

DxfRegion* dxf_region_set_proprietary_data	(	DxfRegion *	region,
		DxfChar *	proprietary_data
	)

Set the proprietary_data for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
proprietary_data	a pointer containing the `proprietary_data` for the entity.

Definition at line 2218 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_region_struct::proprietary_data, and dxf_char_struct::value.

DxfChar* dxf_region_get_additional_proprietary_data ( DxfRegion * region )

Get the additional_proprietary_data from a DXF REGION entity.

Returns:: additional_proprietary_data when sucessful, or NULL when an error occurred.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2268 of file region.c.

References _, dxf_region_struct::additional_proprietary_data, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_char_struct::value.

DxfRegion* dxf_region_set_additional_proprietary_data	(	DxfRegion *	region,
		DxfChar *	additional_proprietary_data
	)

Set the additional_proprietary_data for a DXF REGION entity.

Returns:: a pointer to region when successful, or NULL when an error occurred.

Parameters:

region	a pointer to a DXF `REGION` entity.
additional_proprietary_data	a pointer containing the `additional_proprietary_data` for the entity.

Definition at line 2314 of file region.c.

References _, dxf_region_struct::additional_proprietary_data, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_char_struct::value.

int dxf_region_get_modeler_format_version_number ( DxfRegion * region )

Get the modeler_format_version_number from a DXF REGION entity.

Returns:: modeler_format_version_number.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2363 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::modeler_format_version_number.

DxfRegion* dxf_region_set_modeler_format_version_number	(	DxfRegion *	region,
		int	modeler_format_version_number
	)

Set the modeler_format_version_number for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
modeler_format_version_number	the `modeler_format_version_number` to be set for the entity.

Definition at line 2398 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::modeler_format_version_number.

DxfRegion* dxf_region_get_next ( DxfRegion * region )

Get the pointer to the next REGION entity from a DXF REGION entity.

Returns:: pointer to the next REGION entity.

Warning:: No checks are performed on the returned pointer.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2441 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::next.

DxfRegion* dxf_region_set_next	(	DxfRegion *	region,
		DxfRegion *	next
	)

Set the pointer to the next REGION for a DXF REGION entity.

Parameters:

region	a pointer to a DXF `REGION` entity.
next	a pointer to the next `REGION` for the entity.

Definition at line 2477 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::next.

DxfRegion* dxf_region_get_last ( DxfRegion * region )

Get the pointer to the last REGION entity from a linked list of DXF REGION entities.

Returns:: pointer to the last REGION entity.

Warning:: No checks are performed on the returned pointer.

Parameters:

region a pointer to a DXF REGION entity.

Definition at line 2520 of file region.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_region_struct::next.

region.h File Reference

Data Structures

Typedefs

Functions

Detailed Description

Copyright Notices.

Typedef Documentation

Function Documentation