Entities reading

Functions
int	SPI_GEO_read_plane_elt (int pos)
	Reads the plan of a geometric entity.
int	SPI_GEO_read_normal_entity (int pos, double *normal)
	Reads the normal vector of an entity.
int	SPI_GEO_read_layer_elt (int pos)
	Reads the layer number of a geometric entity.
int	SPI_GEO_read_type_elt (int pos)
	Reads the type of a geometric entity.
int	SPI_GEO_read_color_elt (int pos)
	Reads the RGB color of a geometric entity.
int	SPI_GEO_read_RGB_color_elt (int pos, int *red, int *green, int *blue)
	Reads the red green blue color values of an entity.
int	SPI_GEO_read_linetype_elt (int pos)
	Reads the line type of a geometric entity.
int	SPI_GEO_read_linewidth_elt (int pos)
	Reads the line thickness of a geometric entity.
int	SPI_GEO_read_name_elt (std::string &name, int pos)
	Reads the name of a geometric entity.
int	SPI_GEO_read_params_elt (int nb, double *elt, int pos)
	Reads canonical forms of an entity.
int	SPI_GEO_read_extrema_elt (double *elt, int pos)
	Reads the extremities of a geometric element.
int	SPI_GEO_is_arc_trigo (int pos)
	Reads whether an arc is trigonometric or not.
int	SPI_GEO_read_mark_elt (int pos)
	Reads the marking of a geometric entity.
int	SPI_GEO_read_visi_elt (int pos)
	Reads the visibility of a geometric entity.
int	SPI_GEO_read_depth (double *depth, int pos)
	Reads the depth of a geometric entity (point, circle or arc)
int	SPI_GEO_read_bounding_box_elt (int planeNb, double *elt, int pos)
	Reads the bounding box of a geometric entity in a given plane.

Detailed Description

Entities reading

Function Documentation

SPI_GEO_is_arc_trigo()

int SPI_GEO_is_arc_trigo

(

int

pos

)

Reads whether an arc is trigonometric or not.

Version

5.5

Parameters

[in]

pos

position of the entity in the database

Returns

SPI_YES if counter clockwise | SPI_NO if clockwise

istrigo := ICALL(SPI_GEO_is_arc_trigo,ipos);

SPI_GEO_read_bounding_box_elt()

int SPI_GEO_read_bounding_box_elt	(	int	planeNb,
		double *	elt,
		int	pos )

Reads the bounding box of a geometric entity in a given plane.

Version

6.03

Parameters

[in]	pos	position of the entity in the database
[in]	planeNb	plane of bounding box (can be different from entity plane)
[out]	elt	bounding box

Returns

SPI_YES if Ok | SPI_NO if error

Remarks

elt[0] => Xmin, elt[1] => Ymin, elt[2] => Zmin
elt[3] => Xmax, elt[4] => Ymax, elt[5] => Zmax

ier := ICALL(SPI_GEO_read_bounding_box_elt,1,elt,ipos);

SPI_GEO_read_color_elt()

int SPI_GEO_read_color_elt

(

int

pos

)

Reads the RGB color of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

entity RGB color, current color if error

icol := ICALL(SPI_GEO_read_color_elt,ipos);

See also

SPI_GEO_write_color_elt

SPI_GEO_read_depth()

int SPI_GEO_read_depth	(	double *	depth,
		int	pos )

Reads the depth of a geometric entity (point, circle or arc)

Version

4.5

Parameters

[in]	pos	position of the entity in the database
[out]	depth	entity depth value

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_GEO_read_depth,depth,ipos);

See also

SPI_GEO_write_depth

SPI_GEO_read_extrema_elt()

int SPI_GEO_read_extrema_elt	(	double *	elt,
		int	pos )

Reads the extremities of a geometric element.

Parameters

[in]	pos	position of the entity in the database
[out]	elt	array of extremity

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_GEO_read_extrema_elt,elt,ipos);

SPI_GEO_read_layer_elt()

int SPI_GEO_read_layer_elt

(

int

pos

)

Reads the layer number of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

entity layer number, current layer if error

ilayer := ICALL(SPI_GEO_read_layer_elt,ipos);

See also

SPI_GEO_write_layer_elt

SPI_GEO_read_linetype_elt()

int SPI_GEO_read_linetype_elt

(

int

pos

)

Reads the line type of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

line type of the entity, current type if error

Remarks

predefined line type : SPI_LINETYPE_NORMAL
SPI_LINETYPE_AXES
SPI_LINETYPE_HIDDEN
SPI_LINETYPE_DOT
SPI_LINETYPE_DASHED
SPI_LINETYPE_DASHDOT
SPI_LINETYPE_DIVIDE
SPI_LINETYPE_PHANTOM

ilinetype := ICALL(SPI_GEO_read_linetype_elt,ipos);

See also

SPI_GEO_write_linetype_elt

SPI_GEO_read_linewidth_elt()

int SPI_GEO_read_linewidth_elt

(

int

pos

)

Reads the line thickness of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

entity line thickness, current thickness if error

Remarks

