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

spatial_filter.c File Reference

Functions for a DXF spatial_filter object (SPATIAL_FILTER). More...

#include "spatial_filter.h"
Include dependency graph for spatial_filter.c:

Go to the source code of this file.

Functions

DxfSpatialFilter * dxf_spatial_filter_new ()
 Allocate memory for a DxfSpatialFilter.
DxfSpatialFilter * dxf_spatial_filter_init (DxfSpatialFilter *spatial_filter)
 Allocate memory and initialize data fields in a SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_read (DxfFile *fp, DxfSpatialFilter *spatial_filter)
 Read data from a DXF file into a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_write (DxfFile *fp, DxfSpatialFilter *spatial_filter)
 Write DXF output to a file for a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_free (DxfSpatialFilter *spatial_filter)
 Free the allocated memory for a DXF SPATIAL_FILTER and all it's data fields.
void dxf_spatial_filter_free_chain (DxfSpatialFilter *spatial_filters)
 Free the allocated memory for a chain of DXF SPATIAL_FILTER objects and all their data fields.
int dxf_spatial_filter_get_id_code (DxfSpatialFilter *spatial_filter)
 Get the id_code from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_id_code (DxfSpatialFilter *spatial_filter, int id_code)
 Set the id_code for a DXF SPATIAL_FILTER object.
char * dxf_spatial_filter_get_dictionary_owner_soft (DxfSpatialFilter *spatial_filter)
 Get the pointer to the dictionary_owner_soft from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_dictionary_owner_soft (DxfSpatialFilter *spatial_filter, char *dictionary_owner_soft)
 Set the pointer to the dictionary_owner_soft for a DXF SPATIAL_FILTER object.
char * dxf_spatial_filter_get_dictionary_owner_hard (DxfSpatialFilter *spatial_filter)
 Get the pointer to the dictionary_owner_hard from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_dictionary_owner_hard (DxfSpatialFilter *spatial_filter, char *dictionary_owner_hard)
 Set the pointer to the dictionary_owner_hard for a DXF SPATIAL_FILTER object.
DxfPoint * dxf_spatial_filter_get_p0 (DxfSpatialFilter *spatial_filter)
 Get the clip boundary definition point p0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_p0 (DxfSpatialFilter *spatial_filter, DxfPoint *p0)
 Set the clip boundary definition point p0 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_x0 (DxfSpatialFilter *spatial_filter)
 Get the X-value of the clip boundary definition point x0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_x0 (DxfSpatialFilter *spatial_filter, double x0)
 Set the X-value of the clip boundary definition point x0 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_y0 (DxfSpatialFilter *spatial_filter)
 Get the Y-value of the clip boundary definition point y0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_y0 (DxfSpatialFilter *spatial_filter, double y0)
 Set the Y-value of the clip boundary definition point y0 of a DXF SPATIAL_FILTER object.
DxfPoint * dxf_spatial_filter_get_p0_next (DxfPoint *p0)
 Get the next clip boundary definition point p0 of a DXF SPATIAL_FILTER object.
DxfPoint * dxf_spatial_filter_set_p0_next (DxfPoint *p0, DxfPoint *next)
 Set the next point for a clip boundary definition point p0 of a DXF SPATIAL_FILTER object.
