DATASERV (kgeom) functions


LIBRARY ROUTINE

kgeom_start_reading_object - read the first part of a geometry object

LIBRARY CALL

int
kgeom_start_reading_object(kgeom_object *object)

INPUT

OUTPUT

none

RETURN VALUE

TRUE on success, FALSE otherwise

DESCRIPTION

This routine will read the first part of a geometry object from an open fid. It should be followed by a read of all the primitives, and then by a finish of the object.

In general, the kgeom_read_object() function should be used instead of this function. This function has been made public to provide complete flexibility for reading a geometry object. It should only be used when you wish to read a geometry object primitive-by-primitive. More information on this is available in the kgeom_read_primitive() man page.

The first part of a geometry object contains information which is needed to read the geometry primitive data. Specifically, the layout, location_dim, texture_coord_dim, and has_alpha fields are read in as the first part of the object.

All other information contained within the geometry object is read after the primitives by the kgeom_finish_reading_object() call.

The fid internal to the geometry object specifies the file from which the the object will be read. In general, this fid is set when the geometry header is read by the kgeom_read_header() function.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DATASERV/objects/library/kgeom/src/object.c

SEE ALSO

kgeom(3), kgeom_finish_reading_object, kgeom_read_primitive

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.