predefined line thicness : SPI_LINEWIDTH_NORMAL
SPI_LINEWIDTH_DOUBLE
SPI_LINEWIDTH_TRIPLE

ilinewidth := ICALL(SPI_GEO_read_linewidth_elt,ipos);

See also

SPI_GEO_write_linewidth_elt

SPI_GEO_read_mark_elt()

int SPI_GEO_read_mark_elt

(

int

pos

)

Reads the marking of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

SPI_YES if selected | SPI_NO if not

imark := ICALL(SPI_GEO_read_mark_elt,ipos);

See also

SPI_GEO_write_mark_elt, SPI_GEO_select_elt

SPI_GEO_read_name_elt()

int SPI_GEO_read_name_elt	(	std::string &	name,
		int	pos )

Reads the name of a geometric entity.

Parameters

[in]	pos	position of the entity in the database
[out]	name	entity name

Returns

SPI_YES if Ok | SPI_NO if error

ier := ICALL(SPI_GEO_read_name_elt,name,ipos);

See also

SPI_GEO_write_name_elt

SPI_GEO_read_normal_entity()

int SPI_GEO_read_normal_entity	(	int	pos,
		double *	normal )

Reads the normal vector of an entity.

Version

5.8

Parameters

[in]	pos	position of the entity in the database
[out]	normal	TR3 normal axis of the entity

Returns

SPI_YES/SPI_NO

ierr := ICALL(SPI_GEO_read_normal_entity,ipos,ZAxis);

SPI_GEO_read_params_elt()

int SPI_GEO_read_params_elt	(	int	nb,
		double *	elt,
		int	pos )

Reads canonical forms of an entity.

Parameters

[in]	nb	size of the table allocated by the user
[in]	pos	position of the entity in the database
[out]	elt	table of reals of canonical forms

Returns

SPI_YES if Ok | SPI_NO if error

Remarks

With VB, elt is define as VARIANT

ier := ICALL(SPI_GEO_read_params_elt,9,elt,ipos);

See also

SPI_GEO_write_params_elt

SPI_GEO_read_plane_elt()

int SPI_GEO_read_plane_elt

(

int

pos

)

Reads the plan of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

entity plan, current plan if error

iplan := ICALL(SPI_GEO_read_plane_elt,ipos);

See also

SPI_GEO_write_plane_elt

SPI_GEO_read_RGB_color_elt()

int SPI_GEO_read_RGB_color_elt	(	int	pos,
		int *	red,
		int *	green,
		int *	blue )

Reads the red green blue color values of an entity.

Version

5.5

Parameters

[in]	pos	position of the entity in the database
[out]	red	red value
[out]	green	green value
[out]	blue	blue value

Returns

SPI_YES/SPI_NO

Pascal example
ipos,red,green,blue : Integer;
{...}
ier := ICALL(SPI_GEO_read_RGB_color_elt,ipos,red,green,blue);
 
VB Example
dim RedVal as long
dim GreenVal as long
dim BlueVal as long
'...
ier = GOE.SPI_GEO_read_RGB_color_elt(ipos,RedVal,GreenVal,BlueVal)

SPI_GEO_read_type_elt()

int SPI_GEO_read_type_elt

(

int

pos

)

Reads the type of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

entity type, 0 if error

Remarks

Type list : SPI_ELTTYPE_POINT
SPI_ELTTYPE_SEGMENT
SPI_ELTTYPE_ARC
SPI_ELTTYPE_POLYGON
SPI_ELTTYPE_LINE
SPI_ELTTYPE_CIRCLE
SPI_ELTTYPE_RECTANGLE
SPI_ELTTYPE_3POINTS_PLANE
SPI_ELTTYPE_OBLONG
SPI_ELTTYPE_LINEAR_DIM
SPI_ELTTYPE_CIRCULAR_DIM
SPI_ELTTYPE_ANGULAR_DIM
SPI_ELTTYPE_AXIS_DIM
SPI_ELTTYPE_PROFIL_DIM
SPI_ELTTYPE_ARC_DIM
SPI_ELTTYPE_TEXT
SPI_ELTTYPE_TEXT_BLOCK
SPI_ELTTYPE_HATCHING
SPI_ELTTYPE_BLOCK
SPI_ELTTYPE_FRAME
SPI_ELTTYPE_SYMBOL
SPI_ELTTYPE_ORIGIN
SPI_ELTTYPE_X_AXIS
SPI_ELTTYPE_Y_AXIS
SPI_ELTTYPE_Z_AXIS
SPI_ELTTYPE_SOLID (5.8.200)
SPI_ELTTYPE_TRIHEDRON (6.9.200)

itype := ICALL(SPI_GEO_read_type_elt,ipos);

See also

SPI_GEO_write_type_elt

SPI_GEO_read_visi_elt()

int SPI_GEO_read_visi_elt

(

int

pos

)

Reads the visibility of a geometric entity.

Parameters

[in]

pos

position of the entity in the database

Returns

SPI_YES if visible | SPI_NO if not

ivisi := ICALL(SPI_GEO_read_visi_elt,ipos);

See also

SPI_GEO_write_visi_elt