DxfPoint * dxf_spatial_filter_get_p1 (DxfSpatialFilter *spatial_filter)
 Get the origin used to define the local coordinate system of the clip boundary p1 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_p1 (DxfSpatialFilter *spatial_filter, DxfPoint *p1)
 Set the origin used to define the local coordinate system of the clip boundary p1 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_x1 (DxfSpatialFilter *spatial_filter)
 Get the X-value of the origin used to define the local coordinate system of the clip boundary x1 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_x1 (DxfSpatialFilter *spatial_filter, double x1)
 Set the X-value of the origin used to define the local coordinate system of the clip boundary x1 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_y1 (DxfSpatialFilter *spatial_filter)
 Get the Y-value of the origin used to define the local coordinate system of the clip boundary y1 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_y1 (DxfSpatialFilter *spatial_filter, double y1)
 Set the Y-value of the origin used to define the local coordinate system of the clip boundary y1 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_z1 (DxfSpatialFilter *spatial_filter)
 Get the Z-value of the origin used to define the local coordinate system of the clip boundary z1 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_z1 (DxfSpatialFilter *spatial_filter, double z1)
 Set the Z-value of the origin used to define the local coordinate system of the clip boundary z1 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_front_clipping_plane_distance (DxfSpatialFilter *spatial_filter)
 Get the front clipping plane distance front_clipping_plane_distance of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_front_clipping_plane_distance (DxfSpatialFilter *spatial_filter, double front_clipping_plane_distance)
 Set the front clipping plane distance front_clipping_plane_distance of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_back_clipping_plane_distance (DxfSpatialFilter *spatial_filter)
 Get the back clipping plane distance back_clipping_plane_distance of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_back_clipping_plane_distance (DxfSpatialFilter *spatial_filter, double back_clipping_plane_distance)
 Set the back clipping plane distance back_clipping_plane_distance of a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_get_number_of_points (DxfSpatialFilter *spatial_filter)
 Get the number_of_points from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_number_of_points (DxfSpatialFilter *spatial_filter, int number_of_points)
 Set the number_of_points for a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_get_clip_boundary_display_flag (DxfSpatialFilter *spatial_filter)
 Get the clip_boundary_display_flag from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_clip_boundary_display_flag (DxfSpatialFilter *spatial_filter, int clip_boundary_display_flag)
 Set the clip_boundary_display_flag for a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_get_front_clipping_plane_flag (DxfSpatialFilter *spatial_filter)
 Get the front_clipping_plane_flag from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_front_clipping_plane_flag (DxfSpatialFilter *spatial_filter, int front_clipping_plane_flag)
 Set the front_clipping_plane_flag for a DXF SPATIAL_FILTER object.
int dxf_spatial_filter_get_back_clipping_plane_flag (DxfSpatialFilter *spatial_filter)
 Get the back_clipping_plane_flag from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_back_clipping_plane_flag (DxfSpatialFilter *spatial_filter, int back_clipping_plane_flag)
 Set the back_clipping_plane_flag for a DXF SPATIAL_FILTER object.
DxfPoint * dxf_spatial_filter_get_extrusion_vector_as_point (DxfSpatialFilter *spatial_filter)
 Get the extrusion vector as a DXF POINT entity from a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_extr_x0 (DxfSpatialFilter *spatial_filter)
 Get the X-value of the extrusion vector extr_x0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_extr_x0 (DxfSpatialFilter *spatial_filter, double extr_x0)
 Set the X-value of the extrusion vector extr_x0 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_extr_y0 (DxfSpatialFilter *spatial_filter)
 Get the Y-value of the extrusion vector extr_y0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_extr_y0 (DxfSpatialFilter *spatial_filter, double extr_y0)
 Set the Y-value of the extrusion vector extr_y0 of a DXF SPATIAL_FILTER object.
double dxf_spatial_filter_get_extr_z0 (DxfSpatialFilter *spatial_filter)
 Get the Z-value of the extrusion vector extr_z0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_extr_z0 (DxfSpatialFilter *spatial_filter, double extr_z0)
 Set the Z-value of the extrusion vector extr_z0 of a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_get_next (DxfSpatialFilter *spatial_filter)
 Get the pointer to the next SPATIAL_FILTER object from a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_set_next (DxfSpatialFilter *spatial_filter, DxfSpatialFilter *next)
 Set the pointer to the next SPATIAL_FILTER object for a DXF SPATIAL_FILTER object.
DxfSpatialFilter * dxf_spatial_filter_get_last (DxfSpatialFilter *spatial_filter)
 Get the pointer to the last SPATIAL_FILTER object from a linked list of DXF SPATIAL_FILTER objects.

Detailed Description

Functions for a DXF spatial_filter object (SPATIAL_FILTER).

Author:
Copyright (C) 2015, 2017 by Bert Timmerman <bert.timmerman@xs4all.nl>.
Since:
The SPATIAL_FILTER object was introduced in DXF R14.
Version:
According to DXF R10 (backward compatibility).
According to DXF R11 (backward compatibility).
According to DXF R12 (backward compatibility).
According to DXF R13 (backward compatibility).
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 spatial_filter.c.

Function Documentation

DxfSpatialFilter* dxf_spatial_filter_new ( )

Allocate memory for a DxfSpatialFilter.

Fill the memory contents with zeros.

Definition at line 52 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_spatial_filter_init(), and dxf_spatial_filter_read().

DxfSpatialFilter* dxf_spatial_filter_init ( DxfSpatialFilter *  spatial_filter)

