[cgma-dev] r3402 - cgm/trunk/itaps
jvporter at wisc.edu
jvporter at wisc.edu
Sun Dec 6 00:18:11 CST 2009
Author: jvporter
Date: 2009-12-06 00:18:10 -0600 (Sun, 06 Dec 2009)
New Revision: 3402
Modified:
cgm/trunk/itaps/iGeom.h
Log:
Update documentation in iGeom.h to be complete/correct, and consistent
with iMesh's style
Modified: cgm/trunk/itaps/iGeom.h
===================================================================
--- cgm/trunk/itaps/iGeom.h 2009-12-06 05:48:51 UTC (rev 3401)
+++ cgm/trunk/itaps/iGeom.h 2009-12-06 06:18:10 UTC (rev 3402)
@@ -85,7 +85,7 @@
*/
typedef struct iGeom_EntityArrIterator_Private* iGeom_EntityArrIterator;
- /**\brief Get a description of the error returned from the last iGeom function
+ /**\brief Get a description of the error returned from the last iGeom call
*
* Get a description of the error returned from the last iGeom function
* \param instance iGeom instance handle
@@ -107,14 +107,13 @@
* \param *error_type Error type returned from last iGeom function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getErrorType(iGeom_Instance instance,
- /*out*/ int *error_type,
- int *err);
+ void iGeom_getErrorType( iGeom_Instance instance,
+ /*out*/ int *error_type,
+ int *err );
/**\brief Construct a new iGeom instance
*
- * Construct a new iGeom instance, using implementation-specific
- * options
+ * Construct a new iGeom instance, using implementation-specific options
* \param options Pointer to implementation-specific options string
* \param instance Pointer to iGeom instance handle returned from function
* \param *err Pointer to error type returned from function
@@ -131,7 +130,8 @@
* \param instance iGeom instance to be destroyed
* \param *err Pointer to error type returned from function
*/
- void iGeom_dtor( iGeom_Instance instance, int* err );
+ void iGeom_dtor( iGeom_Instance instance,
+ int* err );
/**\brief Load a geom from a file
@@ -147,7 +147,7 @@
* \param name_len Length of the file name character string
* \param options_len Length of the options character string
*/
- void iGeom_load( iGeom_Instance,
+ void iGeom_load( iGeom_Instance instance,
char const* name,
char const* options,
int* err,
@@ -166,7 +166,7 @@
* \param name_len Length of the file name character string
* \param options_len Length of the options character string
*/
- void iGeom_save( iGeom_Instance,
+ void iGeom_save( iGeom_Instance instance,
char const* name,
char const* options,
int* err,
@@ -181,20 +181,23 @@
* \param root_set Pointer to set handle returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getRootSet( iGeom_Instance,
+ void iGeom_getRootSet( iGeom_Instance instance,
iBase_EntitySetHandle* root_set,
int* err );
-/**\brief Get the bounding box of the entire model
- * Get the bounding box of the entire model
- * \param min_x Minimum coordinate of bounding box
- * \param min_y Minimum coordinate of bounding box
- * \param min_z Minimum coordinate of bounding box
- * \param max_x Maximum coordinate of bounding box
- * \param max_y Maximum coordinate of bounding box
- * \param max_z Maximum coordinate of bounding box
- */
- void iGeom_getBoundBox( iGeom_Instance,
+ /**\brief Get the bounding box of the entire model
+ *
+ * Get the bounding box of the entire model
+ * \param instance iGeom instance handle
+ * \param min_x Minimum coordinate of bounding box
+ * \param min_y Minimum coordinate of bounding box
+ * \param min_z Minimum coordinate of bounding box
+ * \param max_x Maximum coordinate of bounding box
+ * \param max_y Maximum coordinate of bounding box
+ * \param max_z Maximum coordinate of bounding box
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getBoundBox( iGeom_Instance instance,
double* min_x,
double* min_y,
double* min_z,
@@ -203,13 +206,11 @@
double* max_z,
int* err );
- /**\brief Get entities of specific type and/or topology in set or instance
+ /**\brief Get entities of specific type in set or instance
*
- * Get entities of specific type and/or topology in set or instance. All
- * entities of a given type or topology are requested by specifying
- * iBase_ALL_TOPOLOGIES or iBase_ALL_TYPES, respectively. Specified type
- * or topology must be a value in the iBase_EntityType or iBase_EntityTopology
- * enumeration, respectively.
+ * Get entities of specific type in set or instance. All entities are
+ * requested by specifying iBase_ALL_TYPES. Specified type must be a value
+ * in the iBase_EntityType enumeration.
* \param instance iGeom instance handle
* \param entity_set_handle Entity set being queried
* \param entity_type Type of entities being requested
@@ -218,7 +219,8 @@
* from function
* \param *entity_handles_allocated Pointer to allocated size of
* entity_handles array
- * \param *entity_handles_size Pointer to occupied size of entity_handles array
+ * \param *entity_handles_size Pointer to occupied size of entity_handles
+ * array
* \param *err Pointer to error type returned from function
*/
void iGeom_getEntities( iGeom_Instance instance,
@@ -229,13 +231,14 @@
int* entity_handles_size,
int* err );
- /**\brief Get the number of entities with the specified type in the instance or set
+ /**\brief Get the number of entities with the specified type in the
+ * instance or set
*
* Get the number of entities with the specified type in the instance
* or set. If entity set handle is zero, return information for instance,
* otherwise for set. Value of entity type must be from the
- * iBase_EntityType enumeration. If iBase_ALL_TYPES is specified,
- * total number of entities (excluding entity sets) is returned.
+ * iBase_EntityType enumeration. If iBase_ALL_TYPES is specified, total
+ * number of entities (excluding entity sets) is returned.
* \param instance iGeom instance handle
* \param entity_set_handle Entity set being queried
* \param entity_type Type of entity requested
@@ -250,8 +253,8 @@
/**\brief Get the entity type for the specified entity
*
- * Get the entity type for the specified entity. Types
- * returned are values in the iBase_EntityType enumeration.
+ * Get the entity type for the specified entity. Type returned is a value
+ * in the iBase_EntityType enumeration.
* \param instance iGeom instance handle
* \param entity_handle entity handle being queried
* \param *type Pointer to location at which to store the returned type
@@ -264,8 +267,8 @@
/**\brief Get the entity type for the specified entities
*
- * Get the entity type for the specified entities. Types
- * returned are values in the iBase_EntityType enumeration.
+ * Get the entity type for the specified entities. Types returned are
+ * values in the iBase_EntityType enumeration.
* \param instance iGeom instance handle
* \param entity_handles Array of entity handles being queried
* \param entity_handles_size Number of entities in entity_handles array
@@ -338,18 +341,20 @@
int* offset_size,
int* err );
-/**\brief Get "2nd order" adjacencies to an entity
- * Get "2nd order" adjacencies to an entity, that is, from an entity, through
- * other entities of a specified "bridge" dimension, to other entities of another
- * specified "to" dimension.
- * \param entity_handle Entity from which adjacencies are requested
- * \param bridge_dimension Bridge dimension for 2nd order adjacencies
- * \param to_dimension Dimension of adjacent entities returned
- * \param adjacent_entities Adjacent entities
- * \param adjacent_entities_allocated Allocated size of returned array
- * \param adjacent_entities_size Occupied size of returned array
- * \param err
- */
+ /**\brief Get "2nd order" adjacencies to an entity
+ *
+ * Get "2nd order" adjacencies to an entity, that is, from an entity,
+ * through other entities of a specified "bridge" dimension, to other
+ * entities of another specified "to" dimension.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity from which adjacencies are requested
+ * \param bridge_dimension Bridge dimension for 2nd order adjacencies
+ * \param to_dimension Dimension of adjacent entities returned
+ * \param adjacent_entities Adjacent entities
+ * \param adjacent_entities_allocated Allocated size of returned array
+ * \param adjacent_entities_size Occupied size of returned array
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getEnt2ndAdj( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
int bridge_dimension,
@@ -359,24 +364,26 @@
int* adjacent_entities_size,
int* err );
-/**\brief Get "2nd order" adjacencies to an array of entities
- * Get "2nd order" adjacencies to an array of entities, that is, from each entity, through
- * other entities of a specified "bridge" dimension, to other entities of another
- * specified "to" dimension.
- *
- * \param entity_handles Entities from which adjacencies are requested
- * \param entity_handles_size Number of entities whose adjacencies are requested
- * \param bridge_dimension Bridge dimension for 2nd order adjacencies
- * \param to_dimension Dimension of adjacent entities returned
- * \param adj_entity_handles Adjacent entities
- * \param adj_entity_handles_allocated Allocated size of returned array
- * \param adj_entity_handles_size Occupied size of returned array
- * \param offset Offset[i] is offset into adj_entity_handles of 2nd order
- * adjacencies of ith entity in entity_handles
- * \param offset_allocated Allocated size of offset array
- * \param offset_size Occupied size of offset array
- * \param err
- */
+ /**\brief Get "2nd order" adjacencies to an array of entities
+ *
+ * Get "2nd order" adjacencies to an array of entities, that is, from each
+ * entity, through other entities of a specified "bridge" dimension, to
+ * other entities of another specified "to" dimension.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities from which adjacencies are requested
+ * \param entity_handles_size Number of entities whose adjacencies are
+ * requested
+ * \param bridge_dimension Bridge dimension for 2nd order adjacencies
+ * \param to_dimension Dimension of adjacent entities returned
+ * \param adj_entity_handles Adjacent entities
+ * \param adj_entity_handles_allocated Allocated size of returned array
+ * \param adj_entity_handles_size Occupied size of returned array
+ * \param offset Offset[i] is offset into adj_entity_handles of 2nd order
+ * adjacencies of ith entity in entity_handles
+ * \param offset_allocated Allocated size of offset array
+ * \param offset_size Occupied size of offset array
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getArr2ndAdj( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
@@ -390,32 +397,37 @@
int* offset_size,
int* err );
-/**\brief Return whether two entities are adjacent
- * Return whether two entities are adjacent.
- * \param entity_handle1 First entity queried
- * \param entity_handle2 Second entity queried
- * \param are_adjacent If returned non-zero, entities are adjacent, otherwise
- * they are not
- * \param err
- */
+ /**\brief Return whether two entities are adjacent
+ *
+ * Return whether two entities are adjacent.
+ * \param instance iGeom instance handle
+ * \param entity_handle1 First entity queried
+ * \param entity_handle2 Second entity queried
+ * \param are_adjacent If returned non-zero, entities are adjacent,
+ * otherwise they are not
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_isEntAdj( iGeom_Instance instance,
iBase_EntityHandle entity_handle1,
iBase_EntityHandle entity_handle2,
int* are_adjacent,
int* err );
-/**\brief Return whether entity pairs are adjacent
- * Return whether entity pairs are adjacent, i.e. if entity_handles_1[i] is
- * adjacent to entity_handles_2[i]. This function requires entity_handles_1_size
- * and entity_handles_2_size to be equal.
- * \param entity_handles_1 First array of entities
- * \param entity_handles_1_size Number of entities in first array
- * \param entity_handles_2 Second array of entities
- * \param entity_handles_2_size Number of entities in second array
- * \param is_adjacent_info Array of flags returned from function
- * \param is_adjacent_info_allocated Allocated size of flags array
- * \param is_adjacent_info_size Occupied size of flags array
- */
+ /**\brief Return whether entity pairs are adjacent
+ *
+ * Return whether entity pairs are adjacent, i.e. if entity_handles_1[i] is
+ * adjacent to entity_handles_2[i]. This function requires
+ * entity_handles_1_size and entity_handles_2_size to be equal.
+ * \param instance iGeom instance handle
+ * \param entity_handles_1 First array of entities
+ * \param entity_handles_1_size Number of entities in first array
+ * \param entity_handles_2 Second array of entities
+ * \param entity_handles_2_size Number of entities in second array
+ * \param is_adjacent_info Array of flags returned from function
+ * \param is_adjacent_info_allocated Allocated size of flags array
+ * \param is_adjacent_info_size Occupied size of flags array
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_isArrAdj( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles_1,
int entity_handles_1_size,
@@ -426,24 +438,31 @@
int* is_adjacent_info_size,
int* err );
-/**\brief DON'T KNOW WHAT THIS FUNCTION IS
- *
- * \param topo_level_out
- */
+ /**\brief Return the topology level of the geometry
+ *
+ * Return the topology level of the geometry as an integer, where 0 = basic
+ * entities only, 1 = manifold entities, 2 = non-manifold entities.
+ * \param instance iGeom instance handle
+ * \param topo_level_out The topology level
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getTopoLevel( iGeom_Instance instance,
int* topo_level_out,
int* err );
-/**\brief Get closest point to an entity
- * Get closest point to a specified position on an entity
- * \param entity_handle Entity being queried
- * \param near_x Coordinates of starting point
- * \param near_y Coordinates of starting point
- * \param near_z Coordinates of starting point
- * \param on_x Closest point on entity
- * \param on_y Closest point on entity
- * \param on_z Closest point on entity
- */
+ /**\brief Get closest point to an entity
+ *
+ * Get closest point to a specified position on an entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param near_x Coordinates of starting point
+ * \param near_y Coordinates of starting point
+ * \param near_z Coordinates of starting point
+ * \param on_x Closest point on entity
+ * \param on_y Closest point on entity
+ * \param on_z Closest point on entity
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getEntClosestPt( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double near_x,
@@ -454,22 +473,24 @@
double* on_z,
int* err );
-/**\brief Get closest point for an array of entities and points
- * Get closest point for an array of entities and points. If either the number
- * of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entity(ies) being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of input points
- * \param near_coordinates Coordinates of starting point(s)
- * \param near_coordinates_size Number of values in near_coordinates array
- * \param on_coordinates Coordinates of closest points
- * \param on_coordinates_allocated Allocated size of closest point array
- * \param on_coordinates_size Occupied size of closest point array
- */
+ /**\brief Get closest point for an array of entities and points
+ *
+ * Get closest point for an array of entities and points. If either the
+ * number of entities or number of coordinate triples is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity(ies) being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of input points
+ * \param near_coordinates Coordinates of starting point(s)
+ * \param near_coordinates_size Number of values in near_coordinates array
+ * \param on_coordinates Coordinates of closest points
+ * \param on_coordinates_allocated Allocated size of closest point array
+ * \param on_coordinates_size Occupied size of closest point array
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getArrClosestPt( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
@@ -481,17 +502,19 @@
int* on_coordinates_size,
int* err );
-/**\brief Get the normal vector on an entity at the given position
- * Get the normal vector on an entity at the given position.
- * \param entity_handle Entity being queried
- * \param x Coordinates of starting point
- * \param y Coordinates of starting point
- * \param z Coordinates of starting point
- * \param nrml_i Normal vector at starting point
- * \param nrml_j Normal vector at starting point
- * \param nrml_k Normal vector at starting point
- */
- void iGeom_getEntNrmlXYZ( iGeom_Instance,
+ /**\brief Get the normal vector on an entity at the given position
+ * Get the normal vector on an entity at the given position.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param x Coordinates of starting point
+ * \param y Coordinates of starting point
+ * \param z Coordinates of starting point
+ * \param nrml_i Normal vector at starting point
+ * \param nrml_j Normal vector at starting point
+ * \param nrml_k Normal vector at starting point
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntNrmlXYZ( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -501,23 +524,25 @@
double* nrml_k,
int* err );
-/**\brief Get the normal vector on an entity(ies) at given position(s)
- * Get the normal vector on an entity(ies) at given position(s). If either the
- * number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entity(ies) being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of coordinates
- * \param coordinates Starting coordinates
- * \param coordinates_size Number of values in coordinates array
- * \param normals Normal coordinates
- * \param normals_allocated Allocated size of normals array
- * \param normals_size Occupied size of normals array
- */
- void iGeom_getArrNrmlXYZ( iGeom_Instance,
+ /**\brief Get the normal vector on an entity(ies) at given position(s)
+ *
+ * Get the normal vector on an entity(ies) at given position(s). If either
+ * the number of entities or number of coordinate triples is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity(ies) being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of coordinates
+ * \param coordinates Starting coordinates
+ * \param coordinates_size Number of values in coordinates array
+ * \param normals Normal coordinates
+ * \param normals_allocated Allocated size of normals array
+ * \param normals_size Occupied size of normals array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrNrmlXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -528,20 +553,24 @@
int* normals_size,
int* err );
-/**\brief Get the normal vector AND closest point on an entity at given position
- * Get the normal vector AND closest point on an entity at a given position.
- * \param entity_handle Entity being queried
- * \param x Starting coordinates
- * \param y Starting coordinates
- * \param z Starting coordinates
- * \param pt_x Closest point
- * \param pt_y Closest point
- * \param pt_z Closest point
- * \param nrml_i Normal at closest point
- * \param nrml_j Normal at closest point
- * \param nrml_k Normal at closest point
- */
- void iGeom_getEntNrmlPlXYZ( iGeom_Instance,
+ /**\brief Get the normal vector AND closest point on an entity at given
+ * position
+ *
+ * Get the normal vector AND closest point on an entity at a given position.
+ * \param entity_handle Entity being queried
+ * \param instance iGeom instance handle
+ * \param x Starting coordinates
+ * \param y Starting coordinates
+ * \param z Starting coordinates
+ * \param pt_x Closest point
+ * \param pt_y Closest point
+ * \param pt_z Closest point
+ * \param nrml_i Normal at closest point
+ * \param nrml_j Normal at closest point
+ * \param nrml_k Normal at closest point
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntNrmlPlXYZ( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -554,26 +583,29 @@
double* nrml_k,
int* err );
-/**\brief Get the normal vector AND closest point on an entity(ies) at given position(s)
- * Get the normal vector AND closest point on an entity(ies) at given position(s). If either the
- * number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entity(ies) being queried
- * \param entity_handles_size Number of entity(ies) being queried
- * \param storage_order Storage order in near_coordinates array
- * \param near_coordinates Starting coordinates
- * \param near_coordinates_size Number of values in near_coordinates array
- * \param on_coordinates Closest point array
- * \param on_coordinates_allocated Allocated size of closest point array
- * \param on_coordinates_size Occupied size of closest point array
- * \param normals Normal array
- * \param normals_allocated Allocated size of normal array
- * \param normals_size Occupied size of normal array
- */
- void iGeom_getArrNrmlPlXYZ( iGeom_Instance,
+ /**\brief Get the normal vector AND closest point on an entity(ies) at
+ * given position(s)
+ *
+ * Get the normal vector AND closest point on an entity(ies) at given
+ * position(s). If either the number of entities or number of coordinate
+ * triples is unity, then all points or entities are queried for that entity
+ * or point, respectively, otherwise each point corresponds to each entity.
+ * storage_order should be a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity(ies) being queried
+ * \param entity_handles_size Number of entity(ies) being queried
+ * \param storage_order Storage order in near_coordinates array
+ * \param near_coordinates Starting coordinates
+ * \param near_coordinates_size Number of values in near_coordinates array
+ * \param on_coordinates Closest point array
+ * \param on_coordinates_allocated Allocated size of closest point array
+ * \param on_coordinates_size Occupied size of closest point array
+ * \param normals Normal array
+ * \param normals_allocated Allocated size of normal array
+ * \param normals_size Occupied size of normal array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrNrmlPlXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -587,17 +619,20 @@
int* normals_size,
int* err );
-/**\brief Get the tangent vector on an entity at given position
- * Get the tangent vector on an entity at a given position.
- * \param entity_handle Entity being queried
- * \param x Starting coordinates
- * \param y Starting coordinates
- * \param z Starting coordinates
- * \param tgnt_i Tangent at closest point
- * \param tgnt_j Tangent at closest point
- * \param tgnt_k Tangent at closest point
- */
- void iGeom_getEntTgntXYZ( iGeom_Instance,
+ /**\brief Get the tangent vector on an entity at given position
+ *
+ * Get the tangent vector on an entity at a given position.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param x Starting coordinates
+ * \param y Starting coordinates
+ * \param z Starting coordinates
+ * \param tgnt_i Tangent at closest point
+ * \param tgnt_j Tangent at closest point
+ * \param tgnt_k Tangent at closest point
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntTgntXYZ( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -607,23 +642,25 @@
double* tgnt_k,
int* err );
-/**\brief Get the tangent vector on an entity(ies) at given position(s)
- * Get the tangent vector on an entity(ies) at given position(s). If either the
- * number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entity(ies) being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of coordinates
- * \param coordinates Starting coordinates
- * \param coordinates_size Number of values in coordinates array
- * \param tangents Tangent coordinates
- * \param tangents_allocated Allocated size of tangents array
- * \param tangents_size Occupied size of tangents array
- */
- void iGeom_getArrTgntXYZ( iGeom_Instance,
+ /**\brief Get the tangent vector on an entity(ies) at given position(s)
+ *
+ * Get the tangent vector on an entity(ies) at given position(s). If either
+ * the number of entities or number of coordinate triples is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity(ies) being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of coordinates
+ * \param coordinates Starting coordinates
+ * \param coordinates_size Number of values in coordinates array
+ * \param tangents Tangent coordinates
+ * \param tangents_allocated Allocated size of tangents array
+ * \param tangents_size Occupied size of tangents array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrTgntXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -634,21 +671,25 @@
int* tangents_size,
int* err );
-/**\brief Get the two principle curvature vectors for a face at a point
- * Get the two principle curvature vectors for a face at a point. Magnitudes of
- * vectors are curvature, directions are directions of principal curvatures.
- * \param face_handle Face being queried
- * \param x Position being queried
- * \param y Position being queried
- * \param z Position being queried
- * \param cvtr1_i Maximum curvature vector
- * \param cvtr1_j Maximum curvature vector
- * \param cvtr1_k Maximum curvature vector
- * \param cvtr2_i Minimum curvature vector
- * \param cvtr2_j Minimum curvature vector
- * \param cvtr2_k Minimum curvature vector
- */
- void iGeom_getFcCvtrXYZ( iGeom_Instance,
+ /**\brief Get the two principle curvature vectors for a face at a point
+ *
+ * Get the two principle curvature vectors for a face at a point.
+ * Magnitudes of vectors are curvature, directions are directions of
+ * principal curvatures.
+ * \param instance iGeom instance handle
+ * \param face_handle Face being queried
+ * \param x Position being queried
+ * \param y Position being queried
+ * \param z Position being queried
+ * \param cvtr1_i Maximum curvature vector
+ * \param cvtr1_j Maximum curvature vector
+ * \param cvtr1_k Maximum curvature vector
+ * \param cvtr2_i Minimum curvature vector
+ * \param cvtr2_j Minimum curvature vector
+ * \param cvtr2_k Minimum curvature vector
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getFcCvtrXYZ( iGeom_Instance instance,
iBase_EntityHandle face_handle,
double x,
double y,
@@ -661,18 +702,21 @@
double* cvtr2_k,
int* err );
-/**\brief Get the principle curvature vector for an edge at a point
- * Get the principle curvature vector for an edge at a point. Magnitude of
- * vector is the curvature, direction is direction of principal curvature.
- * \param edge_handle Edge being queried
- * \param x Position being queried
- * \param y Position being queried
- * \param z Position being queried
- * \param cvtr_i Maximum curvature vector
- * \param cvtr_j Maximum curvature vector
- * \param cvtr_k Maximum curvature vector
- */
- void iGeom_getEgCvtrXYZ( iGeom_Instance,
+ /**\brief Get the principle curvature vector for an edge at a point
+ *
+ * Get the principle curvature vector for an edge at a point. Magnitude of
+ * vector is the curvature, direction is direction of principal curvature.
+ * \param instance iGeom instance handle
+ * \param edge_handle Edge being queried
+ * \param x Position being queried
+ * \param y Position being queried
+ * \param z Position being queried
+ * \param cvtr_i Maximum curvature vector
+ * \param cvtr_j Maximum curvature vector
+ * \param cvtr_k Maximum curvature vector
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEgCvtrXYZ( iGeom_Instance instance,
iBase_EntityHandle edge_handle,
double x,
double y,
@@ -682,26 +726,28 @@
double* cvtr_k,
int* err );
-/**\brief Get the curvature(s) on an entity(ies) at given position(s)
- * Get the curvature(s) on an entity(ies) at given position(s). If either the
- * number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entity(ies) being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of coordinates
- * \param coords Starting coordinates
- * \param coords_size Number of values in coordinates array
- * \param cvtr_1 First principal curvatures
- * \param cvtr_1_allocated Allocated size of first curvature array
- * \param cvtr_1_size Occupied size of first curvature array
- * \param cvtr_2 Second principal curvatures
- * \param cvtr_2_allocated Allocated size of second curvature array
- * \param cvtr_2_size Occupied size of second curvature array
- */
- void iGeom_getEntArrCvtrXYZ( iGeom_Instance,
+ /**\brief Get the curvature(s) on an entity(ies) at given position(s)
+ *
+ * Get the curvature(s) on an entity(ies) at given position(s). If either
+ * the number of entities or number of coordinate triples is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity(ies) being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of coordinates
+ * \param coords Starting coordinates
+ * \param coords_size Number of values in coordinates array
+ * \param cvtr_1 First principal curvatures
+ * \param cvtr_1_allocated Allocated size of first curvature array
+ * \param cvtr_1_size Occupied size of first curvature array
+ * \param cvtr_2 Second principal curvatures
+ * \param cvtr_2_allocated Allocated size of second curvature array
+ * \param cvtr_2_size Occupied size of second curvature array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntArrCvtrXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -715,23 +761,26 @@
int* cvtr_2_size,
int* err );
-/**\brief Get closest point, tangent, and curvature of edge
- * Get closest point, tangent, and curvature of edge.
- * \param edge_handle Edge being queried
- * \param x Point at which entity is being queried
- * \param y Point at which entity is being queried
- * \param z Point at which entity is being queried
- * \param on_x Closest point at point being queried
- * \param on_y Closest point at point being queried
- * \param on_z Closest point at point being queried
- * \param tgnt_i Tangent at point being queried
- * \param tgnt_j Tangent at point being queried
- * \param tgnt_k Tangent at point being queried
- * \param cvtr_i Curvature at point being queried
- * \param cvtr_j Curvature at point being queried
- * \param cvtr_k Curvature at point being queried
- */
- void iGeom_getEgEvalXYZ( iGeom_Instance,
+ /**\brief Get closest point, tangent, and curvature of edge
+ *
+ * Get closest point, tangent, and curvature of edge.
+ * \param instance iGeom instance handle
+ * \param edge_handle Edge being queried
+ * \param x Point at which entity is being queried
+ * \param y Point at which entity is being queried
+ * \param z Point at which entity is being queried
+ * \param on_x Closest point at point being queried
+ * \param on_y Closest point at point being queried
+ * \param on_z Closest point at point being queried
+ * \param tgnt_i Tangent at point being queried
+ * \param tgnt_j Tangent at point being queried
+ * \param tgnt_k Tangent at point being queried
+ * \param cvtr_i Curvature at point being queried
+ * \param cvtr_j Curvature at point being queried
+ * \param cvtr_k Curvature at point being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEgEvalXYZ( iGeom_Instance instance,
iBase_EntityHandle edge_handle,
double x,
double y,
@@ -747,27 +796,30 @@
double* cvtr_k,
int* err );
-/**\brief Get closest point, tangent, and curvature of face
- * Get closest point, tangent, and curvature of face. If any of input
- * coordinate pointers are NULL, that value is not returned.
- * \param face_handle Face being queried
- * \param x Point at which entity is being queried
- * \param y Point at which entity is being queried
- * \param z Point at which entity is being queried
- * \param on_x Closest point at point being queried
- * \param on_y Closest point at point being queried
- * \param on_z Closest point at point being queried
- * \param nrml_i Normal at point being queried
- * \param nrml_j Normal at point being queried
- * \param nrml_k Normal at point being queried
- * \param cvtr1_i First principal curvature at point being queried
- * \param cvtr1_j First principal curvature at point being queried
- * \param cvtr1_k First principal curvature at point being queried
- * \param cvtr2_i Second principal curvature at point being queried
- * \param cvtr2_j Second principal curvature at point being queried
- * \param cvtr2_k Second principal curvature at point being queried
- */
- void iGeom_getFcEvalXYZ( iGeom_Instance,
+ /**\brief Get closest point, tangent, and curvature of face
+ *
+ * Get closest point, tangent, and curvature of face. If any of input
+ * coordinate pointers are NULL, that value is not returned.
+ * \param instance iGeom instance handle
+ * \param face_handle Face being queried
+ * \param x Point at which entity is being queried
+ * \param y Point at which entity is being queried
+ * \param z Point at which entity is being queried
+ * \param on_x Closest point at point being queried
+ * \param on_y Closest point at point being queried
+ * \param on_z Closest point at point being queried
+ * \param nrml_i Normal at point being queried
+ * \param nrml_j Normal at point being queried
+ * \param nrml_k Normal at point being queried
+ * \param cvtr1_i First principal curvature at point being queried
+ * \param cvtr1_j First principal curvature at point being queried
+ * \param cvtr1_k First principal curvature at point being queried
+ * \param cvtr2_i Second principal curvature at point being queried
+ * \param cvtr2_j Second principal curvature at point being queried
+ * \param cvtr2_k Second principal curvature at point being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getFcEvalXYZ( iGeom_Instance instance,
iBase_EntityHandle face_handle,
double x,
double y,
@@ -786,29 +838,33 @@
double* cvtr2_k,
int* err );
-/**\brief Get the closest point(s), tangent(s), and curvature(s) on an entity(ies) at given position(s)
- * Get the closest point(s), tangent(s), and curvature(s) on an entity(ies) at given position(s).
- * If either the number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param edge_handles Edge(s) being queried
- * \param edge_handles_size Number of edges being queried
- * \param storage_order Storage order of coordinates
- * \param coords Starting coordinates
- * \param coords_size Number of values in coordinates array
- * \param on_coords Closest point array
- * \param on_coords_allocated Allocated size of closest point array
- * \param on_coords_size Occupied size of closest point array
- * \param tangent Tangent array
- * \param tangent_allocated Allocated size of tangent array
- * \param tangent_size Occupied size of tangent array
- * \param cvtr First principal curvatures
- * \param cvtr_allocated Allocated size of first curvature array
- * \param cvtr_size Occupied size of first curvature array
- */
- void iGeom_getArrEgEvalXYZ( iGeom_Instance,
+ /**\brief Get the closest point(s), tangent(s), and curvature(s) on an
+ * entity(ies) at given position(s)
+ *
+ * Get the closest point(s), tangent(s), and curvature(s) on an entity(ies)
+ * at given position(s). If either the number of entities or number of
+ * coordinate triples is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param edge_handles Edge(s) being queried
+ * \param edge_handles_size Number of edges being queried
+ * \param storage_order Storage order of coordinates
+ * \param coords Starting coordinates
+ * \param coords_size Number of values in coordinates array
+ * \param on_coords Closest point array
+ * \param on_coords_allocated Allocated size of closest point array
+ * \param on_coords_size Occupied size of closest point array
+ * \param tangent Tangent array
+ * \param tangent_allocated Allocated size of tangent array
+ * \param tangent_size Occupied size of tangent array
+ * \param cvtr First principal curvatures
+ * \param cvtr_allocated Allocated size of first curvature array
+ * \param cvtr_size Occupied size of first curvature array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrEgEvalXYZ( iGeom_Instance instance,
iBase_EntityHandle const* edge_handles,
int edge_handles_size,
int storage_order,
@@ -825,32 +881,36 @@
int* cvtr_size,
int* err );
-/**\brief Get the closest point(s), tangent(s), and curvature(s) on an entity(ies) at given position(s)
- * Get the closest point(s), tangent(s), and curvature(s) on an entity(ies) at given position(s).
- * If either the number of entities or number of coordinate triples is unity, then all points or
- * entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param edge_handles Edge(s) being queried
- * \param edge_handles_size Number of edges being queried
- * \param storage_order Storage order of coordinates
- * \param coords Starting coordinates
- * \param coords_size Number of values in coordinates array
- * \param on_coords Closest point array
- * \param on_coords_allocated Allocated size of closest point array
- * \param on_coords_size Occupied size of closest point array
- * \param normal Normal array
- * \param normal_allocated Allocated size of normal array
- * \param normal_size Occupied size of normal array
- * \param cvtr_1 First principal curvatures
- * \param cvtr_1_allocated Allocated size of first curvature array
- * \param cvtr_1_size Occupied size of first curvature array
- * \param cvtr_2 Second principal curvatures
- * \param cvtr_2_allocated Allocated size of second curvature array
- * \param cvtr_2_size Occupied size of second curvature array
- */
- void iGeom_getArrFcEvalXYZ( iGeom_Instance,
+ /**\brief Get the closest point(s), tangent(s), and curvature(s) on an
+ * entity(ies) at given position(s)
+ *
+ * Get the closest point(s), tangent(s), and curvature(s) on an entity(ies)
+ * at given position(s). If either the number of entities or number of
+ * coordinate triples is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param edge_handles Edge(s) being queried
+ * \param edge_handles_size Number of edges being queried
+ * \param storage_order Storage order of coordinates
+ * \param coords Starting coordinates
+ * \param coords_size Number of values in coordinates array
+ * \param on_coords Closest point array
+ * \param on_coords_allocated Allocated size of closest point array
+ * \param on_coords_size Occupied size of closest point array
+ * \param normal Normal array
+ * \param normal_allocated Allocated size of normal array
+ * \param normal_size Occupied size of normal array
+ * \param cvtr_1 First principal curvatures
+ * \param cvtr_1_allocated Allocated size of first curvature array
+ * \param cvtr_1_size Occupied size of first curvature array
+ * \param cvtr_2 Second principal curvatures
+ * \param cvtr_2_allocated Allocated size of second curvature array
+ * \param cvtr_2_size Occupied size of second curvature array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrFcEvalXYZ( iGeom_Instance instance,
iBase_EntityHandle const* face_handles,
int face_handles_size,
int storage_order,
@@ -870,17 +930,20 @@
int* cvtr2_size,
int* err );
-/**\brief Get the bounding box of the specified entity
- * Get the bounding box of the specified entity
- * \param entity_handle Entity being queried
- * \param min_x Minimum coordinate of bounding box
- * \param min_y Minimum coordinate of bounding box
- * \param min_z Minimum coordinate of bounding box
- * \param max_x Maximum coordinate of bounding box
- * \param max_y Maximum coordinate of bounding box
- * \param max_z Maximum coordinate of bounding box
- */
- void iGeom_getEntBoundBox( iGeom_Instance,
+ /**\brief Get the bounding box of the specified entity
+ *
+ * Get the bounding box of the specified entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param min_x Minimum coordinate of bounding box
+ * \param min_y Minimum coordinate of bounding box
+ * \param min_z Minimum coordinate of bounding box
+ * \param max_x Maximum coordinate of bounding box
+ * \param max_y Maximum coordinate of bounding box
+ * \param max_z Maximum coordinate of bounding box
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntBoundBox( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double* min_x,
double* min_y,
@@ -890,20 +953,23 @@
double* max_z,
int* err );
-/**\brief Get the bounding box of the specified entities
- * Get the bounding box of the specified entities. Storage order passed back
- * will be member of iBase_StorageOrder enum.
- * \param entity_handles Entity handles being queried
- * \param enttiy_handles_size Number of entities being queried
- * \param storage_order Storage order of coordinates passed back
- * \param min_corner Minimum coordinates of bounding boxes
- * \param min_corner_allocated Allocated size of minimum coordinates array
- * \param min_corner_size Occupied size of minimum coordinates array
- * \param max_corner Maximum coordinates of bounding boxes
- * \param max_corner_allocated Allocated size of maximum coordinates array
- * \param max_corner_size Occupied size of maximum coordinates array
- */
- void iGeom_getArrBoundBox( iGeom_Instance,
+ /**\brief Get the bounding box of the specified entities
+ *
+ * Get the bounding box of the specified entities. Storage order passed in
+ * should be a member of iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entity handles being queried
+ * \param enttiy_handles_size Number of entities being queried
+ * \param storage_order Storage order of coordinates passed back
+ * \param min_corner Minimum coordinates of bounding boxes
+ * \param min_corner_allocated Allocated size of minimum coordinates array
+ * \param min_corner_size Occupied size of minimum coordinates array
+ * \param max_corner Maximum coordinates of bounding boxes
+ * \param max_corner_allocated Allocated size of maximum coordinates array
+ * \param max_corner_size Occupied size of maximum coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrBoundBox( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -925,7 +991,7 @@
* \param *z Pointer to z coordinate returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getVtxCoord( iGeom_Instance,
+ void iGeom_getVtxCoord( iGeom_Instance instance,
iBase_EntityHandle vertex_handle,
double* x,
double* y,
@@ -949,7 +1015,7 @@
* \param *coords_size Pointer to occupied size of coords array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getVtxArrCoords( iGeom_Instance,
+ void iGeom_getVtxArrCoords( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -958,28 +1024,31 @@
int* coordinates_size,
int* err );
-/**\brief Intersect a ray with the model
- * Intersect a ray with the model. Storage orders passed back are members of the
- * iBase_StorageOrder enumeration; if output is iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param x Point from which ray is fired
- * \param y Point from which ray is fired
- * \param z Point from which ray is fired
- * \param dir_x Direction in which ray is fired
- * \param dir_y Direction in which ray is fired
- * \param dir_z Direction in which ray is fired
- * \param intersect_entity_handles Entities intersected by ray
- * \param intersect_entity_handles_allocated Allocated size of intersections array
- * \param intersect_entity_hangles_size Occupied size of intersections array
- * \param storage_order Storage order of coordinates passed back
- * \param intersect_coords Coordinates of intersections
- * \param intersect_coords_allocated Allocated size of coordinates array
- * \param intersect_coords_size Occupied size of coordinates array
- * \param param_coords Distances along ray of intersections
- * \param param_coords_allocated Allocated size of param_coords array
- * \param param_coords_size Occupied size of param_coords array
- */
- void iGeom_getPntRayIntsct( iGeom_Instance,
+ /**\brief Intersect a ray with the model
+ *
+ * Intersect a ray with the model. Storage orders passed in should be a
+ * member of the iBase_StorageOrder enumeration.
+ * \param instance iGeom instance handle
+ * \param x Point from which ray is fired
+ * \param y Point from which ray is fired
+ * \param z Point from which ray is fired
+ * \param dir_x Direction in which ray is fired
+ * \param dir_y Direction in which ray is fired
+ * \param dir_z Direction in which ray is fired
+ * \param intersect_entity_handles Entities intersected by ray
+ * \param intersect_entity_handles_allocated Allocated size of
+ * intersections array
+ * \param intersect_entity_hangles_size Occupied size of intersections array
+ * \param storage_order Storage order of coordinates passed back
+ * \param intersect_coords Coordinates of intersections
+ * \param intersect_coords_allocated Allocated size of coordinates array
+ * \param intersect_coords_size Occupied size of coordinates array
+ * \param param_coords Distances along ray of intersections
+ * \param param_coords_allocated Allocated size of param_coords array
+ * \param param_coords_size Occupied size of param_coords array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getPntRayIntsct( iGeom_Instance instance,
double x,
double y,
double z,
@@ -998,30 +1067,34 @@
int* param_coords_size,
int* err );
-/**\brief Intersect an array of rays with the model
- * Intersect an array of rays with the model. Storage orders passed back are members of the
- * iBase_StorageOrder enumeration; if input/output is iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param storage_order Storage order of input coordinates
- * \param coords Points from which rays are fired
- * \param coords_size Number of points from which rays are fired
- * \param directions Directions in which rays are fired
- * \param directions_size Number of coordinates in directions array
- * \param intersect_entity_handles Entities intersected by ray
- * \param intersect_entity_handles_allocated Allocated size of intersections array
- * \param intersect_entity_hangles_size Occupied size of intersections array
- * \param offset Offset[i] is offset into intersect_entity_handles of ith ray
- * \param offset_allocated Allocated size of offset array
- * \param offset_size Occupied size of offset array
- * \param storage_order Storage order of coordinates passed back
- * \param intersect_coords Coordinates of intersections
- * \param intersect_coords_allocated Allocated size of coordinates array
- * \param intersect_coords_size Occupied size of coordinates array
- * \param param_coords Distances along ray of intersections
- * \param param_coords_allocated Allocated size of param_coords array
- * \param param_coords_size Occupied size of param_coords array
- */
- void iGeom_getPntArrRayIntsct( iGeom_Instance,
+ /**\brief Intersect an array of rays with the model
+ *
+ * Intersect an array of rays with the model. Storage order passed in is
+ * a member of the iBase_StorageOrder enumeration.
+ * \param instance iGeom instance handle
+ * \param storage_order Storage order of input coordinates
+ * \param coords Points from which rays are fired
+ * \param coords_size Number of points from which rays are fired
+ * \param directions Directions in which rays are fired
+ * \param directions_size Number of coordinates in directions array
+ * \param intersect_entity_handles Entities intersected by ray
+ * \param intersect_entity_handles_allocated Allocated size of intersections
+ * array
+ * \param intersect_entity_hangles_size Occupied size of intersections array
+ * \param offset Offset[i] is offset into intersect_entity_handles of ith
+ * ray
+ * \param offset_allocated Allocated size of offset array
+ * \param offset_size Occupied size of offset array
+ * \param storage_order Storage order of coordinates passed back
+ * \param intersect_coords Coordinates of intersections
+ * \param intersect_coords_allocated Allocated size of coordinates array
+ * \param intersect_coords_size Occupied size of coordinates array
+ * \param param_coords Distances along ray of intersections
+ * \param param_coords_allocated Allocated size of param_coords array
+ * \param param_coords_size Occupied size of param_coords array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getPntArrRayIntsct( iGeom_Instance instance,
int storage_order,
const double* coords,
int coords_size,
@@ -1041,32 +1114,37 @@
int* param_coords_size,
int* err );
-/**\brief Get the entity on which a point is located
- * Get the entity on which a point is located
- * \param x Point being queried
- * \param y Point being queried
- * \param z Point being queried
- * \param entity_handle Entity on which point is located
- */
- void iGeom_getPntClsf( iGeom_Instance,
+ /**\brief Get the entity on which a point is located
+ *
+ * Get the entity on which a point is located
+ * \param instance iGeom instance handle
+ * \param x Point being queried
+ * \param y Point being queried
+ * \param z Point being queried
+ * \param entity_handle Entity on which point is located
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getPntClsf( iGeom_Instance instance,
double x,
double y,
double z,
iBase_EntityHandle* entity_handle,
int* err );
-/**\brief Get the entities on which points are located
- * Get the entities on which points are located. Storage orders should be members of the
- * iBase_StorageOrder enumeration; if input is iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param storage_order Storage order of coordinates in coords
- * \param coords Points being queried
- * \param coords_size Number of entries in coords array
- * \param entity_handles Entities on which points are located
- * \param entity_handles_allocated Allocated size of entity_handles array
- * \param entity_handles_size Occupied size of entity_handles array
- */
- void iGeom_getPntArrClsf( iGeom_Instance,
+ /**\brief Get the entities on which points are located
+ *
+ * Get the entities on which points are located. Storage orders should be
+ * members of the iBase_StorageOrder enumeration.
+ * \param instance iGeom instance handle
+ * \param storage_order Storage order of coordinates in coords
+ * \param coords Points being queried
+ * \param coords_size Number of entries in coords array
+ * \param entity_handles Entities on which points are located
+ * \param entity_handles_allocated Allocated size of entity_handles array
+ * \param entity_handles_size Occupied size of entity_handles array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getPntArrClsf( iGeom_Instance instance,
int storage_order,
double const* coords,
int coords_size,
@@ -1075,33 +1153,41 @@
int* entity_handles_size,
int* err );
-/**\brief Get the sense of a face with respect to a region
- * Get the sense of a face with respect to a region. Sense returned is -1, 0, or 1,
- * representing "reversed", "both", or "forward". "both" sense indicates that face bounds
- * the region once with each sense.
- * \param face Face being queried
- * \param region Region being queried
- * \param sense_out Sense of face with respect to region
- */
- void iGeom_getEntNrmlSense( iGeom_Instance,
+ /**\brief Get the sense of a face with respect to a region
+ *
+ * Get the sense of a face with respect to a region. Sense returned is -1,
+ * 0, or 1, representing "reversed", "both", or "forward". "both" sense
+ * indicates that face bounds the region once with each sense.
+ * \param instance iGeom instance handle
+ * \param face Face being queried
+ * \param region Region being queried
+ * \param sense_out Sense of face with respect to region
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntNrmlSense( iGeom_Instance instance,
iBase_EntityHandle face,
iBase_EntityHandle region,
int* sense_out,
int* err );
-/**\brief Get the senses of an array of faces with respect to an array of regions
- * Get the senses of an array of faces with respect to an array of regions. Sense returned
- * is -1, 0, or 1, representing "reversed", "both", or "forward". "both" sense indicates
- * that face bounds the region once with each sense.
- * \param face_handles Faces being queried
- * \param face_handles_size Size of face handles array
- * \param region_handles Regions being queried
- * \param region_handles_size Size of region handles array
- * \param sense Senses of faces with respect to regions
- * \param sense_allocated Allocated size of senses array
- * \param sense_size Occupied size of senses array
- */
- void iGeom_getArrNrmlSense( iGeom_Instance,
+ /**\brief Get the senses of an array of faces with respect to an array of
+ * regions
+ *
+ * Get the senses of an array of faces with respect to an array of regions.
+ * Sense returned is -1, 0, or 1, representing "reversed", "both", or
+ * "forward". "both" sense indicates that face bounds the region once with
+ * each sense.
+ * \param instance iGeom instance handle
+ * \param face_handles Faces being queried
+ * \param face_handles_size Size of face handles array
+ * \param region_handles Regions being queried
+ * \param region_handles_size Size of region handles array
+ * \param sense Senses of faces with respect to regions
+ * \param sense_allocated Allocated size of senses array
+ * \param sense_size Occupied size of senses array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrNrmlSense( iGeom_Instance instance,
iBase_EntityHandle const* face_handles,
int face_handles_size,
iBase_EntityHandle const* region_handles,
@@ -1111,33 +1197,41 @@
int* sense_size,
int* err );
-/**\brief Get the sense of an edge with respect to a face
- * Get the sense of an edge with respect to a face. Sense returned is -1, 0, or 1,
- * representing "reversed", "both", or "forward". "both" sense indicates that edge bounds
- * the face once with each sense.
- * \param edge Edge being queried
- * \param face Face being queried
- * \param sense_out Sense of edge with respect to face
- */
+ /**\brief Get the sense of an edge with respect to a face
+ *
+ * Get the sense of an edge with respect to a face. Sense returned is -1,
+ * 0, or 1, representing "reversed", "both", or "forward". "both" sense
+ * indicates that edge bounds the face once with each sense.
+ * \param instance iGeom instance handle
+ * \param edge Edge being queried
+ * \param face Face being queried
+ * \param sense_out Sense of edge with respect to face
+ * \param *err Pointer to error type returned from function
+ */
void iGeom_getEgFcSense( iGeom_Instance,
iBase_EntityHandle edge,
iBase_EntityHandle face,
int* sense_out,
int* err );
-/**\brief Get the senses of an array of edges with respect to an array of faces
- * Get the senses of an array of edges with respect to an array of faces. Sense returned
- * is -1, 0, or 1, representing "reversed", "both", or "forward". "both" sense indicates
- * that edge bounds the face once with each sense.
- * \param edge_handles Edges being queried
- * \param edge_handles_size Size of edge handles array
- * \param face_handles Faces being queried
- * \param face_handles_size Size of face handles array
- * \param sense Senses of faces with respect to regions
- * \param sense_allocated Allocated size of senses array
- * \param sense_size Occupied size of senses array
- */
- void iGeom_getEgFcArrSense( iGeom_Instance,
+ /**\brief Get the senses of an array of edges with respect to an array of
+ * faces
+ *
+ * Get the senses of an array of edges with respect to an array of faces.
+ * Sense returned is -1, 0, or 1, representing "reversed", "both", or
+ * "forward". "both" sense indicates that edge bounds the face once with
+ * each sense.
+ * \param instance iGeom instance handle
+ * \param edge_handles Edges being queried
+ * \param edge_handles_size Size of edge handles array
+ * \param face_handles Faces being queried
+ * \param face_handles_size Size of face handles array
+ * \param sense Senses of faces with respect to regions
+ * \param sense_allocated Allocated size of senses array
+ * \param sense_size Occupied size of senses array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEgFcArrSense( iGeom_Instance instance,
iBase_EntityHandle const* edge_handles,
int edge_handles_size,
iBase_EntityHandle const* face_handles,
@@ -1147,37 +1241,45 @@
int* sense_size,
int* err );
-/**\brief Get the sense of a vertex pair with respect to an edge
- * Get the sense of a vertex pair with respect to an edge. Sense returned is -1, 0, or 1,
- * representing "reversed", "both", or "forward". "both" sense indicates that vertices
- * are identical and that vertex bounds both sides of the edge
- * \param edge Edge being queried
- * \param vertex1 First vertex being queried
- * \param vertex2 Second vertex being queried
- * \param sense_out Sense of vertex pair with respect to edge
- */
- void iGeom_getEgVtxSense( iGeom_Instance,
+ /**\brief Get the sense of a vertex pair with respect to an edge
+ *
+ * Get the sense of a vertex pair with respect to an edge. Sense returned
+ * is -1, 0, or 1, representing "reversed", "both", or "forward". "both"
+ * sense indicates that vertices are identical and that vertex bounds both
+ * sides of the edge.
+ * \param instance iGeom instance handle
+ * \param edge Edge being queried
+ * \param vertex1 First vertex being queried
+ * \param vertex2 Second vertex being queried
+ * \param sense_out Sense of vertex pair with respect to edge
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEgVtxSense( iGeom_Instance instance,
iBase_EntityHandle edge,
iBase_EntityHandle vertex1,
iBase_EntityHandle vertex2,
int* sense_out,
int* err );
-/**\brief Get the senses of vertex pair with respect to a edges
- * Get the senses of vertex pairs with respect to edges. Sense returned is -1, 0, or 1,
- * representing "reversed", "both", or "forward". "both" sense indicates that both vertices
- * in pair are identical and that vertex bounds both sides of the edge
- * \param edge_handles Edges being queried
- * \param edge_handles_size Number of edges being queried
- * \param vertex_handles_1 First vertex being queried
- * \param vertex_handles_1_size Number of vertices in vertices array
- * \param vertex_handles_2 Second vertex being queried
- * \param vertex_handles_2_size Number of vertices in vertices array
- * \param sense Sense of vertex pair with respect to edge
- * \param sense_allocated Allocated size of sense array
- * \param sense_size Occupied size of sense array
- */
- void iGeom_getEgVtxArrSense( iGeom_Instance,
+ /**\brief Get the senses of vertex pair with respect to a edges
+ *
+ * Get the senses of vertex pairs with respect to edges. Sense returned is
+ * -1, 0, or 1, representing "reversed", "both", or "forward". "both" sense
+ * indicates that both vertices in pair are identical and that vertex bounds
+ * both sides of the edge.
+ * \param instance iGeom instance handle
+ * \param edge_handles Edges being queried
+ * \param edge_handles_size Number of edges being queried
+ * \param vertex_handles_1 First vertex being queried
+ * \param vertex_handles_1_size Number of vertices in vertices array
+ * \param vertex_handles_2 Second vertex being queried
+ * \param vertex_handles_2_size Number of vertices in vertices array
+ * \param sense Sense of vertex pair with respect to edge
+ * \param sense_allocated Allocated size of sense array
+ * \param sense_size Occupied size of sense array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEgVtxArrSense( iGeom_Instance instance,
iBase_EntityHandle const* edge_handles,
int edge_handles_size,
iBase_EntityHandle const* vertex_handles_1,
@@ -1189,15 +1291,18 @@
int* sense_size,
int* err );
-/**\brief Return the measure (length, area, volume) of entities
- * Return the measure (length, area, volume) of entities
- * \param entity_handles Array of entities being queried
- * \param entity_handles_size Number of entities in entity array
- * \param measures Measures of entities being queried
- * \param measures_allocated Allocated size of measures array
- * \param measures_size Occupied size of measures array
- */
- void iGeom_measure( iGeom_Instance,
+ /**\brief Return the measure (length, area, or volume) of entities
+ *
+ * Return the measure (length, area, or volume) of entities
+ * \param instance iGeom instance handle
+ * \param entity_handles Array of entities being queried
+ * \param entity_handles_size Number of entities in entity array
+ * \param measures Measures of entities being queried
+ * \param measures_allocated Allocated size of measures array
+ * \param measures_size Occupied size of measures array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_measure( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
double** measures,
@@ -1205,45 +1310,60 @@
int* measures_size,
int* err );
-/**\brief Get the geometric type of an entity
- * Get the geometric type of an entity. Specific types depend on implementation.
- * \param face_handle Face being queried
- * \param face_type Face type
- * \param face_type_length Length of face type string
- */
- void iGeom_getFaceType( iGeom_Instance,
+ /**\brief Get the geometric type of a face
+ *
+ * Get the geometric type of a face. Specific types depend on
+ * implementation.
+ * \param instance iGeom instance handle
+ * \param face_handle Face being queried
+ * \param face_type Face type
+ * \param face_type_length Length of face type string
+ */
+ void iGeom_getFaceType( iGeom_Instance instance,
iBase_EntityHandle face_handle,
char* face_type,
int* err,
int* face_type_length);
-/**\brief Return whether interface has information about parameterization
- * Return whether an interface has information about parameterization (!=0) or not (0)
- * \param is_parametric If non-zero, interface has information about parameterization
- */
- void iGeom_getParametric( iGeom_Instance,
+ /**\brief Return whether interface has information about parameterization
+ *
+ * Return whether an interface has information about parameterization (!=0)
+ * or not (0)
+ * \param instance iGeom instance handle
+ * \param is_parametric If non-zero, interface has information about
+ * parameterization
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getParametric( iGeom_Instance instance,
int* is_parametric,
int* err );
-/**\brief Return whether an entity has a parameterization
- * Return whether an entity has a parameterization (!= 0) or not (=0)
- * \param entity_handle Entity being queried
- * \param is_parametric Entity has a parameterization (!= 0) or not (=0)
- */
- void iGeom_isEntParametric( iGeom_Instance,
+ /**\brief Return whether an entity has a parameterization
+ *
+ * Return whether an entity has a parameterization (=1) or not (=0)
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param is_parametric Entity has a parameterization (=1) or not (=0)
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isEntParametric( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
int* parametric,
int* err );
-/**\brief Return whether entities have parameterizations
- * Return whether entities have parameterizations (!= 0) or not (=0)
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param is_parametric entity_handles[i] has a parameterization (!= 0) or not (=0)
- * \param is_parametric_allocated Allocated size of is_parametric array
- * \param is_parametric_size Occupied size of is_parametric array
- */
- void iGeom_isArrParametric( iGeom_Instance,
+ /**\brief Return whether entities have parameterizations
+ *
+ * Return whether entities have parameterizations (=1) or not (=0)
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param is_parametric entity_handles[i] has a parameterization (=1) or
+ * not (=0)
+ * \param is_parametric_allocated Allocated size of is_parametric array
+ * \param is_parametric_size Occupied size of is_parametric array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isArrParametric( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int** is_parametric,
@@ -1251,16 +1371,20 @@
int* is_parametric_size,
int* err );
-/**\brief Return coordinate position at specified parametric position on entity
- * Return coordinate position at specified parametric position on entity.
- * \param entity_handle Entity being queried
- * \param u Parametric coordinate being queried
- * \param v Parametric coordinate being queried
- * \param x Spatial coordinate at parametric position being queried
- * \param y Spatial coordinate at parametric position being queried
- * \param z Spatial coordinate at parametric position being queried
- */
- void iGeom_getEntUVtoXYZ( iGeom_Instance,
+ /**\brief Return coordinate position at specified parametric position on
+ * entity
+ *
+ * Return coordinate position at specified parametric position on entity.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric coordinate being queried
+ * \param v Parametric coordinate being queried
+ * \param x Spatial coordinate at parametric position being queried
+ * \param y Spatial coordinate at parametric position being queried
+ * \param z Spatial coordinate at parametric position being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntUVtoXYZ( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double v,
@@ -1269,23 +1393,28 @@
double* z,
int* err );
-/**\brief Return coordinate positions at specified parametric position(s) on entity(ies)
- * Return coordinate positions at specified parametric position(s) on entity(ies).
- * If either the number of entities or number of parametric coordinate pairs is unity, then
- * all points or entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of uv coordinates input and xyz coordinate output
- * \param uv Coordinates being queried
- * \param uv_size Number of coordinates in array
- * \param coordinates Coordinates of parametric positions
- * \param coordinates_allocated Allocated size of coordinates array
- * \param coordinates_size Occupied size of coordinates array
- */
- void iGeom_getArrUVtoXYZ( iGeom_Instance,
+ /**\brief Return coordinate positions at specified parametric position(s)
+ * on entity(ies)
+ *
+ * Return coordinate positions at specified parametric position(s) on
+ * entity(ies). If either the number of entities or number of parametric
+ * coordinate pairs is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of uv coordinates input and xyz
+ * coordinate output
+ * \param uv Coordinates being queried
+ * \param uv_size Number of coordinates in array
+ * \param coordinates Coordinates of parametric positions
+ * \param coordinates_allocated Allocated size of coordinates array
+ * \param coordinates_size Occupied size of coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrUVtoXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1296,15 +1425,19 @@
int* coordinates_size,
int* err );
-/**\brief Return coordinate position at specified parametric position on entity
- * Return coordinate position at specified parametric position on entity.
- * \param entity_handle Entity being queried
- * \param u Parametric coordinate being queried
- * \param x Spatial coordinate at parametric position being queried
- * \param y Spatial coordinate at parametric position being queried
- * \param z Spatial coordinate at parametric position being queried
- */
- void iGeom_getEntUtoXYZ( iGeom_Instance,
+ /**\brief Return coordinate position at specified parametric position on
+ * entity
+ *
+ * Return coordinate position at specified parametric position on entity.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric coordinate being queried
+ * \param x Spatial coordinate at parametric position being queried
+ * \param y Spatial coordinate at parametric position being queried
+ * \param z Spatial coordinate at parametric position being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntUtoXYZ( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double* x,
@@ -1312,23 +1445,27 @@
double* z,
int* err );
-/**\brief Return coordinate positions at specified parametric position(s) on entity(ies)
- * Return coordinate positions at specified parametric position(s) on entity(ies).
- * If either the number of entities or number of parametric coordinate pairs is unity, then
- * all points or entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of resulting coordinates
- * \param uv Coordinates being queried
- * \param uv_size Number of coordinates in array
- * \param coordinates Coordinates of parametric positions
- * \param coordinates_allocated Allocated size of coordinates array
- * \param coordinates_size Occupied size of coordinates array
- */
- void iGeom_getArrUtoXYZ( iGeom_Instance,
+ /**\brief Return coordinate positions at specified parametric position(s)
+ * on entity(ies)
+ *
+ * Return coordinate positions at specified parametric position(s) on
+ * entity(ies). If either the number of entities or number of parametric
+ * coordinate pairs is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of resulting coordinates
+ * \param uv Coordinates being queried
+ * \param uv_size Number of coordinates in array
+ * \param coordinates Coordinates of parametric positions
+ * \param coordinates_allocated Allocated size of coordinates array
+ * \param coordinates_size Occupied size of coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrUtoXYZ( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
double const* u,
@@ -1339,16 +1476,20 @@
int* on_coords_size,
int* err );
-/**\brief Return parametric position at specified spatial position on entity
- * Return parametric position at specified spatial position on entity
- * \param entity_handle Entity being queried
- * \param x Spatial coordinate being queried
- * \param y Spatial coordinate being queried
- * \param z Spatial coordinate being queried
- * \param u Parametric coordinate at spatial position being queried
- * \param v Parametric coordinate at spatial position being queried
- */
- void iGeom_getEntXYZtoUV( iGeom_Instance,
+ /**\brief Return parametric position at specified spatial position on
+ * entity
+ *
+ * Return parametric position at specified spatial position on entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param x Spatial coordinate being queried
+ * \param y Spatial coordinate being queried
+ * \param z Spatial coordinate being queried
+ * \param u Parametric coordinate at spatial position being queried
+ * \param v Parametric coordinate at spatial position being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntXYZtoUV( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -1357,15 +1498,19 @@
double* v,
int* err );
-/**\brief Return parametric position at specified spatial position on entity
- * Return parametric position at specified spatial position on entity
- * \param entity_handle Entity being queried
- * \param x Spatial coordinate being queried
- * \param y Spatial coordinate being queried
- * \param z Spatial coordinate being queried
- * \param u Parametric coordinate at spatial position being queried
- */
- void iGeom_getEntXYZtoU( iGeom_Instance,
+ /**\brief Return parametric position at specified spatial position on
+ * entity
+ *
+ * Return parametric position at specified spatial position on entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param x Spatial coordinate being queried
+ * \param y Spatial coordinate being queried
+ * \param z Spatial coordinate being queried
+ * \param u Parametric coordinate at spatial position being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntXYZtoU( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -1373,23 +1518,26 @@
double* u,
int* err );
-/**\brief Return parametric positions at specified spatial position(s) on entity(ies)
- * Return parametric positions at specified spatial position(s) on entity(ies).
- * If either the number of entities or number of spatial coordinate triples is unity, then
- * all points or entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of spatial coordinates input
- * \param coordinates Coordinates being queried
- * \param coordinates_size Number of coordinates in array
- * \param uv Coordinates of parametric positions
- * \param uv_allocated Allocated size of coordinates array
- * \param uv_size Occupied size of coordinates array
- */
- void iGeom_getArrXYZtoUV( iGeom_Instance,
+ /**\brief Return parametric positions at specified spatial position(s) on
+ * entity(ies)
+ * Return parametric positions at specified spatial position(s) on
+ * entity(ies). If either the number of entities or number of spatial
+ * coordinate triples is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of spatial coordinates input
+ * \param coordinates Coordinates being queried
+ * \param coordinates_size Number of coordinates in array
+ * \param uv Coordinates of parametric positions
+ * \param uv_allocated Allocated size of coordinates array
+ * \param uv_size Occupied size of coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrXYZtoUV( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1400,23 +1548,27 @@
int* uv_size,
int* err );
-/**\brief Return spatial positions at specified parametric position(s) on entity(ies)
- * Return spatial positions at specified parametric position(s) on entity(ies).
- * If either the number of entities or number of spatial coordinate triples is unity, then
- * all points or entities are queried for that entity or point, respectively, otherwise each
- * point corresponds to each entity. storage_order should be a value in
- * the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in native order
- * with respect to implementation.
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of spatial coordinates input
- * \param coordinates Coordinates being queried
- * \param coordinates_size Number of coordinates in array
- * \param u Coordinates of parametric positions
- * \param u_allocated Allocated size of coordinates array
- * \param u_size Occupied size of coordinates array
- */
- void iGeom_getArrXYZtoU( iGeom_Instance,
+ /**\brief Return spatial positions at specified parametric position(s) on
+ * entity(ies)
+ *
+ * Return spatial positions at specified parametric position(s) on
+ * entity(ies). If either the number of entities or number of spatial
+ * coordinate triples is unity, then all points or entities are queried for
+ * that entity or point, respectively, otherwise each point corresponds to
+ * each entity. storage_order should be a value in the iBase_StorageOrder
+ * enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of spatial coordinates input
+ * \param coordinates Coordinates being queried
+ * \param coordinates_size Number of coordinates in array
+ * \param u Coordinates of parametric positions
+ * \param u_allocated Allocated size of coordinates array
+ * \param u_size Occupied size of coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrXYZtoU( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1427,18 +1579,23 @@
int* u_size,
int* err );
-/**\brief Return parametric position at specified spatial position on entity, based on parametric position hint
- * Return parametric position at specified spatial position on entity, based on parametric
- * position hint. For this function, u and v are input with parameters from which to start search.
- * Typically this will reduce the search time for new parametric coordinates.
- * \param entity_handle Entity being queried
- * \param x Spatial coordinate being queried
- * \param y Spatial coordinate being queried
- * \param z Spatial coordinate being queried
- * \param u Parametric coordinate at spatial position being queried
- * \param v Parametric coordinate at spatial position being queried
- */
- void iGeom_getEntXYZtoUVHint( iGeom_Instance,
+ /**\brief Return parametric position at specified spatial position on
+ * entity, based on parametric position hint
+ *
+ * Return parametric position at specified spatial position on entity,
+ * based on parametric position hint. For this function, u and v are input
+ * with parameters from which to start search. Typically this will reduce
+ * the search time for new parametric coordinates.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param x Spatial coordinate being queried
+ * \param y Spatial coordinate being queried
+ * \param z Spatial coordinate being queried
+ * \param u Parametric coordinate at spatial position being queried
+ * \param v Parametric coordinate at spatial position being queried
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntXYZtoUVHint( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double x,
double y,
@@ -1447,23 +1604,26 @@
double* v,
int* err );
-/**\brief Return parametric positions at specified spatial position(s) on entity(ies), based on parametric position hints
- * Return parametric positions at specified spatial position(s) on entity(ies), based on
- * parametric position hints. If either the number of entities or number of spatial
- * coordinate triples is unity, then all points or entities are queried for that entity
- * or point, respectively, otherwise each point corresponds to each entity. storage_order
- * should be a value in the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in
- * native order with respect to implementation.
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of spatial coordinates input
- * \param coordinates Coordinates being queried
- * \param coordinates_size Number of coordinates in array
- * \param uv Coordinates of parametric positions
- * \param uv_allocated Allocated size of coordinates array
- * \param uv_size Occupied size of coordinates array
- */
- void iGeom_getArrXYZtoUVHint( iGeom_Instance,
+ /**\brief Return parametric positions at specified spatial position(s) on
+ * entity(ies), based on parametric position hints
+ * Return parametric positions at specified spatial position(s) on
+ * entity(ies), based on parametric position hints. If either the number of
+ * entities or number of spatial coordinate triples is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of spatial coordinates input
+ * \param coordinates Coordinates being queried
+ * \param coordinates_size Number of coordinates in array
+ * \param uv Coordinates of parametric positions
+ * \param uv_allocated Allocated size of coordinates array
+ * \param uv_size Occupied size of coordinates array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrXYZtoUVHint( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1474,15 +1634,18 @@
int* uv_size,
int* err );
-/**\brief Get parametric range of entity
- * Get parametric range of entity
- * \param entity_handle Entity being queried
- * \param u_min Minimum parametric coordinate for entity
- * \param v_min Minimum parametric coordinate for entity
- * \param u_max Maximum parametric coordinate for entity
- * \param v_max Maximum parametric coordinate for entity
- */
- void iGeom_getEntUVRange( iGeom_Instance,
+ /**\brief Get parametric range of entity
+ *
+ * Get parametric range of entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u_min Minimum parametric coordinate for entity
+ * \param v_min Minimum parametric coordinate for entity
+ * \param u_max Maximum parametric coordinate for entity
+ * \param v_max Maximum parametric coordinate for entity
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntUVRange( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double* u_min,
double* v_min,
@@ -1490,31 +1653,40 @@
double* v_max,
int* err );
-/**\brief Get parametric range of entity
- * Get parametric range of entity
- * \param entity_handle Entity being queried
- * \param u_min Minimum parametric coordinate for entity
- * \param u_max Maximum parametric coordinate for entity
- */
- void iGeom_getEntURange( iGeom_Instance,
+ /**\brief Get parametric range of entity
+ *
+ * Get parametric range of entity
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u_min Minimum parametric coordinate for entity
+ * \param u_max Maximum parametric coordinate for entity
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntURange( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double* u_min,
double* u_max,
int* err );
-/**\brief Get parametric range of entities
- * Get parametric range of entities
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of parametric coordinates being returned
- * \param uv_min Minimum parametric coordinate for entities
- * \param uv_min_allocated Allocated size of minimum parametric coordinate array
- * \param uv_min_size Occupied size of minimum parametric coordinate array
- * \param uv_max Maximum parametric coordinate for entities
- * \param uv_max_allocated Allocated size of maximum parametric coordinate array
- * \param uv_max_size Occupied size of maximum parametric coordinate array
- */
- void iGeom_getArrUVRange( iGeom_Instance,
+ /**\brief Get parametric range of entities
+ *
+ * Get parametric range of entities
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of parametric coordinates being
+ * returned
+ * \param uv_min Minimum parametric coordinate for entities
+ * \param uv_min_allocated Allocated size of minimum parametric coordinate
+ * array
+ * \param uv_min_size Occupied size of minimum parametric coordinate array
+ * \param uv_max Maximum parametric coordinate for entities
+ * \param uv_max_allocated Allocated size of maximum parametric coordinate
+ * array
+ * \param uv_max_size Occupied size of maximum parametric coordinate array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrUVRange( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1526,19 +1698,25 @@
int* uv_max_size,
int* err );
-/**\brief Get parametric range of entities
- * Get parametric range of entities
- * \param entity_handles Entities being queried
- * \param entity_handles_size Number of entities being queried
- * \param storage_order Storage order of parametric coordinates being returned
- * \param u_min Minimum parametric coordinate for entities
- * \param u_min_allocated Allocated size of minimum parametric coordinate array
- * \param u_min_size Occupied size of minimum parametric coordinate array
- * \param u_max Maximum parametric coordinate for entities
- * \param u_max_allocated Allocated size of maximum parametric coordinate array
- * \param u_max_size Occupied size of maximum parametric coordinate array
- */
- void iGeom_getArrURange( iGeom_Instance,
+ /**\brief Get parametric range of entities
+ *
+ * Get parametric range of entities
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param storage_order Storage order of parametric coordinates being
+ * returned
+ * \param u_min Minimum parametric coordinate for entities
+ * \param u_min_allocated Allocated size of minimum parametric coordinate
+ * array
+ * \param u_min_size Occupied size of minimum parametric coordinate array
+ * \param u_max Maximum parametric coordinate for entities
+ * \param u_max_allocated Allocated size of maximum parametric coordinate
+ * array
+ * \param u_max_size Occupied size of maximum parametric coordinate array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrURange( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
double** u_min,
@@ -1549,15 +1727,20 @@
int* u_max_size,
int* err );
-/**\brief Return the face parametric coordinates for a parametric position on a bounding edge
- * Return the face parametric coordinates for a parametric position on a bounding edge
- * \param edge_handle Edge being queried
- * \param face_handle Face being queried
- * \param in_u Parametric position on edge
- * \param u Corresponding parametric position on face
- * \param v Corresponding parametric position on face
- */
- void iGeom_getEntUtoUV( iGeom_Instance,
+ /**\brief Return the face parametric coordinates for a parametric position
+ * on a bounding edge
+ *
+ * Return the face parametric coordinates for a parametric position on a
+ * bounding edge
+ * \param instance iGeom instance handle
+ * \param edge_handle Edge being queried
+ * \param face_handle Face being queried
+ * \param in_u Parametric position on edge
+ * \param u Corresponding parametric position on face
+ * \param v Corresponding parametric position on face
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntUtoUV( iGeom_Instance instance,
iBase_EntityHandle edge_handle,
iBase_EntityHandle face_handle,
double in_u,
@@ -1565,46 +1748,57 @@
double* v,
int* err );
-/**\brief Return parametric coordinates on face of vertex position
- * Return parametric coordinates on face of vertex position
- * \param vertex_handle Vertex being queried
- * \param face_handle Face being queried
- * \param u Corresponding parametric position on face
- * \param v Corresponding parametric position on face
- */
- void iGeom_getVtxToUV( iGeom_Instance,
+ /**\brief Return parametric coordinates on face of vertex position
+ *
+ * Return parametric coordinates on face of vertex position
+ * \param instance iGeom instance handle
+ * \param vertex_handle Vertex being queried
+ * \param face_handle Face being queried
+ * \param u Corresponding parametric position on face
+ * \param v Corresponding parametric position on face
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getVtxToUV( iGeom_Instance instance,
iBase_EntityHandle vertex_handle,
iBase_EntityHandle face_handle,
double* u,
double* v,
int* err );
-/**\brief Return parametric coordinates on edge of vertex position
- * Return parametric coordinates on edge of vertex position
- * \param vertex_handle Vertex being queried
- * \param edge_handle Edge being queried
- * \param u Corresponding parametric position on face
- */
- void iGeom_getVtxToU( iGeom_Instance,
+ /**\brief Return parametric coordinates on edge of vertex position
+ *
+ * Return parametric coordinates on edge of vertex position
+ * \param instance iGeom instance handle
+ * \param vertex_handle Vertex being queried
+ * \param edge_handle Edge being queried
+ * \param u Corresponding parametric position on face
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getVtxToU( iGeom_Instance instance,
iBase_EntityHandle vertex_handle,
iBase_EntityHandle edge_handle,
double* u,
int* err );
-/**\brief Return the face parametric coordinates for a parametric position on bounding edges
- * Return the face parametric coordinates for a parametric position on bounding edges
- * \param edge_handles Edges being queried
- * \param edge_handles_size Number of edges being queried
- * \param face_handles Faces being queried
- * \param face_handles_size Number of faces being queried
- * \param u_in Parametric positions on edges
- * \param u_in_size Number of parametric positions on edges
- * \param storage_order Storage order of coordinates returned
- * \param uv Corresponding parametric positions on faces
- * \param uv_allocated Allocated size of parameter array
- * \param uv_size Occupied size of parameter array
- */
- void iGeom_getArrUtoUV( iGeom_Instance,
+ /**\brief Return the face parametric coordinates for a parametric position
+ * on bounding edges
+ *
+ * Return the face parametric coordinates for a parametric position on
+ * bounding edges
+ * \param instance iGeom instance handle
+ * \param edge_handles Edges being queried
+ * \param edge_handles_size Number of edges being queried
+ * \param face_handles Faces being queried
+ * \param face_handles_size Number of faces being queried
+ * \param u_in Parametric positions on edges
+ * \param u_in_size Number of parametric positions on edges
+ * \param storage_order Storage order of coordinates returned
+ * \param uv Corresponding parametric positions on faces
+ * \param uv_allocated Allocated size of parameter array
+ * \param uv_size Occupied size of parameter array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrUtoUV( iGeom_Instance instance,
iBase_EntityHandle const* edge_handles,
int edge_handles_size,
iBase_EntityHandle const* face_handles,
@@ -1617,18 +1811,21 @@
int* uv_size,
int* err );
-/**\brief Return parametric coordinates on faces of vertex positions
- * Return parametric coordinates on faces of vertex positions
- * \param vertex_handles Vertices being queried
- * \param vertex_handles_size Number of vertices being queried
- * \param face_handles Faces being queried
- * \param face_handles_size Number of faces being queried
- * \param storage_order Storage order of coordinates returned
- * \param uv Corresponding parametric positions on faces
- * \param uv_allocated Allocated size of positions array
- * \param uv_size Occupied size of positions array
- */
- void iGeom_getVtxArrToUV( iGeom_Instance,
+ /**\brief Return parametric coordinates on faces of vertex positions
+ *
+ * Return parametric coordinates on faces of vertex positions
+ * \param instance iGeom instance handle
+ * \param vertex_handles Vertices being queried
+ * \param vertex_handles_size Number of vertices being queried
+ * \param face_handles Faces being queried
+ * \param face_handles_size Number of faces being queried
+ * \param storage_order Storage order of coordinates returned
+ * \param uv Corresponding parametric positions on faces
+ * \param uv_allocated Allocated size of positions array
+ * \param uv_size Occupied size of positions array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getVtxArrToUV( iGeom_Instance instance,
iBase_EntityHandle const* vertex_handles,
int vertex_handles_size,
iBase_EntityHandle const* face_handles,
@@ -1639,17 +1836,20 @@
int* uv_size,
int* err );
-/**\brief Return parametric coordinates on edges of vertex positions
- * Return parametric coordinates on edges of vertex positions
- * \param vertex_handles Vertices being queried
- * \param vertex_handles_size Number of vertices being queried
- * \param edge_handles Edges being queried
- * \param edge_handles_size Number of edges being queried
- * \param u Corresponding parametric positions on faces
- * \param u_allocated Allocated size of positions array
- * \param u_size Occupied size of positions array
- */
- void iGeom_getVtxArrToU( iGeom_Instance,
+ /**\brief Return parametric coordinates on edges of vertex positions
+ *
+ * Return parametric coordinates on edges of vertex positions
+ * \param instance iGeom instance handle
+ * \param vertex_handles Vertices being queried
+ * \param vertex_handles_size Number of vertices being queried
+ * \param edge_handles Edges being queried
+ * \param edge_handles_size Number of edges being queried
+ * \param u Corresponding parametric positions on faces
+ * \param u_allocated Allocated size of positions array
+ * \param u_size Occupied size of positions array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getVtxArrToU( iGeom_Instance instance,
iBase_EntityHandle const* vertex_handles,
int vertex_handles_size,
iBase_EntityHandle const* edge_handles,
@@ -1659,16 +1859,19 @@
int* u_size,
int* err );
-/**\brief Return the normal at a specified parametric position
- * Return the normal at a specified parametric position
- * \param entity_handle Entity being queried
- * \param u Parametric position being queried
- * \param v Parametric position being queried
- * \param nrml_i Normal at specified position
- * \param nrml_j Normal at specified position
- * \param nrml_k Normal at specified position
- */
- void iGeom_getEntNrmlUV( iGeom_Instance,
+ /**\brief Return the normal at a specified parametric position
+ *
+ * Return the normal at a specified parametric position
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric position being queried
+ * \param v Parametric position being queried
+ * \param nrml_i Normal at specified position
+ * \param nrml_j Normal at specified position
+ * \param nrml_k Normal at specified position
+ * \param *err Pointer to error type returned from functino
+ */
+ void iGeom_getEntNrmlUV( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double v,
@@ -1677,18 +1880,25 @@
double* nrml_k,
int* err );
-/**\brief Return the normals at a specified parametric positions
- * Return the normals at a specified parametric positions. If either the number of
- * entities or number of spatial
- * coordinate triples is unity, then all points or entities are queried for that entity
- * or point, respectively, otherwise each point corresponds to each entity. storage_order
- * should be a value in the iBase_StorageOrder enum; if input as iBase_UNKNOWN, order is in
- * native order with respect to implementation.
- * \param entity_handle Entity being queried
- * \param u Parametric position being queried
- * \param v Parametric position being queried
- */
- void iGeom_getArrNrmlUV( iGeom_Instance,
+ /**\brief Return the normals at specified parametric positions
+ *
+ * Return the normals at specified parametric positions. If either the
+ * number of entities or number of spatial coordinate pairs is unity, then
+ * all points or entities are queried for that entity or point,
+ * respectively, otherwise each point corresponds to each entity.
+ * storage_order should be a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param face_handle Faces being queried
+ * \param face_handles_size Number of faces being queried
+ * \param storage_order Storage order of coordinates input and output
+ * \param parameters Parametric coordinates being queried
+ * \param parameters_size Number of coordinates in array
+ * \param normals Coordinates of normals at specified positions
+ * \param normals_allocated Allocated size of normals array
+ * \param normals_size Occupied size of normals array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrNrmlUV( iGeom_Instance instance,
iBase_EntityHandle const* face_handles,
int face_handles_size,
int storage_order,
@@ -1699,10 +1909,18 @@
int* normals_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getEntTgntU( iGeom_Instance,
+ /**\brief Return the tangent at a specified parametric position
+ *
+ * Return the tangent at a specified parametric position
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric position being queried
+ * \param tgnt_i Tangent at specified position
+ * \param tgnt_j Tangent at specified position
+ * \param tgnt_k Tangent at specified position
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntTgntU( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double* tgnt_i,
@@ -1710,10 +1928,25 @@
double* tgnt_k,
int* err );
-/**\brief
- *
- */
- void iGeom_getArrTgntU( iGeom_Instance,
+ /**\brief Return the tangents at specified parametric positions
+ *
+ * Return the tangents at specified parametric positions. If either the
+ * number of entities or number of spatial coordinates is unity, then all
+ * points or entities are queried for that entity or point, respectively,
+ * otherwise each point corresponds to each entity. storage_order should be
+ * a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param edge_handle Edges being queried
+ * \param edge_handles_size Number of faces being queried
+ * \param storage_order Storage order of coordinates output
+ * \param parameters Parametric coordinates being queried
+ * \param parameters_size Number of coordinates in array
+ * \param tangents Coordinates of tangents at specified positions
+ * \param tangents_allocated Allocated size of tangents array
+ * \param tangents_size Occupied size of tangents array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrTgntU( iGeom_Instance instance,
iBase_EntityHandle const* edge_handles,
int edge_handles_size,
int storage_order,
@@ -1724,10 +1957,25 @@
int* tangents_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getEnt1stDrvt( iGeom_Instance,
+ /**\brief Get the first derivative of a face at specified parametric
+ * position
+ *
+ * Get the first derivative of a face at specified parametric position.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric position being queried
+ * \param v Parametric position being queried
+ * \param dvrt_u Pointer to coordinates of derivative with respect to u at
+ * specified position returned from function
+ * \param dvrt_u_allocated Allocated size of dvrt_u array
+ * \param dvrt_u_size Occupied size of dvrt_u array
+ * \param dvrt_v Pointer to coordinates of derivative with respect to v at
+ * specified position returned from function
+ * \param dvrt_v_allocated Allocated size of dvrt_v array
+ * \param dvrt_v_size Occupied size of dvrt_v array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEnt1stDrvt( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double v,
@@ -1739,16 +1987,42 @@
int* dvrt_v_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getArr1stDrvt( iGeom_Instance,
+ /**\brief Get the first derivatives of faces at specified parametric
+ * positions
+ *
+ * Get the first derivatives of faces at specified parametric positions.
+ * storage_order should be a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param storage_order Storage order of coordinates input and output
+ * \param uv Parametric coordinates being queried
+ * \param uv_size Number of coordinates in array
+ * \param dvrt_u Pointer to array of coordinates of derivative with respect
+ * to u at specified position returned from function
+ * \param dvrt_u_allocated Allocated size of dvrt_u array
+ * \param dvrt_u_size Occupied size of dvrt_u array
+ * \param u_offset Pointer to array of offsets for dvrt_u returned from
+ * function
+ * \param u_offset_allocated Pointer to allocated size of u_offset array
+ * \param u_offset_size Pointer to occupied size of u_offset array
+ * \param dvrt_v Pointer to array of coordinates of derivative with respect
+ * to v at specified position returned from function
+ * \param dvrt_v_allocated Allocated size of dvrt_v array
+ * \param dvrt_v_size Occupied size of dvrt_v array
+ * \param v_offset Pointer to array of offsets for dvrt_v returned from
+ * function
+ * \param v_offset_allocated Pointer to allocated size of v_offset array
+ * \param v_offset_size Pointer to occupied size of v_offset array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArr1stDrvt( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
double const* uv,
int uv_size,
- double** dvtr_u,
+ double** dvrt_u,
int* dvrt_u_allocated,
int* dvrt_u_size,
int** u_offset,
@@ -1762,10 +2036,29 @@
int* v_offset_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getEnt2ndDrvt( iGeom_Instance,
+ /**\brief Get the second derivative of a face at specified parametric
+ * position
+ *
+ * Get the second derivative of a face at specified parametric position.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param u Parametric position being queried
+ * \param v Parametric position being queried
+ * \param dvrt_uu Pointer to coordinates of derivative with respect to u at
+ * specified position returned from function
+ * \param dvrt_uu_allocated Allocated size of dvrt_uu array
+ * \param dvrt_uu_size Occupied size of dvrt_uu array
+ * \param dvrt_vv Pointer to coordinates of derivative with respect to v at
+ * specified position returned from function
+ * \param dvrt_vv_allocated Allocated size of dvrt_vv array
+ * \param dvrt_vv_size Occupied size of dvrt_vv array
+ * \param dvrt_uv Pointer to coordinates of derivative with respect to u and
+ * v at specified position returned from function
+ * \param dvrt_uv_allocated Allocated size of dvrt_uv array
+ * \param dvrt_uv_size Occupied size of dvrt_uv array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEnt2ndDrvt( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double u,
double v,
@@ -1780,10 +2073,44 @@
int* dvrt_uv_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getArr2ndDrvt( iGeom_Instance,
+ /**\brief Get the second derivatives of faces at specified parametric
+ * positions
+ *
+ * Get the second derivatives of faces at specified parametric positions.
+ * storage_order should be a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param storage_order Storage order of coordinates input and output
+ * \param uv Parametric coordinates being queried
+ * \param uv_size Number of coordinates in array
+ * \param dvrt_uu Pointer to array of coordinates of derivative with respect
+ * to u at specified position returned from function
+ * \param dvrt_uu_allocated Allocated size of dvrt_uu array
+ * \param dvrt_uu_size Occupied size of dvrt_uu array
+ * \param uu_offset Pointer to array of offsets for dvrt_uu returned from
+ * function
+ * \param uu_offset_allocated Pointer to allocated size of uu_offset array
+ * \param uu_offset_size Pointer to occupied size of uu_offset array
+ * \param dvrt_vv Pointer to array of coordinates of derivative with respect
+ * to v at specified position returned from function
+ * \param dvrt_vv_allocated Allocated size of dvrt_vv array
+ * \param dvrt_vv_size Occupied size of dvrt_vv array
+ * \param vv_offset Pointer to array of offsets for dvrt_vv returned from
+ * function
+ * \param vv_offset_allocated Pointer to allocated size of vv_offset array
+ * \param vv_offset_size Pointer to occupied size of vv_offset array
+ * \param dvrt_uv Pointer to array of coordinates of derivative with respect
+ * to u and v at specified position returned from function
+ * \param dvrt_uv_allocated Allocated size of dvrt_uv array
+ * \param dvrt_uv_size Occupied size of dvrt_uv array
+ * \param uv_offset Pointer to array of offsets for dvrt_uv returned from
+ * function
+ * \param uv_offset_allocated Pointer to allocated size of uv_offset array
+ * \param uv_offset_size Pointer to occupied size of uv_offset array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArr2ndDrvt( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int storage_order,
@@ -1809,11 +2136,26 @@
int* uv_offset_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getFcCvtrUV( iGeom_Instance,
- iBase_EntityHandle entity_handle,
+ /**\brief Get the two principle curvature vectors for a face at a
+ * parametric position
+ *
+ * Get the two principle curvature vectors for a face at a parametric
+ * position. Magnitudes of vectors are curvature, directions are
+ * directions of principal curvatures.
+ * \param instance iGeom instance handle
+ * \param face_handle Face being queried
+ * \param u Parametric position being queried
+ * \param v Parametric position being queried
+ * \param cvtr1_i Maximum curvature vector
+ * \param cvtr1_j Maximum curvature vector
+ * \param cvtr1_k Maximum curvature vector
+ * \param cvtr2_i Minimum curvature vector
+ * \param cvtr2_j Minimum curvature vector
+ * \param cvtr2_k Minimum curvature vector
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getFcCvtrUV( iGeom_Instance instance,
+ iBase_EntityHandle face_handle,
double u,
double v,
double* cvtr1_i,
@@ -1824,10 +2166,28 @@
double* cvtr2_k,
int* err );
-/**\brief
- *
- */
- void iGeom_getFcArrCvtrUV( iGeom_Instance,
+ /**\brief Get the curvature(s) on face(s) at given parametric position(s)
+ *
+ * Get the curvature(s) on face(s) at given parametric position(s). If
+ * either the number of faces or number of coordinate pairs is unity, then
+ * all points or entities are queried for that entity or point,
+ * respectively, otherwise each point corresponds to each entity.
+ * storage_order should be a value in the iBase_StorageOrder enum.
+ * \param instance iGeom instance handle
+ * \param face_handles Face(s) being queried
+ * \param face_handles_size Number of entities being queried
+ * \param storage_order Storage order of uv coordinates
+ * \param uv Starting parametric coordinates
+ * \param uv_size Number of values in uv array
+ * \param cvtr_1 First principal curvatures
+ * \param cvtr_1_allocated Allocated size of first curvature array
+ * \param cvtr_1_size Occupied size of first curvature array
+ * \param cvtr_2 Second principal curvatures
+ * \param cvtr_2_allocated Allocated size of second curvature array
+ * \param cvtr_2_size Occupied size of second curvature array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getFcArrCvtrUV( iGeom_Instance instance,
iBase_EntityHandle const* face_handles,
int face_handles_size,
int storage_order,
@@ -1841,19 +2201,37 @@
int* cvtr_2_size,
int* err );
-/**\brief
- *
- */
- void iGeom_isEntPeriodic( iGeom_Instance,
+ /**\brief Return whether an entity is periodic
+ *
+ * Return whether an entity is periodic (=1) or not (=0) in the u and v
+ * directions.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity being queried
+ * \param in_u Entity is periodic in u direction (=1) or not (=0)
+ * \param in_v Entity is periodic in v direction (=1) or not (=0)
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isEntPeriodic( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
int* in_u,
int* in_v,
int* err );
-/**\brief
- *
- */
- void iGeom_isArrPeriodic( iGeom_Instance,
+ /**\brief Return whether entities are periodic
+ *
+ * Return whether entities are periodic (=1) or not (=0) in the u and v
+ * directions.
+ * \param instance iGeom instance handle
+ * \param entity_handles Entities being queried
+ * \param entity_handles_size Number of entities being queried
+ * \param in_uv Array of pairs of integers representing whether
+ * entity_handles[i] is periodic (=1) or not (=0) in u and v
+ * directions
+ * \param in_uv_allocated Allocated size of in_uv array
+ * \param in_uv_size Occupied size of in_uv array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isArrPeriodic( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
int** in_uv,
@@ -1861,18 +2239,31 @@
int* in_uv_size,
int* err );
-/**\brief
- *
- */
- void iGeom_isFcDegenerate( iGeom_Instance,
+ /**\brief Return whether a face is degenerate
+ *
+ * Return whether a face is degenerate (=1) or not (=0).
+ * \param instance iGeom instance handle
+ * \param face_handle Face being queried
+ * \param is_degenerate Face is degenerate (=1) or not (=0)
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isFcDegenerate( iGeom_Instance instance,
iBase_EntityHandle face_handle,
int* is_degenerate,
int* err );
-/**\brief
- *
- */
- void iGeom_isFcArrDegenerate( iGeom_Instance,
+ /**\brief Return whether faces are degenerate
+ *
+ * Return whether faces are degenerate (=1) or not (=0).
+ * \param instance iGeom instance handle
+ * \param face_handles Faces being queried
+ * \param face_handles_size Number of faces being queried
+ * \param degenerate face_handles[i] is degenerate (=1) or not (=0)
+ * \param degenerate_allocated Allocated size of degenerate array
+ * \param degenerate_size Occupied size of degenerate array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_isFcArrDegenerate( iGeom_Instance instance,
iBase_EntityHandle const* face_handles,
int face_handles_size,
int** degenerate,
@@ -1880,26 +2271,48 @@
int* degenerate_size,
int* err );
-/**\brief
- *
- */
- void iGeom_getTolerance( iGeom_Instance,
+ /**\brief Get the tolerance of the instance
+ *
+ * Get the tolerance at the modeler level. type is an integer representing
+ * the type of the tolerance, where 0 = no tolerance information,
+ * 1 = modeler-level tolerance, 2 = entity-level tolerances. If type is 1,
+ * tolerance returns the modeler-level tolerance. If type is 2, use
+ * iGeom_getEntTolerance to query the tolerance on a per-entity basis.
+ * \param instance iGeom instance handle
+ * \param type Type of tolerance used by the modeler
+ * \param tolerance Modeler-level tolerance, if any
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getTolerance( iGeom_Instance instance,
int* type,
double* tolerance,
int* err );
-/**\brief
- *
- */
- void iGeom_getEntTolerance( iGeom_Instance,
+ /**\brief Get the tolerance of the specified entity
+ *
+ * Get the tolerance of the specified entity.
+ * \param instance iGeom instance handle
+ * \param entity_handle Entity handle being queried
+ * \param tolerance Pointer to tolerance returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getEntTolerance( iGeom_Instance instance,
iBase_EntityHandle entity_handle,
double* tolerance,
int* err );
-/**\brief
- *
- */
- void iGeom_getArrTolerance( iGeom_Instance,
+ /**\brief Get the tolerances of the specified entities
+ *
+ * Get the tolerances of the specified entities.
+ * \param instance iGeom instance handle
+ * \param entity_handles Array of entity handles being queried
+ * \param entity_handles_size Number of entities in entity_handles array
+ * \param tolerance Pointer to array of tolerances returned from function
+ * \param tolerance_allocated Pointer to allocated size of tolerance array
+ * \param tololerance_size Pointer to occupied size of tolerance array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_getArrTolerance( iGeom_Instance instance,
iBase_EntityHandle const* entity_handles,
int entity_handles_size,
double** tolerances,
@@ -1907,50 +2320,43 @@
int* tolerances_size,
int* err );
- /**\brief Initialize an iterator over specified entity type, topology, and size
+ /**\brief Initialize an iterator over specified entity type
*
- * Initialize an iterator over specified entity type, topology, and size,
- * for a specified set or instance. Iterator returned can be used as input
- * to functions returning the entity for the iterator. If all entities of
- * a specified type and/or topology are to be iterated, specify
- * iBase_ALL_TYPES or iGeom_ALL_TOPOLOGIES, respectively. Specified type
- * or topology must be a value in the iBase_EntityType or
- * iGeom_EntityTopology enumerations, respectively.
+ * Initialize an iterator over specified entity type for a specified set or
+ * instance. Iterator returned can be used as input to functions returning
+ * the entity for the iterator. If all entities of a specified type are to
+ * be iterated, specify iBase_ALL_TYPES. Specified type must be a value in
+ * the iBase_EntityType enumeration.
* \param instance iGeom instance handle
* \param entity_set_handle Entity set being iterated
* \param requested_entity_type Type of entity to iterate
- * \param requested_entity_topology Topology of entity to iterate
* \param entity_iterator Pointer to iterator returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_initEntIter( iGeom_Instance,
+ void iGeom_initEntIter( iGeom_Instance instance,
iBase_EntitySetHandle entity_set_handle,
- int entity_dimension,
+ int requested_entity_type,
iGeom_EntityIterator* entity_iterator,
int* err );
- /**\brief Initialize an array iterator over specified entity type, topology, and
- * size
+ /**\brief Initialize an array iterator over specified entity type and size
*
- * Initialize an array iterator over specified entity type, topology, and
- * size, for a specified set or instance. Iterator returned can be used
- * as input to functions returning entities for the iterator. If all
- * entities of a specified type and/or topology are to be iterated,
- * specify iBase_ALL_TYPES or iGeom_ALL_TOPOLOGIES, respectively.
- * Specified type or topology must be a value in the iBase_EntityType or
- * iGeom_EntityTopology enumerations, respectively.
+ * Initialize an array iterator over specified entity type and size for a
+ * specified set or instance. Iterator returned can be used as input to
+ * functions returning entities for the iterator. If all entities of a
+ * specified type are to be iterated, specify iBase_ALL_TYPES. Specified
+ * type must be a value in the iBase_EntityType enumerations.
* \param instance iGeom instance handle
* \param entity_set_handle Entity set being iterated
* \param requested_entity_type Type of entity to iterate
- * \param requested_entity_topology Topology of entity to iterate
* \param requested_array_size Size of chunks of handles returned for each
* value of the iterator
* \param entArr_iterator Pointer to iterator returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_initEntArrIter( iGeom_Instance,
+ void iGeom_initEntArrIter( iGeom_Instance instance,
iBase_EntitySetHandle entity_set_handle,
- int entity_dimension,
+ int requested_entity_type,
int requested_array_size,
iGeom_EntityArrIterator* entArr_iterator,
int* err );
@@ -1970,8 +2376,8 @@
* is valid. A zero value indicates the value is NOT valid.
* \param *err Pointer to error type returned from function
*/
- void iGeom_getNextEntIter( iGeom_Instance,
- iGeom_EntityIterator,
+ void iGeom_getNextEntIter( iGeom_Instance instance,
+ iGeom_EntityIterator entity_iterator,
iBase_EntityHandle* entity_handle,
int* has_data,
int* err );
@@ -1996,8 +2402,8 @@
* valid.
* \param *err Pointer to error type returned from function
*/
- void iGeom_getNextEntArrIter( iGeom_Instance,
- iGeom_EntityArrIterator,
+ void iGeom_getNextEntArrIter( iGeom_Instance instance,
+ iGeom_EntityArrIterator entArr_iterator,
iBase_EntityHandle** entity_handles,
int* entity_handles_allocated,
int* entity_handles_size,
@@ -2011,8 +2417,8 @@
* \param entity_iterator Iterator to reset
* \param *err Pointer to error type returned from function
*/
- void iGeom_resetEntIter( iGeom_Instance,
- iGeom_EntityIterator,
+ void iGeom_resetEntIter( iGeom_Instance instance,
+ iGeom_EntityIterator entity_iterator,
int* err );
/**\brief Reset the array iterator
@@ -2022,8 +2428,8 @@
* \param entArr_iterator Iterator to reset
* \param *err Pointer to error type returned from function
*/
- void iGeom_resetEntArrIter( iGeom_Instance,
- iGeom_EntityArrIterator,
+ void iGeom_resetEntArrIter( iGeom_Instance instance,
+ iGeom_EntityArrIterator entArr_iterator,
int* err );
/**\brief Destroy the specified iterator
@@ -2033,7 +2439,9 @@
* \param entity_iterator Iterator which gets destroyed
* \param *err Pointer to error type returned from function
*/
- void iGeom_endEntIter( iGeom_Instance, iGeom_EntityIterator, int* err );
+ void iGeom_endEntIter( iGeom_Instance instance,
+ iGeom_EntityIterator entity_iterator,
+ int* err );
/**\brief Destroy the specified array iterator
*
@@ -2042,31 +2450,53 @@
* \param entArr_iterator Iterator which gets destroyed
* \param *err Pointer to error type returned from function
*/
- void iGeom_endEntArrIter( iGeom_Instance, iGeom_EntityArrIterator, int* err );
+ void iGeom_endEntArrIter( iGeom_Instance instance,
+ iGeom_EntityArrIterator entArr_iterator,
+ int* err );
-/**\brief Make a copy of the specified entity
- *
- */
- void iGeom_copyEnt( iGeom_Instance,
+ /**\brief Make a copy of the specified entity
+ *
+ * Make a copy of the specified entity
+ * \param instance iGeom instance handle
+ * \param source entity to be copied
+ * \param copy the newly-created entity
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_copyEnt( iGeom_Instance instance,
iBase_EntityHandle source,
iBase_EntityHandle* copy,
int* err );
-/**\brief
- *
- */
- void iGeom_sweepEntAboutAxis( iGeom_Instance,
+ /**\brief Sweep (extrude) an entity about an axis
+ *
+ * Sweep (extrude) an entity by the given angle about the given axis.
+ *
+ * \param instance iGeom instance handle
+ * \param geom_entity the entity to rotate
+ * \param angle the rotational angle, in degrees
+ * \param axis_x x coordinate of the axis
+ * \param axis_y y coordinate of the axis
+ * \param axis_z z coordinate of the axis
+ * \param geom_entity2 Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_sweepEntAboutAxis( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double angle,
- double axis_normal_x,
- double axis_normal_y,
- double axis_normal_z,
+ double axis_x,
+ double axis_y,
+ double axis_z,
iBase_EntityHandle* geom_entity2,
int* err );
- /**\brief Delete all entities and sets
- */
- void iGeom_deleteAll( iGeom_Instance, int* err );
+ /**\brief Delete all entities and sets
+ *
+ * Delete all entities and sets
+ * \param instance iGeom instance handle
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_deleteAll( iGeom_Instance instance,
+ int* err );
/**\brief Delete specified entity
*
@@ -2075,164 +2505,252 @@
* \param entity_handle Entity to be deleted
* \param *err Pointer to error type returned from function
*/
- void iGeom_deleteEnt( iGeom_Instance,
- iBase_EntityHandle,
+ void iGeom_deleteEnt( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
int* err );
- /**\brief Create a sphere centered on the origin
+ /**\brief Create a sphere
+ *
+ * Create a sphere of the specified radius centered on the origin.
+ * \param instance iGeom instance handle
+ * \param radius radius of the sphere
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
*/
- void iGeom_createSphere( iGeom_Instance,
+ void iGeom_createSphere( iGeom_Instance instance,
double radius,
- iBase_EntityHandle* sphere_handle_out,
+ iBase_EntityHandle* geom_entity,
int* err );
-/**\brief Create a prism centered on the origin
- */
-void iGeom_createPrism( iGeom_Instance,
- double height,
- int n_sides,
- double major_rad,
- double minor_rad,
- iBase_EntityHandle* prism_handle_out,
- int* err );
+ /**\brief Create a prism
+ *
+ * Create a prism parallel to the z-axis and centered at the origin (so
+ * that its z-coordinate extents are +height/2 and -height/2).
+ * \param instance iGeom instance handle
+ * \param height height of new prism
+ * \param n_sides number of sides of new prism
+ * \param major_rad major radius of new prism
+ * \param minor_rad minor radius of new prism
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_createPrism( iGeom_Instance instance,
+ double height,
+ int n_sides,
+ double major_rad,
+ double minor_rad,
+ iBase_EntityHandle* geom_entity,
+ int* err );
-/**\brief Create an axis-oriented box
- *
- * Create an axis-oriented box of the given dimensions, centered at the origin
- */
- void iGeom_createBrick( iGeom_Instance,
+ /**\brief Create an axis-oriented box
+ *
+ * Create an axis-oriented box of the given dimensions, centered at the
+ * origin.
+ * \param instance iGeom instance handle
+ * \param x x dimension of new box
+ * \param y y dimension of new box
+ * \param z z dimension of new box
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_createBrick( iGeom_Instance instance,
double x,
double y,
double z,
iBase_EntityHandle* geom_entity,
int* err );
-/**\brief Create a cylinder
- *
- * Create a cylinder parallel to the z-axis and centered at the origin
- * (so that its z-coordinate extents are +height/2 and -height/2).
- * \param height The height of the cylinder.
- * \param major_rad The x-axis radius
- * \param minor_rad The y-axis radius. If minor_rad is 0, the cylinder will
- * be circular (as if minor_rad == major_rad).
- */
- void iGeom_createCylinder( iGeom_Instance,
+ /**\brief Create a cylinder
+ *
+ * Create a cylinder parallel to the z-axis and centered at the origin (so
+ * that its z-coordinate extents are +height/2 and -height/2).
+ * \param instance iGeom instance handle
+ * \param height The height of the cylinder.
+ * \param major_rad The x-axis radius
+ * \param minor_rad The y-axis radius. If minor_rad is 0, the cylinder will
+ * be circular (as if minor_rad == major_rad).
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_createCylinder( iGeom_Instance instance,
double height,
double major_rad,
double minor_rad,
iBase_EntityHandle* geom_entity,
int* err );
-/**\brief Create a cone or tapered cylinder
- *
- * Create a cone parallel to the z-axis and centered at the origin
- * (so that its z-coordinate extents are +height/2 and -height/2).
- * The 'base' of the cylinder is at z = -height/2, and the top is at +height/2.
- *
- * \param height The height of the cone.
- * \param major_rad_base The x-axis radius at the base of the cylinder
- * \param minor_rad_base The y-axis radius at the base. If minor_rad_base is 0,
- * the cylinder will be circular (as if
- * minor_rad_base == major_rad_base)
- * \param rad_top The x-axis radius at the top of the cone. The y-axis radius
- * at the top of the cone will be inferred to keep the aspect
- * ratio of the top of the cone the same as the bottom.
- * If rad_top is 0, the cone terminates at a point.
- */
- void iGeom_createCone( iGeom_Instance,
- double height,
- double major_rad_base,
- double minor_rad_base,
- double rad_top,
- iBase_EntityHandle* geom_entity,
- int* err );
+ /**\brief Create a cone or tapered cylinder
+ *
+ * Create a cone parallel to the z-axis and centered at the origin (so that
+ * its z-coordinate extents are +height/2 and -height/2). The 'base' of the
+ * cylinder is at z = -height/2, and the top is at +height/2.
+ * \param instance iGeom instance handle
+ * \param height The height of the cone.
+ * \param major_rad_base The x-axis radius at the base of the cylinder
+ * \param minor_rad_base The y-axis radius at the base. If minor_rad_base
+ * is 0, the cylinder will be circular (as if minor_rad_base ==
+ * major_rad_base)
+ * \param rad_top The x-axis radius at the top of the cone. The y-axis
+ * radius at the top of the cone will be inferred to keep the aspect
+ * ratio of the top of the cone the same as the bottom. If rad_top is
+ * 0, the cone terminates at a point.
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_createCone( iGeom_Instance instance,
+ double height,
+ double major_rad_base,
+ double minor_rad_base,
+ double rad_top,
+ iBase_EntityHandle* geom_entity,
+ int* err );
-/**\brief Create a torus
- *
- * Create a torus centered on the origin and encircling the z-axis.
- *
- * \param major_rad The distance from the origin to the center of the
- * torus's circular cross-section.
- * \param minor_rad The radius of the cross-section.
- */
- void iGeom_createTorus( iGeom_Instance,
+ /**\brief Create a torus
+ *
+ * Create a torus centered on the origin and encircling the z-axis.
+ * \param instance iGeom instance handle
+ * \param major_rad The distance from the origin to the center of the
+ * torus's circular cross-section.
+ * \param minor_rad The radius of the cross-section.
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_createTorus( iGeom_Instance instance,
double major_rad,
double minor_rad,
iBase_EntityHandle* geom_entity,
int* err );
-/**\brief Move an entity by the given vector
- *
- */
- void iGeom_moveEnt( iGeom_Instance,
+ /**\brief Move an entity by the given vector
+ *
+ * Move an entity by translating it along the given vector.
+ * \param instance iGeom instance handle
+ * \param geom_entity the entity to move
+ * \param x x coordinate of the vector
+ * \param y y coordinate of the vector
+ * \param z z coordinate of the vector
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_moveEnt( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double x,
double y,
double z,
int* err );
-/**\brief Rotate an entity about a given axis
- *
- * \param angle The rotational angle, in degrees.
- */
- void iGeom_rotateEnt( iGeom_Instance,
+ /**\brief Rotate an entity about an axis
+ *
+ * Rotate an entity by the given angle about the given axis.
+ * \param instance iGeom instance handle
+ * \param geom_entity the entity to rotate
+ * \param angle the rotational angle, in degrees
+ * \param axis_x x coordinate of the axis
+ * \param axis_y y coordinate of the axis
+ * \param axis_z z coordinate of the axis
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_rotateEnt( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double angle,
- double axis_normal_x,
- double axis_normal_y,
- double axis_normal_z,
+ double axis_x,
+ double axis_y,
+ double axis_z,
int* err );
-/**\brief
- *
- */
- void iGeom_reflectEnt( iGeom_Instance,
+ /**\brief Reflect an entity across a plane
+ *
+ * Reflect an entity across the given plane
+ * \param instance iGeom instance handle
+ * \param geom_entity the entity to reflect
+ * \param plane_normal_x x coordinate of the plane's normal
+ * \param plane_normal_y y coordinate of the plane's normal
+ * \param plane_normal_z z coordinate of the plane's normal
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_reflectEnt( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double plane_normal_x,
double plane_normal_y,
double plane_normal_z,
int* err );
-/**\brief
- *
- */
- void iGeom_scaleEnt( iGeom_Instance,
+ /**\brief Scale an entity in the x, y, and z directions
+ *
+ * Scale an entity in the x, y, and z directions.
+ * \param instance iGeom instance handle
+ * \param geom_entity the entity to scale
+ * \param scale_x factor to scale by in the x direction
+ * \param scale_y factor to scale by in the y direction
+ * \param scale_z factor to scale by in the z direction
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_scaleEnt( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double scale_x,
double scale_y,
double scale_z,
int* err );
-/**\brief
- *
- */
- void iGeom_uniteEnts( iGeom_Instance,
+ /**\brief Geometrically unite entities
+ *
+ * Geometrically unite the specified entities.
+ * \param instance iGeom instance handle
+ * \param geom_entities Array of entity handles being united
+ * \param geom_entities_size Number of entities in geom_entities array
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_uniteEnts( iGeom_Instance instace,
iBase_EntityHandle const* geom_entities,
int geom_entities_size,
iBase_EntityHandle* geom_entity,
int* err );
-/**\brief
- *
- */
- void iGeom_subtractEnts( iGeom_Instance,
+ /**\brief Geometrically subtract one entity from another
+ *
+ * Geometrically subtract the entity tool from the entity blank.
+ * \param instance iGeom instance handle
+ * \param blank The entity to subtract from
+ * \param tool The entity to subtract
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_subtractEnts( iGeom_Instance instance,
iBase_EntityHandle blank,
iBase_EntityHandle tool,
iBase_EntityHandle* geom_entity,
int* err );
-/**\brief
- */
- void iGeom_intersectEnts( iGeom_Instance,
+ /**\brief Geometrically intersect a pair of entities
+ *
+ * Geometrically intersect a pair of entities.
+ * \param instance iGeom instance handle
+ * \param entity1 The entity to intersect
+ * \param entity2 The entity to intersect
+ * \param geom_entity Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_intersectEnts( iGeom_Instance instance,
iBase_EntityHandle entity2,
- iBase_EntityHandle entity1,
- iBase_EntityHandle* geom_entity,
- int* err );
+ iBase_EntityHandle entity1,
+ iBase_EntityHandle* geom_entity,
+ int* err );
-/**\brief
- *
- */
- void iGeom_sectionEnt( iGeom_Instance,
+ /**\brief Section (cut) a region with a plane
+ *
+ * Section (cut) a region with a plane, retaining one of the pieces and
+ * discarding the other.
+ * \param instance iGeom instance handle
+ * \param geom_entity The entity to section
+ * \param plane_normal_x x coordinate of the plane's normal
+ * \param plane_normal_y y coordinate of the plane's normal
+ * \param plane_normal_z z coordinate of the plane's normal
+ * \param offset Distance of the plane from the origin
+ * \param reverse Keep the piece on the normal's side (=0) or not (=1)
+ * \param geom_entity2 Pointer to new entity handle returned from function
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_sectionEnt( iGeom_Instance instance,
iBase_EntityHandle geom_entity,
double plane_normal_x,
double plane_normal_y,
@@ -2242,24 +2760,35 @@
iBase_EntityHandle* geom_entity2,
int* err );
-/**\brief
- *
- */
- void iGeom_imprintEnts( iGeom_Instance,
+ /**\brief Imprint entities
+ *
+ * Imprint entities by merging coincident surfaces.
+ * \param instance iGeom instance handle
+ * \param geom_entities Array of entity handles being imprinted
+ * \param geom_entities_size Number of entities in geom_entities array
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_imprintEnts( iGeom_Instance instance,
iBase_EntityHandle const* geom_entities,
int geom_entities_size,
int* err );
-/**\brief
- *
- */
- void iGeom_mergeEnts( iGeom_Instance,
+ /**\brief Merge ents
+ *
+ * Merge entities of corresponding topology/geometry within the specified
+ * tolerance.
+ * \param instance iGeom instance handle
+ * \param geom_entities Array of entity handles being imprinted
+ * \param geom_entities_size Number of entities in geom_entities array
+ * \param tolerance Tolerance within which entities are considered the same
+ * \param *err Pointer to error type returned from function
+ */
+ void iGeom_mergeEnts( iGeom_Instance instance,
iBase_EntityHandle const* geom_entities,
int geom_entities_size,
double tolerance,
int* err );
-
/**\brief Create an entity set
*
* Create an entity set, either ordered (isList=1) or unordered
@@ -2271,12 +2800,11 @@
* \param entity_set_created Entity set created by function
* \param *err Pointer to error type returned from function
*/
- void iGeom_createEntSet(iGeom_Instance instance,
- int isList,
- iBase_EntitySetHandle* entity_set_created,
- int *err);
+ void iGeom_createEntSet( iGeom_Instance instance,
+ int isList,
+ iBase_EntitySetHandle* entity_set_created,
+ int *err );
-
/**\brief Destroy an entity set
*
* Destroy an entity set
@@ -2284,9 +2812,9 @@
* \param entity_set Entity set to be destroyed
* \param *err Pointer to error type returned from function
*/
- void iGeom_destroyEntSet(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- int *err);
+ void iGeom_destroyEntSet( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ int *err );
/**\brief Return whether a specified set is ordered or unordered
*
@@ -2297,10 +2825,10 @@
* \param is_list Pointer to flag returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_isList(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- int *is_list,
- int *err);
+ void iGeom_isList( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ int *is_list,
+ int *err );
/**\brief Get the number of entity sets contained in a set or interface
*
@@ -2315,13 +2843,12 @@
* \param num_sets Pointer to the number of sets returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getNumEntSets(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- int num_hops,
- int *num_sets,
- int *err);
+ void iGeom_getNumEntSets( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ int num_hops,
+ int *num_sets,
+ int *err );
-
/**\brief Get the entity sets contained in a set or interface
*
* Get the entity sets contained in a set or interface. If
@@ -2340,13 +2867,13 @@
* contained_set_handles array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEntSets(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- int num_hops,
- iBase_EntitySetHandle** contained_set_handles,
- int* contained_set_handles_allocated,
- int* contained_set_handles_size,
- int *err);
+ void iGeom_getEntSets( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ int num_hops,
+ iBase_EntitySetHandle** contained_set_handles,
+ int* contained_set_handles_allocated,
+ int* contained_set_handles_size,
+ int *err );
/**\brief Add an entity to a set
*
@@ -2356,10 +2883,10 @@
* \param entity_set Pointer to the set being added to
* \param *err Pointer to error type returned from function
*/
- void iGeom_addEntToSet(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_EntitySetHandle entity_set,
- int *err);
+ void iGeom_addEntToSet( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_EntitySetHandle entity_set,
+ int *err );
/**\brief Remove an entity from a set
*
@@ -2370,12 +2897,11 @@
* \param entity_set Pointer to the set being removed from
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvEntFromSet(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_EntitySetHandle entity_set,
- int *err);
+ void iGeom_rmvEntFromSet( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_EntitySetHandle entity_set,
+ int *err );
-
/**\brief Add an array of entities to a set
*
* Add an array of entities to a set
@@ -2385,13 +2911,12 @@
* \param entity_set Pointer to the set being added to
* \param *err Pointer to error type returned from function
*/
- void iGeom_addEntArrToSet(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_EntitySetHandle entity_set,
- int *err);
+ void iGeom_addEntArrToSet( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_EntitySetHandle entity_set,
+ int *err );
-
/**\brief Remove an array of entities from a set
*
* Remove an array of entities from a set
@@ -2401,13 +2926,12 @@
* \param entity_set Pointer to the set being removed from
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvEntArrFromSet(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_EntitySetHandle entity_set,
- int *err);
+ void iGeom_rmvEntArrFromSet( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_EntitySetHandle entity_set,
+ int *err );
-
/**\brief Add an entity set to a set
*
* Add an entity set to a set
@@ -2416,12 +2940,11 @@
* \param entity_set_handle Pointer to the set being added to
* \param *err Pointer to error type returned from function
*/
- void iGeom_addEntSet(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_to_add,
- iBase_EntitySetHandle entity_set_handle,
- int *err);
+ void iGeom_addEntSet( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_to_add,
+ iBase_EntitySetHandle entity_set_handle,
+ int *err);
-
/**\brief Remove an entity set from a set
*
* Remove an entity set from a set
@@ -2430,10 +2953,10 @@
* \param entity_set_handle Pointer to the set being removed from
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvEntSet(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_to_remove,
- iBase_EntitySetHandle entity_set_handle,
- int *err);
+ void iGeom_rmvEntSet( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_to_remove,
+ iBase_EntitySetHandle entity_set_handle,
+ int *err );
/**\brief Return whether an entity is contained in another set
*
@@ -2446,11 +2969,11 @@
* \param is_contained Pointer to flag returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_isEntContained(iGeom_Instance instance,
- iBase_EntitySetHandle containing_entity_set,
- iBase_EntityHandle contained_entity,
- int *is_contained,
- int *err);
+ void iGeom_isEntContained( iGeom_Instance instance,
+ iBase_EntitySetHandle containing_entity_set,
+ iBase_EntityHandle contained_entity,
+ int *is_contained,
+ int *err );
/**\brief Return whether entities are contained in a set
*
@@ -2463,13 +2986,13 @@
* \param *err Pointer to error type returned from function
*/
void iGeom_isEntArrContained( iGeom_Instance instance,
- /*in*/ iBase_EntitySetHandle containing_set,
- /*in*/ const iBase_EntityHandle* entity_handles,
- /*in*/ int num_entity_handles,
- /*inout*/ int** is_contained,
- /*inout*/ int* is_contained_allocated,
- /*out*/ int* is_contained_size,
- /*out*/ int* err );
+ /*in*/ iBase_EntitySetHandle containing_set,
+ /*in*/ const iBase_EntityHandle* entity_handles,
+ /*in*/ int num_entity_handles,
+ /*inout*/ int** is_contained,
+ /*inout*/ int* is_contained_allocated,
+ /*out*/ int* is_contained_size,
+ /*out*/ int* err );
/**\brief Return whether an entity set is contained in another set
*
@@ -2482,11 +3005,11 @@
* \param is_contained Pointer to flag returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_isEntSetContained(iGeom_Instance instance,
- iBase_EntitySetHandle containing_entity_set,
- iBase_EntitySetHandle contained_entity_set,
- int *is_contained,
- int *err);
+ void iGeom_isEntSetContained( iGeom_Instance instance,
+ iBase_EntitySetHandle containing_entity_set,
+ iBase_EntitySetHandle contained_entity_set,
+ int *is_contained,
+ int *err );
/**\brief Add parent/child links between two sets
*
@@ -2497,10 +3020,10 @@
* \param child_entity_set Pointer to child set
* \param *err Pointer to error type returned from function
*/
- void iGeom_addPrntChld(iGeom_Instance instance,
- iBase_EntitySetHandle parent_entity_set,
- iBase_EntitySetHandle child_entity_set,
- int *err);
+ void iGeom_addPrntChld( iGeom_Instance instance,
+ iBase_EntitySetHandle parent_entity_set,
+ iBase_EntitySetHandle child_entity_set,
+ int *err );
/**\brief Remove parent/child links between two sets
*
@@ -2510,10 +3033,10 @@
* \param child_entity_set Pointer to child set
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvPrntChld(iGeom_Instance instance,
- iBase_EntitySetHandle parent_entity_set,
- iBase_EntitySetHandle child_entity_set,
- int *err);
+ void iGeom_rmvPrntChld( iGeom_Instance instance,
+ iBase_EntitySetHandle parent_entity_set,
+ iBase_EntitySetHandle child_entity_set,
+ int *err );
/**\brief Return whether two sets are related by parent/child links
*
@@ -2525,11 +3048,11 @@
* \param is_child Pointer to flag returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_isChildOf(iGeom_Instance instance,
- iBase_EntitySetHandle parent_entity_set,
- iBase_EntitySetHandle child_entity_set,
- int *is_child,
- int *err);
+ void iGeom_isChildOf( iGeom_Instance instance,
+ iBase_EntitySetHandle parent_entity_set,
+ iBase_EntitySetHandle child_entity_set,
+ int *is_child,
+ int *err );
/**\brief Get the number of child sets linked from a specified set
*
@@ -2543,11 +3066,11 @@
* \param num_child Pointer to number of children returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getNumChld(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- int num_hops,
- int *num_child,
- int *err);
+ void iGeom_getNumChld( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ int num_hops,
+ int *num_child,
+ int *err );
/**\brief Get the number of parent sets linked from a specified set
*
@@ -2561,11 +3084,11 @@
* \param num_parent Pointer to number of parents returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getNumPrnt(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- int num_hops,
- int *num_parent,
- int *err);
+ void iGeom_getNumPrnt( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ int num_hops,
+ int *num_parent,
+ int *err );
/**\brief Get the child sets linked from a specified set
*
@@ -2584,13 +3107,13 @@
* entity_set_handles array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getChldn(iGeom_Instance instance,
- iBase_EntitySetHandle from_entity_set,
- int num_hops,
- iBase_EntitySetHandle** entity_set_handles,
- int* entity_set_handles_allocated,
- int* entity_set_handles_size,
- int *err);
+ void iGeom_getChldn( iGeom_Instance instance,
+ iBase_EntitySetHandle from_entity_set,
+ int num_hops,
+ iBase_EntitySetHandle** entity_set_handles,
+ int* entity_set_handles_allocated,
+ int* entity_set_handles_size,
+ int *err );
/**\brief Get the parent sets linked from a specified set
*
@@ -2609,13 +3132,13 @@
* entity_set_handles array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getPrnts(iGeom_Instance instance,
- iBase_EntitySetHandle from_entity_set,
- int num_hops,
- iBase_EntitySetHandle** entity_set_handles,
- int* entity_set_handles_allocated,
- int* entity_set_handles_size,
- int *err);
+ void iGeom_getPrnts( iGeom_Instance instance,
+ iBase_EntitySetHandle from_entity_set,
+ int num_hops,
+ iBase_EntitySetHandle** entity_set_handles,
+ int* entity_set_handles_allocated,
+ int* entity_set_handles_size,
+ int *err );
/**\brief Create a tag with specified name, size, and type
*
@@ -2631,13 +3154,13 @@
* \param *err Pointer to error type returned from function
* \param tag_name_len Length of tag name string
*/
- void iGeom_createTag(iGeom_Instance instance,
- const char* tag_name,
- int tag_size,
- int tag_type,
- iBase_TagHandle* tag_handle,
- int *err,
- int tag_name_len );
+ void iGeom_createTag( iGeom_Instance instance,
+ const char* tag_name,
+ int tag_size,
+ int tag_type,
+ iBase_TagHandle* tag_handle,
+ int *err,
+ int tag_name_len );
/**\brief Destroy a tag
@@ -2651,10 +3174,10 @@
* set for that tag
* \param *err Pointer to error type returned from function
*/
- void iGeom_destroyTag(iGeom_Instance instance,
- iBase_TagHandle tag_handle,
- int forced,
- int *err);
+ void iGeom_destroyTag( iGeom_Instance instance,
+ iBase_TagHandle tag_handle,
+ int forced,
+ int *err);
/**\brief Get the name for a given tag handle
*
@@ -2666,11 +3189,11 @@
* \param *err Pointer to error type returned from function
* \param name_len Length of character string input to function
*/
- void iGeom_getTagName(iGeom_Instance instance,
- iBase_TagHandle tag_handle,
- char *name,
- int* err,
- int name_len);
+ void iGeom_getTagName( iGeom_Instance instance,
+ iBase_TagHandle tag_handle,
+ char *name,
+ int* err,
+ int name_len );
/**\brief Get size of a tag in units of numbers of tag data type
*
@@ -2680,10 +3203,10 @@
* \param tag_size Pointer to tag size returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getTagSizeValues(iGeom_Instance instance,
- iBase_TagHandle tag_handle,
- int *tag_size,
- int *err);
+ void iGeom_getTagSizeValues( iGeom_Instance instance,
+ iBase_TagHandle tag_handle,
+ int *tag_size,
+ int *err );
/**\brief Get size of a tag in units of bytes
*
@@ -2693,10 +3216,10 @@
* \param tag_size Pointer to tag size returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getTagSizeBytes(iGeom_Instance instance,
- iBase_TagHandle tag_handle,
- int *tag_size,
- int *err);
+ void iGeom_getTagSizeBytes( iGeom_Instance instance,
+ iBase_TagHandle tag_handle,
+ int *tag_size,
+ int *err );
/**\brief Get a the handle of an existing tag with the specified name
*
@@ -2707,11 +3230,11 @@
* \param *err Pointer to error type returned from function
* \param tag_name_len Length of tag name string
*/
- void iGeom_getTagHandle(iGeom_Instance instance,
- const char* tag_name,
- iBase_TagHandle *tag_handle,
- int *err,
- int tag_name_len);
+ void iGeom_getTagHandle( iGeom_Instance instance,
+ const char* tag_name,
+ iBase_TagHandle *tag_handle,
+ int *err,
+ int tag_name_len );
/**\brief Get the data type of the specified tag handle
*
@@ -2722,12 +3245,11 @@
* \param tag_type Pointer to tag type returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getTagType(iGeom_Instance instance,
- iBase_TagHandle tag_handle,
- int *tag_type,
- int *err);
+ void iGeom_getTagType( iGeom_Instance instance,
+ iBase_TagHandle tag_handle,
+ int *tag_type,
+ int *err );
-
/**\brief Set a tag value of arbitrary type on an entity set
*
* Set a tag value of arbitrary type on an entity set. Tag data is
@@ -2740,14 +3262,13 @@
* \param tag_value_size Size in bytes of tag data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEntSetData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- iBase_TagHandle tag_handle,
- const char* tag_value,
- int tag_value_size,
- int *err);
+ void iGeom_setEntSetData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ iBase_TagHandle tag_handle,
+ const char* tag_value,
+ int tag_value_size,
+ int *err );
-
/**\brief Set a tag value of integer type on an entity set
*
* Set a tag value of integer type on an entity set.
@@ -2757,13 +3278,12 @@
* \param tag_value Tag value being set on entity set
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEntSetIntData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- int tag_value,
- int *err);
+ void iGeom_setEntSetIntData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ int tag_value,
+ int *err );
-
/**\brief Set a tag value of double type on an entity set
*
* Set a tag value of double type on an entity set.
@@ -2773,13 +3293,12 @@
* \param tag_value Tag value being set on entity set
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEntSetDblData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- double tag_value,
- int *err);
+ void iGeom_setEntSetDblData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ double tag_value,
+ int *err );
-
/**\brief Set a tag value of entity handle type on an entity set
*
* Set a tag value of entity handle type on an entity set.
@@ -2789,13 +3308,12 @@
* \param tag_value Tag value being set on entity set
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEntSetEHData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- iBase_EntityHandle tag_value,
- int *err);
+ void iGeom_setEntSetEHData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ iBase_EntityHandle tag_value,
+ int *err );
-
/**\brief Get the value of a tag of arbitrary type on an entity set
*
* Get the value of a tag of arbitrary type on an entity set. Tag data
@@ -2808,13 +3326,13 @@
* \param *tag_value_size Pointer to tag data array occupied size
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEntSetData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- iBase_TagHandle tag_handle,
- char** tag_value,
- int* tag_value_allocated,
- int* tag_value_size,
- int *err);
+ void iGeom_getEntSetData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ iBase_TagHandle tag_handle,
+ char** tag_value,
+ int* tag_value_allocated,
+ int* tag_value_size,
+ int *err );
/**\brief Get the value of a tag of integer type on an entity set
*
@@ -2825,11 +3343,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEntSetIntData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- int *out_data,
- int *err);
+ void iGeom_getEntSetIntData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ int *out_data,
+ int *err );
/**\brief Get the value of a tag of double type on an entity set
*
@@ -2840,11 +3358,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEntSetDblData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- double *out_data,
- int *err);
+ void iGeom_getEntSetDblData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ double *out_data,
+ int *err );
/**\brief Get the value of a tag of entity handle type on an entity set
*
@@ -2855,11 +3373,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEntSetEHData(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set,
- iBase_TagHandle tag_handle,
- iBase_EntityHandle *out_data,
- int *err);
+ void iGeom_getEntSetEHData( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set,
+ iBase_TagHandle tag_handle,
+ iBase_EntityHandle *out_data,
+ int *err );
/**\brief Get all the tags associated with a specified entity set
*
@@ -2873,12 +3391,12 @@
* \param *tag_handles_size Pointer to occupied size of tag_handles array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getAllEntSetTags(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- iBase_TagHandle** tag_handles,
- int* tag_handles_allocated,
- int* tag_handles_size,
- int *err);
+ void iGeom_getAllEntSetTags( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ iBase_TagHandle** tag_handles,
+ int* tag_handles_allocated,
+ int* tag_handles_size,
+ int *err );
/**\brief Remove a tag value from an entity set
*
@@ -2888,12 +3406,11 @@
* \param tag_handle Tag handle of tag being removed
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvEntSetTag(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_handle,
- iBase_TagHandle tag_handle,
- int *err);
+ void iGeom_rmvEntSetTag( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_handle,
+ iBase_TagHandle tag_handle,
+ int *err );
-
/**\brief Get tag values of arbitrary type for an array of entities
*
* Get tag values of arbitrary type for an array of entities. Tag data
@@ -2908,14 +3425,14 @@
* \param tag_values_size Pointer to occupied size of tag data array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- char** tag_values,
- int* tag_values_allocated,
- int* tag_values_size,
- int *err);
+ void iGeom_getArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ char** tag_values,
+ int* tag_values_allocated,
+ int* tag_values_size,
+ int *err );
/**\brief Get tag values of integer type for an array of entities
*
@@ -2930,14 +3447,14 @@
* \param tag_values_size Pointer to occupied size of tag data array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getIntArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- int** tag_values,
- int* tag_values_allocated,
- int* tag_values_size,
- int *err);
+ void iGeom_getIntArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ int** tag_values,
+ int* tag_values_allocated,
+ int* tag_values_size,
+ int *err );
/**\brief Get tag values of double type for an array of entities
*
@@ -2952,14 +3469,14 @@
* \param tag_values_size Pointer to occupied size of tag data array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getDblArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- double** tag_values,
- int* tag_values_allocated,
- int* tag_values_size,
- int *err);
+ void iGeom_getDblArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ double** tag_values,
+ int* tag_values_allocated,
+ int* tag_values_size,
+ int *err );
/**\brief Get tag values of entity handle type for an array of entities
*
@@ -2974,14 +3491,14 @@
* \param tag_value_size Pointer to occupied size of tag data array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEHArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- iBase_EntityHandle** tag_value,
- int* tag_value_allocated,
- int* tag_value_size,
- int *err);
+ void iGeom_getEHArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ iBase_EntityHandle** tag_value,
+ int* tag_value_allocated,
+ int* tag_value_size,
+ int *err );
/**\brief Set tag values of arbitrary type on an array of entities
*
@@ -2995,13 +3512,13 @@
* \param tag_values_size Size in total bytes of tag data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- const char* tag_values,
- int tag_values_size,
- int *err);
+ void iGeom_setArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ const char* tag_values,
+ int tag_values_size,
+ int *err );
/**\brief Set tag values of integer type on an array of entities
*
@@ -3014,13 +3531,13 @@
* \param tag_values_size Size in total number of integers of tag data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setIntArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- const int* tag_values,
- int tag_values_size,
- int *err);
+ void iGeom_setIntArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ const int* tag_values,
+ int tag_values_size,
+ int *err );
/**\brief Set tag values of double type on an array of entities
*
@@ -3033,13 +3550,13 @@
* \param tag_values_size Size in total number of doubles of tag data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setDblArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- const double* tag_values,
- const int tag_values_size,
- int *err);
+ void iGeom_setDblArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ const double* tag_values,
+ const int tag_values_size,
+ int *err );
/**\brief Set tag values of entity handle type on an array of entities
*
@@ -3053,13 +3570,13 @@
* data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEHArrData(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- const iBase_EntityHandle* tag_values,
- int tag_values_size,
- int *err);
+ void iGeom_setEHArrData( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ const iBase_EntityHandle* tag_values,
+ int tag_values_size,
+ int *err );
/**\brief Remove a tag value from an array of entities
*
@@ -3070,11 +3587,11 @@
* \param tag_handle Tag handle of tag being removed
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvArrTag(iGeom_Instance instance,
- const iBase_EntityHandle* entity_handles,
- int entity_handles_size,
- iBase_TagHandle tag_handle,
- int *err);
+ void iGeom_rmvArrTag( iGeom_Instance instance,
+ const iBase_EntityHandle* entity_handles,
+ int entity_handles_size,
+ iBase_TagHandle tag_handle,
+ int *err );
/**\brief Get the value of a tag of arbitrary type on an entity
*
@@ -3088,13 +3605,13 @@
* \param *tag_value_size Pointer to tag data array occupied size
* \param *err Pointer to error type returned from function
*/
- void iGeom_getData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- char** tag_value,
- int *tag_value_allocated,
- int *tag_value_size,
- int *err);
+ void iGeom_getData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ char** tag_value,
+ int *tag_value_allocated,
+ int *tag_value_size,
+ int *err );
/**\brief Get the value of a tag of integer type on an entity
*
@@ -3105,11 +3622,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getIntData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- int *out_data,
- int *err);
+ void iGeom_getIntData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ int *out_data,
+ int *err );
/**\brief Get the value of a tag of double type on an entity
*
@@ -3120,10 +3637,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getDblData(iGeom_Instance instance,
- /*in*/ const iBase_EntityHandle entity_handle,
- /*in*/ const iBase_TagHandle tag_handle,
- double *out_data, int *err);
+ void iGeom_getDblData( iGeom_Instance instance,
+ /*in*/ const iBase_EntityHandle entity_handle,
+ /*in*/ const iBase_TagHandle tag_handle,
+ double *out_data,
+ int *err );
/**\brief Get the value of a tag of entity handle type on an entity
*
@@ -3134,11 +3652,11 @@
* \param *out_data Pointer to tag value returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_getEHData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- iBase_EntityHandle *out_data,
- int *err);
+ void iGeom_getEHData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ iBase_EntityHandle *out_data,
+ int *err );
/**\brief Set a tag value of arbitrary type on an entity
*
@@ -3151,12 +3669,12 @@
* \param tag_value_size Size in bytes of tag data
* \param *err Pointer to error type returned from function
*/
- void iGeom_setData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- const char* tag_value,
- int tag_value_size,
- int *err);
+ void iGeom_setData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ const char* tag_value,
+ int tag_value_size,
+ int *err );
/**\brief Set a tag value of integer type on an entity
*
@@ -3167,11 +3685,11 @@
* \param tag_value Tag value being set on entity
* \param *err Pointer to error type returned from function
*/
- void iGeom_setIntData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- int tag_value,
- int *err);
+ void iGeom_setIntData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ int tag_value,
+ int *err );
/**\brief Set a tag value of double type on an entity
*
@@ -3182,11 +3700,11 @@
* \param tag_value Tag value being set on entity
* \param *err Pointer to error type returned from function
*/
- void iGeom_setDblData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- double tag_value,
- int *err);
+ void iGeom_setDblData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ double tag_value,
+ int *err );
/**\brief Set a tag value of entity handle type on an entity
*
@@ -3197,11 +3715,11 @@
* \param tag_value Tag value being set on entity
* \param *err Pointer to error type returned from function
*/
- void iGeom_setEHData(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- iBase_EntityHandle tag_value,
- int *err);
+ void iGeom_setEHData( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ iBase_EntityHandle tag_value,
+ int *err );
/**\brief Get all the tags associated with a specified entity handle
*
@@ -3215,12 +3733,12 @@
* \param *tag_handles_size Pointer to occupied size of tag_handles array
* \param *err Pointer to error type returned from function
*/
- void iGeom_getAllTags(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle** tag_handles,
- int* tag_handles_allocated,
- int* tag_handles_size,
- int *err);
+ void iGeom_getAllTags( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle** tag_handles,
+ int* tag_handles_allocated,
+ int* tag_handles_size,
+ int *err );
/**\brief Remove a tag value from an entity
*
@@ -3230,10 +3748,10 @@
* \param tag_handle Tag handle of tag being removed
* \param *err Pointer to error type returned from function
*/
- void iGeom_rmvTag(iGeom_Instance instance,
- iBase_EntityHandle entity_handle,
- iBase_TagHandle tag_handle,
- int *err);
+ void iGeom_rmvTag( iGeom_Instance instance,
+ iBase_EntityHandle entity_handle,
+ iBase_TagHandle tag_handle,
+ int *err );
/**\brief Subtract contents of one entity set from another
*
@@ -3244,11 +3762,11 @@
* \param result_entity_set Pointer to entity set returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_subtract(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_1,
- iBase_EntitySetHandle entity_set_2,
- iBase_EntitySetHandle* result_entity_set,
- int *err);
+ void iGeom_subtract( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_1,
+ iBase_EntitySetHandle entity_set_2,
+ iBase_EntitySetHandle* result_entity_set,
+ int *err );
/**\brief Intersect contents of one entity set with another
*
@@ -3259,11 +3777,11 @@
* \param result_entity_set Pointer to entity set returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_intersect(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_1,
- iBase_EntitySetHandle entity_set_2,
- iBase_EntitySetHandle* result_entity_set,
- int *err);
+ void iGeom_intersect( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_1,
+ iBase_EntitySetHandle entity_set_2,
+ iBase_EntitySetHandle* result_entity_set,
+ int *err );
/**\brief Unite contents of one entity set with another
*
@@ -3274,11 +3792,11 @@
* \param result_entity_set Pointer to entity set returned from function
* \param *err Pointer to error type returned from function
*/
- void iGeom_unite(iGeom_Instance instance,
- iBase_EntitySetHandle entity_set_1,
- iBase_EntitySetHandle entity_set_2,
- iBase_EntitySetHandle* result_entity_set,
- int *err);
+ void iGeom_unite( iGeom_Instance instance,
+ iBase_EntitySetHandle entity_set_1,
+ iBase_EntitySetHandle entity_set_2,
+ iBase_EntitySetHandle* result_entity_set,
+ int *err );
#ifdef __cplusplus
} // extern "C"
More information about the cgma-dev
mailing list