Brief Index      Full Index      I.M. Reference

Insert_Ink


Functions

void Insert_Ink (double x, double y, double z)
HC_KEY KInsert_Ink (double x, double y, double z)
void QInsert_Ink (const char *segment, double x, double y, double z)
HC_KEY QKInsert_Ink (const char *segment, double x, double y, double z)
void DInsert_Ink (double x, double y, double z)
HC_KEY DKInsert_Ink (double x, double y, double z)
void DQInsert_Ink (const char *segment, double x, double y, double z)
HC_KEY DQKInsert_Ink (const char *segment, double x, double y, double z)

Function Documentation

void 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.

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 3-D, 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.

If there is an error the KInsert routine will return a-1.

RESTRICTIONS

See also:
Restart_Ink, Insert_Line, Insert_Polyline, Insert_Polygon, Insert_Shell, Insert_Circular_Arc, Insert_Elliptical_Arc, Set_Color, Set_Line_Pattern, Set_Line_Weight, Set_Visibility.

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

Similar to Insert_Ink(), but returns an HC_KEY to the object.

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:
key

DETAILS

No additional details. See Insert_Ink()

void QInsert_Ink ( const char *  segment,
double  x,
double  y,
double  z 
)

Similar to Insert_Ink(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
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.

DETAILS

No additional details. See Insert_Ink()

HC_KEY QKInsert_Ink ( const char *  segment,
double  x,
double  y,
double  z 
)

Similar to Insert_Ink(), but operates on a given segment and returns an HC_KEY to the object.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
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:
key

DETAILS

No additional details. See Insert_Ink()

void DInsert_Ink ( double  x,
double  y,
double  z 
)

Similar to Insert_Ink() but accepts and/or returns double-precision values. This command can only be used when the application source includes the HOOPS double-precision header, hcd.h.

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.

DETAILS

No additional details. See Insert_Ink().

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

Similar to DInsert_Ink(), but returns an HC_KEY to the object.

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:
key

DETAILS

No additional details. See Insert_Ink()

void DQInsert_Ink ( const char *  segment,
double  x,
double  y,
double  z 
)

Similar to DInsert_Ink(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
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.

DETAILS

No additional details. See Insert_Ink()

HC_KEY DQKInsert_Ink ( const char *  segment,
double  x,
double  y,
double  z 
)

Similar to DInsert_Ink(), but operates on a given segment and returns an HC_KEY to the object.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
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:
key

DETAILS

No additional details. See Insert_Ink()

Main Index
Brief Index      Full Index      I.M. Functions