Brief Index      Full Index      Events Index      I.M. Reference

Insert_Ink

Functions

HC_KEY Insert_Ink (double x, double y, double z)
HC_KEY DInsert_Ink (double x, double y, double z)

Function Documentation

HC_KEY Insert_Ink ( double  x,
double  y,
double  z 
)

Utility routine to extend the "currently-being-inked-in" polyline.

Parameters:
x- x-coordinate of the next place to "draw a line" to.
y- y-coordinate of the next place to "draw a line" to.
z- z-coordinate of the next place to "draw a line" to.
Returns:
The key to the inserted geometry, or -1 if an error occurred.

DETAILS

As a service to the user, each existing segment comes complete with a polyline that is "currently being inked" in. Technically, the first time you "insert ink" in a segment, the system creates a new polyline with just that one point in it. Each additional time you call Insert_Ink() , the system edits that polyline and extends it to include the new point. The effect is of being able to draw, without having to pack coordinates into point arrays.

Restart_Ink() closes the "currently being inked" polyline. The next time you call Insert_Ink, a fresh polyline is begun. Nothing else causes the inked polyline to be terminated, except of course a delete or a flush operation. In particular, if you close and later re-open the segment, a subsequent Insert_Ink() will resume right where you left off. And if you change attribute settings, the inked polyline will change just as any completed polyline would.

NOTES

If you only work in two dimensions, specify all the z coordinates as zero. The system will automatically take note. If you work in 3D, there is no need for all the points to be coplanar.

After the first call to Insert_Ink() in a segment - when there is only one point defined on the polyline - there may or may not be a single dot visible on the screen. It's implementation-dependent.

This function's double parameters are internally truncated to float. If you require extra precision, use this function's double-precision variant, DInsert_Infinite_Ink.

RESTRICTIONS

See also:
Restart_Ink, Insert_Line, Insert_Polyline, Insert_Polygon, Insert_Shell, Insert_Circular_Arc, Insert_Elliptical_Arc, Set_Line_Pattern, Set_Line_Weight.
HC_KEY DInsert_Ink ( double  x,
double  y,
double  z 
)

Similar to Insert_Ink() but accepts parameters of type double for increased precision. Unlike Insert_Ink, the parameters are not truncated.

Parameters:
x- x-coordinate of the next place to "draw a line" to.
y- y-coordinate of the next place to "draw a line" to.
z- z-coordinate of the next place to "draw a line" to.
Returns:
The key to the inserted geometry.

DETAILS

No additional details. See Insert_Ink().

Brief Index      Full Index      Events Index      I.M. Reference