Allocate memory and initialize data fields in a SPATIAL_FILTER object.

Returns:
NULL when no memory was allocated, a pointer to the allocated memory when succesful.
Parameters:
spatial_filtera pointer to the DXF SPATIAL_FILTER object.

Definition at line 90 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::back_clipping_plane_distance, dxf_spatial_filter_struct::back_clipping_plane_flag, dxf_spatial_filter_struct::block_transformation, dxf_spatial_filter_struct::clip_boundary_display_flag, dxf_spatial_filter_struct::dictionary_owner_hard, dxf_spatial_filter_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_init(), dxf_point_new(), dxf_spatial_filter_new(), dxf_spatial_filter_struct::extr_x0, dxf_spatial_filter_struct::extr_y0, dxf_spatial_filter_struct::extr_z0, dxf_spatial_filter_struct::front_clipping_plane_distance, dxf_spatial_filter_struct::front_clipping_plane_flag, dxf_spatial_filter_struct::id_code, dxf_spatial_filter_struct::inverse_block_transformation, dxf_spatial_filter_struct::next, dxf_spatial_filter_struct::number_of_points, dxf_spatial_filter_struct::p0, dxf_spatial_filter_struct::p1, dxf_point_struct::x0, dxf_point_struct::y0, and dxf_point_struct::z0.

Referenced by dxf_spatial_filter_read().

Here is the call graph for this function:

DxfSpatialFilter* dxf_spatial_filter_read ( DxfFile *  fp,
DxfSpatialFilter *  spatial_filter 
)

Read data from a DXF file into a DXF SPATIAL_FILTER object.

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

Returns:
a pointer to spatial_filter.
Parameters:
fpDXF file pointer to an input file (or device).
spatial_filtera pointer to the DXF SPATIAL_FILTER object.

Definition at line 162 of file spatial_filter.c.

References _, dxf_file_struct::acad_version_number, AutoCAD_13, AutoCAD_14, dxf_spatial_filter_struct::back_clipping_plane_distance, dxf_spatial_filter_struct::back_clipping_plane_flag, dxf_spatial_filter_struct::block_transformation, dxf_spatial_filter_struct::clip_boundary_display_flag, dxf_spatial_filter_struct::dictionary_owner_hard, dxf_spatial_filter_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_init(), dxf_spatial_filter_init(), dxf_spatial_filter_new(), dxf_spatial_filter_struct::extr_x0, dxf_spatial_filter_struct::extr_y0, dxf_spatial_filter_struct::extr_z0, dxf_file_struct::filename, dxf_file_struct::fp, dxf_spatial_filter_struct::front_clipping_plane_distance, dxf_spatial_filter_struct::front_clipping_plane_flag, dxf_spatial_filter_struct::id_code, dxf_spatial_filter_struct::inverse_block_transformation, dxf_file_struct::line_number, dxf_point_struct::next, dxf_spatial_filter_struct::number_of_points, dxf_spatial_filter_struct::p0, dxf_spatial_filter_struct::p1, dxf_point_struct::x0, dxf_point_struct::y0, and dxf_point_struct::z0.

Here is the call graph for this function:

int dxf_spatial_filter_write ( DxfFile *  fp,
DxfSpatialFilter *  spatial_filter 
)

Write DXF output to a file for a DXF SPATIAL_FILTER object.

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

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:
fpDXF file pointer to an output file (or device).
spatial_filtera pointer to the DXF SPATIAL_FILTER object.

Definition at line 418 of file spatial_filter.c.

References _, dxf_file_struct::acad_version_number, AutoCAD_12, AutoCAD_13, AutoCAD_14, dxf_spatial_filter_struct::back_clipping_plane_distance, dxf_spatial_filter_struct::back_clipping_plane_flag, dxf_spatial_filter_struct::block_transformation, dxf_spatial_filter_struct::clip_boundary_display_flag, dxf_spatial_filter_struct::dictionary_owner_hard, dxf_spatial_filter_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::extr_x0, dxf_spatial_filter_struct::extr_y0, dxf_spatial_filter_struct::extr_z0, dxf_file_struct::fp, dxf_spatial_filter_struct::front_clipping_plane_distance, dxf_spatial_filter_struct::front_clipping_plane_flag, dxf_spatial_filter_struct::id_code, dxf_spatial_filter_struct::inverse_block_transformation, dxf_point_struct::next, dxf_spatial_filter_struct::number_of_points, dxf_spatial_filter_struct::p0, dxf_spatial_filter_struct::p1, dxf_point_struct::x0, dxf_point_struct::y0, and dxf_point_struct::z0.

