DATAMANIP (kdatamanip) functions


LIBRARY ROUTINE

lkgenloc - generate location data

LIBRARY CALL

int lkgenloc(
   double  xbegin,
   double  ybegin,
   double  zbegin,
   double  xend,
   double  yend,
   double  zend,
   int     grid,
   int     wid,
   int     hgt,
   int     dep,
   int     datatype,
   kobject dst_obj)

INPUT

OUTPUT

RETURN VALUE

TRUE (1) on success, FALSE (0) otherwise

DESCRIPTION

This routine will generate explicit location data for a specified object.

This routine will create a location segment of the specified width, height, and depth using the specified data type. The dimension size of the created data is assumed to be three to correspond to (x,y,z). It is assumed that the object initially does not have an explicit location segment.

The explicit location data is specified by three sets of begin and end values, which together compose explicit corner markers for volume in three space (x,y,z). Typically, the x-axis corresponds uniformly to the implicit width dimension on the polymorphic data model, with the y-axis and z-axis corresponding to implicit height, and depth, respectively.

Data is generated uniformly from those specified corner markers, however the explicitness of the generated data can be specified by the grid parameter. A KUNIFORM grid will dictate that the generated data consist simply of setting the uniform corner markers on the output data set. A KRECTILINEAR grid will dictate that the generated data consist of three arrays of locations, an x-array, a y-array, and a z-array, with the data within those arrays changing uniformly from the specified (x,y,z) begin and end values. A KCURVILINEAR grid will dictate that the generated data consist of a four dimensional array of location data. Essentially, this data set is a three dimensional array of (x,y,z) points.

The data is generated and stored as one block, so generating large location data sets are subject to the memory limitations of your machine.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

Destination object must not already contain location data.

MODIFICATION

none

FILES

$DATAMANIP/objects/library/kdatamanip/src/lkgenloc.c

SEE ALSO

kdatamanip(3)

COPYRIGHT

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