int dxf_spatial_filter_free ( DxfSpatialFilter *  spatial_filter)

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

Returns:
EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.
Parameters:
spatial_filtera pointer to the memory occupied by the DXF SPATIAL_FILTER object.

Definition at line 564 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::dictionary_owner_hard, dxf_spatial_filter_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::next.

Referenced by dxf_spatial_filter_free_chain().

void dxf_spatial_filter_free_chain ( DxfSpatialFilter *  spatial_filters)

Free the allocated memory for a chain of DXF SPATIAL_FILTER objects and all their data fields.

Parameters:
spatial_filtersa pointer to the chain of DXF SPATIAL_FILTER objects.

Definition at line 605 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_free(), and dxf_spatial_filter_struct::next.

Here is the call graph for this function:

int dxf_spatial_filter_get_id_code ( DxfSpatialFilter *  spatial_filter)

Get the id_code from a DXF SPATIAL_FILTER object.

Returns:
id_code.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 638 of file spatial_filter.c.

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

DxfSpatialFilter* dxf_spatial_filter_set_id_code ( DxfSpatialFilter *  spatial_filter,
int  id_code 
)

Set the id_code for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
id_codethe id_code to be set for the object.
This is to be an unique (sequential) number in the DXF file.

Definition at line 672 of file spatial_filter.c.

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

char* dxf_spatial_filter_get_dictionary_owner_soft ( DxfSpatialFilter *  spatial_filter)

Get the pointer to the dictionary_owner_soft from a DXF SPATIAL_FILTER object.

Returns:
pointer to the dictionary_owner_soft.
Warning:
No checks are performed on the returned pointer (string).
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 716 of file spatial_filter.c.

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

DxfSpatialFilter* dxf_spatial_filter_set_dictionary_owner_soft ( DxfSpatialFilter *  spatial_filter,
char *  dictionary_owner_soft 
)

Set the pointer to the dictionary_owner_soft for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
dictionary_owner_softa string containing the pointer to the dictionary_owner_soft for the object.

Definition at line 752 of file spatial_filter.c.

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

char* dxf_spatial_filter_get_dictionary_owner_hard ( DxfSpatialFilter *  spatial_filter)

Get the pointer to the dictionary_owner_hard from a DXF SPATIAL_FILTER object.

Returns:
pointer to the dictionary_owner_hard.
Warning:
No checks are performed on the returned pointer (string).
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 796 of file spatial_filter.c.

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

DxfSpatialFilter* dxf_spatial_filter_set_dictionary_owner_hard ( DxfSpatialFilter *  spatial_filter,
char *  dictionary_owner_hard 
)

Set the pointer to the dictionary_owner_hard for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
dictionary_owner_harda string containing the pointer to the dictionary_owner_hard for the object.

Definition at line 832 of file spatial_filter.c.

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

DxfPoint* dxf_spatial_filter_get_p0 ( DxfSpatialFilter *  spatial_filter)

Get the clip boundary definition point p0 of a DXF SPATIAL_FILTER object.

Returns:
the clip boundary definition point p0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 874 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::p0.

DxfSpatialFilter* dxf_spatial_filter_set_p0 ( DxfSpatialFilter *  spatial_filter,
DxfPoint *  p0 
)

Set the clip boundary definition point p0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to a DXF SPATIAL_FILTER object.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
p0a pointer to a DXF POINT entity.

Definition at line 912 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::p0.

double dxf_spatial_filter_get_x0 ( DxfSpatialFilter *  spatial_filter)

Get the X-value of the clip boundary definition point x0 of a DXF SPATIAL_FILTER object.

Returns:
the X-value of the clip boundary definition point x0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 953 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p0, and dxf_point_struct::x0.

DxfSpatialFilter* dxf_spatial_filter_set_x0 ( DxfSpatialFilter *  spatial_filter,
double  x0 
)

Set the X-value of the clip boundary definition point x0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
x0the X-value of the clip boundary definition point x0 of a DXF SPATIAL_FILTER object.

Definition at line 993 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p0, dxf_spatial_filter_struct::x0, and dxf_point_struct::x0.

double dxf_spatial_filter_get_y0 ( DxfSpatialFilter *  spatial_filter)

Get the Y-value of the clip boundary definition point y0 of a DXF SPATIAL_FILTER object.

Returns:
the Y-value of the clip boundary definition point y0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1035 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p0, and dxf_point_struct::y0.

DxfSpatialFilter* dxf_spatial_filter_set_y0 ( DxfSpatialFilter *  spatial_filter,
double  y0 
)

Set the Y-value of the clip boundary definition point y0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
y0the Y-value of the clip boundary definition point y0 of a DXF SPATIAL_FILTER object.

Definition at line 1075 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p0, dxf_spatial_filter_struct::y0, and dxf_point_struct::y0.

DxfPoint* dxf_spatial_filter_get_p0_next ( DxfPoint *  p0)

Get the next clip boundary definition point p0 of a DXF SPATIAL_FILTER object.

Returns:
the next clip boundary definition point p0.
Todo:
This function can be replaced by dxf_point_get_next().
Parameters:
p0a pointer to a DXF POINT entity.

Definition at line 1119 of file spatial_filter.c.

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

DxfPoint* dxf_spatial_filter_set_p0_next ( DxfPoint *  p0,
DxfPoint *  next 
)

Set the next point for a clip boundary definition point p0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to p0 when successful, or NULL when an error occurred.
Todo:
This function can be replaced by dxf_point_set_next().
Parameters:
p0a pointer to a DXF POINT entity.
nextthe next clip boundary definition point for a DXF SPATIAL_FILTER object.

Definition at line 1161 of file spatial_filter.c.

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

DxfPoint* dxf_spatial_filter_get_p1 ( DxfSpatialFilter *  spatial_filter)

Get the origin used to define the local coordinate system of the clip boundary p1 of a DXF SPATIAL_FILTER object.

Returns:
the origin point p1.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1203 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::p1.

DxfSpatialFilter* dxf_spatial_filter_set_p1 ( DxfSpatialFilter *  spatial_filter,
DxfPoint *  p1 
)

Set the origin used to define the local coordinate system of the clip boundary p1 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to a DXF SPATIAL_FILTER object.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
p1a pointer to a DXF POINT entity.

Definition at line 1241 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::p1.

double dxf_spatial_filter_get_x1 ( DxfSpatialFilter *  spatial_filter)

Get the X-value of the origin used to define the local coordinate system of the clip boundary x1 of a DXF SPATIAL_FILTER object.

Returns:
the X-value of the origin used to define the local coordinate system of the clip boundary x1.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1284 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::x0.

DxfSpatialFilter* dxf_spatial_filter_set_x1 ( DxfSpatialFilter *  spatial_filter,
double  x1 
)

Set the X-value of the origin used to define the local coordinate system of the clip boundary x1 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
x1the X-value of the origin used to define the local coordinate system of the clip boundary x1 of a DXF SPATIAL_FILTER object.

Definition at line 1325 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::x0.

double dxf_spatial_filter_get_y1 ( DxfSpatialFilter *  spatial_filter)

Get the Y-value of the origin used to define the local coordinate system of the clip boundary y1 of a DXF SPATIAL_FILTER object.

Returns:
the Y-value of the origin used to define the local coordinate system of the clip boundary y1.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1370 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::y0.

DxfSpatialFilter* dxf_spatial_filter_set_y1 ( DxfSpatialFilter *  spatial_filter,
double  y1 
)

Set the Y-value of the origin used to define the local coordinate system of the clip boundary y1 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
y1the Y-value of the origin used to define the local coordinate system of the clip boundary y1 of a DXF SPATIAL_FILTER object.

Definition at line 1411 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::y0.

double dxf_spatial_filter_get_z1 ( DxfSpatialFilter *  spatial_filter)

Get the Z-value of the origin used to define the local coordinate system of the clip boundary z1 of a DXF SPATIAL_FILTER object.

Returns:
the Z-value of the origin used to define the local coordinate system of the clip boundary z1.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1456 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::z0.

DxfSpatialFilter* dxf_spatial_filter_set_z1 ( DxfSpatialFilter *  spatial_filter,
double  z1 
)

Set the Z-value of the origin used to define the local coordinate system of the clip boundary z1 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
z1the Z-value of the origin used to define the local coordinate system of the clip boundary z1 of a DXF SPATIAL_FILTER object.

Definition at line 1497 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_spatial_filter_struct::p1, and dxf_point_struct::z0.

double dxf_spatial_filter_get_front_clipping_plane_distance ( DxfSpatialFilter *  spatial_filter)

Get the front clipping plane distance front_clipping_plane_distance of a DXF SPATIAL_FILTER object.

Todo:
Add dxf_spatial_filter_get_inverse_block_transformation().
Todo:
Add dxf_spatial_filter_set_inverse_block_transformation().
Todo:
Add dxf_spatial_filter_get_block_transformation().
Todo:
Add dxf_spatial_filter_set_block_transformation().
Returns:
the front clipping plane distance front_clipping_plane_distance.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1561 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::front_clipping_plane_distance.

DxfSpatialFilter* dxf_spatial_filter_set_front_clipping_plane_distance ( DxfSpatialFilter *  spatial_filter,
double  front_clipping_plane_distance 
)

Set the front clipping plane distance front_clipping_plane_distance of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
front_clipping_plane_distancethe front clipping plane distance front_clipping_plane_distance to be set for a DXF SPATIAL_FILTER object.

Definition at line 1594 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::front_clipping_plane_distance.

double dxf_spatial_filter_get_back_clipping_plane_distance ( DxfSpatialFilter *  spatial_filter)

Get the back clipping plane distance back_clipping_plane_distance of a DXF SPATIAL_FILTER object.

Returns:
the back clipping plane distance fback_clipping_plane_distance.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1631 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::back_clipping_plane_distance, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfSpatialFilter* dxf_spatial_filter_set_back_clipping_plane_distance ( DxfSpatialFilter *  spatial_filter,
double  back_clipping_plane_distance 
)

Set the back clipping plane distance back_clipping_plane_distance of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
back_clipping_plane_distancethe back clipping plane distance back_clipping_plane_distance to be set for a DXF SPATIAL_FILTER object.

Definition at line 1664 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::back_clipping_plane_distance, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_spatial_filter_get_number_of_points ( DxfSpatialFilter *  spatial_filter)

Get the number_of_points from a DXF SPATIAL_FILTER object.

Returns:
number_of_points.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1700 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::number_of_points.

DxfSpatialFilter* dxf_spatial_filter_set_number_of_points ( DxfSpatialFilter *  spatial_filter,
int  number_of_points 
)

Set the number_of_points for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
number_of_pointsthe number_of_points to be set for the object.

Definition at line 1734 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::number_of_points.

int dxf_spatial_filter_get_clip_boundary_display_flag ( DxfSpatialFilter *  spatial_filter)

Get the clip_boundary_display_flag from a DXF SPATIAL_FILTER object.

Returns:
clip_boundary_display_flag.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1774 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::clip_boundary_display_flag, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfSpatialFilter* dxf_spatial_filter_set_clip_boundary_display_flag ( DxfSpatialFilter *  spatial_filter,
int  clip_boundary_display_flag 
)

Set the clip_boundary_display_flag for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
clip_boundary_display_flagthe clip_boundary_display_flag to be set for the object.

Definition at line 1815 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::clip_boundary_display_flag, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_spatial_filter_get_front_clipping_plane_flag ( DxfSpatialFilter *  spatial_filter)

Get the front_clipping_plane_flag from a DXF SPATIAL_FILTER object.

Returns:
front_clipping_plane_flag.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1862 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::front_clipping_plane_flag.

DxfSpatialFilter* dxf_spatial_filter_set_front_clipping_plane_flag ( DxfSpatialFilter *  spatial_filter,
int  front_clipping_plane_flag 
)

Set the front_clipping_plane_flag for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
front_clipping_plane_flagthe front_clipping_plane_flag to be set for the object.

Definition at line 1903 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::front_clipping_plane_flag.

int dxf_spatial_filter_get_back_clipping_plane_flag ( DxfSpatialFilter *  spatial_filter)

Get the back_clipping_plane_flag from a DXF SPATIAL_FILTER object.

Returns:
back_clipping_plane_flag.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 1950 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::back_clipping_plane_flag, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfSpatialFilter* dxf_spatial_filter_set_back_clipping_plane_flag ( DxfSpatialFilter *  spatial_filter,
int  back_clipping_plane_flag 
)

Set the back_clipping_plane_flag for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
back_clipping_plane_flagthe back_clipping_plane_flag to be set for the object.

Definition at line 1991 of file spatial_filter.c.

References _, dxf_spatial_filter_struct::back_clipping_plane_flag, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfPoint* dxf_spatial_filter_get_extrusion_vector_as_point ( DxfSpatialFilter *  spatial_filter)

Get the extrusion vector as a DXF POINT entity from a DXF SPATIAL_FILTER object.

Returns:
a DXF POINT containing the extrusion coordinates.
Warning:
No other members are copied into the DXF POINT.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2040 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_init(), dxf_spatial_filter_struct::extr_x0, dxf_spatial_filter_struct::extr_y0, and dxf_spatial_filter_struct::extr_z0.

Here is the call graph for this function:

double dxf_spatial_filter_get_extr_x0 ( DxfSpatialFilter *  spatial_filter)

Get the X-value of the extrusion vector extr_x0 of a DXF SPATIAL_FILTER object.

Returns:
the X-value of the extrusion vector extr_x0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2084 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::extr_x0.

DxfSpatialFilter* dxf_spatial_filter_set_extr_x0 ( DxfSpatialFilter *  spatial_filter,
double  extr_x0 
)

Set the X-value of the extrusion vector extr_x0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
extr_x0the X-value of the extrusion vector extr_x0 of a DXF SPATIAL_FILTER object.

Definition at line 2117 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_struct::extr_x0, and dxf_spatial_filter_struct::extr_x0.

double dxf_spatial_filter_get_extr_y0 ( DxfSpatialFilter *  spatial_filter)

Get the Y-value of the extrusion vector extr_y0 of a DXF SPATIAL_FILTER object.

Returns:
the Y-value of the extrusion vector extr_x0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2152 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::extr_y0.

DxfSpatialFilter* dxf_spatial_filter_set_extr_y0 ( DxfSpatialFilter *  spatial_filter,
double  extr_y0 
)

Set the Y-value of the extrusion vector extr_y0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
extr_y0the Y-value of the extrusion vector extr_y0 of a DXF SPATIAL_FILTER object.

Definition at line 2185 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_struct::extr_y0, and dxf_spatial_filter_struct::extr_y0.

double dxf_spatial_filter_get_extr_z0 ( DxfSpatialFilter *  spatial_filter)

Get the Z-value of the extrusion vector extr_z0 of a DXF SPATIAL_FILTER object.

Returns:
the Z-value of the extrusion vector extr_z0.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2220 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_spatial_filter_struct::extr_z0.

DxfSpatialFilter* dxf_spatial_filter_set_extr_z0 ( DxfSpatialFilter *  spatial_filter,
double  extr_z0 
)

Set the Z-value of the extrusion vector extr_z0 of a DXF SPATIAL_FILTER object.

Returns:
a pointer to spatial_filter when successful, or NULL when an error occurred.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
extr_z0the Z-value of the extrusion vector extr_z0 of a DXF SPATIAL_FILTER object.

Definition at line 2253 of file spatial_filter.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_point_struct::extr_z0, and dxf_spatial_filter_struct::extr_z0.

DxfSpatialFilter* dxf_spatial_filter_get_next ( DxfSpatialFilter *  spatial_filter)

Get the pointer to the next SPATIAL_FILTER object from a DXF SPATIAL_FILTER object.

Returns:
pointer to the next SPATIAL_FILTER object.
Warning:
No checks are performed on the returned pointer.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2290 of file spatial_filter.c.

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

DxfSpatialFilter* dxf_spatial_filter_set_next ( DxfSpatialFilter *  spatial_filter,
DxfSpatialFilter *  next 
)

Set the pointer to the next SPATIAL_FILTER object for a DXF SPATIAL_FILTER object.

Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.
nexta pointer to the next SPATIAL_FILTER object for the object.

Definition at line 2326 of file spatial_filter.c.

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

DxfSpatialFilter* dxf_spatial_filter_get_last ( DxfSpatialFilter *  spatial_filter)

Get the pointer to the last SPATIAL_FILTER object from a linked list of DXF SPATIAL_FILTER objects.

Returns:
pointer to the last SPATIAL_FILTER object.
Warning:
No checks are performed on the returned pointer.
Parameters:
spatial_filtera pointer to a DXF SPATIAL_FILTER object.

Definition at line 2370 of file spatial_filter.c.

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

Generated on Sun Nov 19 2017 for libDXF by  doxygen 1.7.3