/Users/kddevin/ITAPS/TSTT/Interface/iMesh/iMesh.h File Reference

#include "iBase.h"
#include "iMesh_protos.h"

Include dependency graph for iMesh.h:


Defines

#define IMESH_MAJOR_VERSION   0
#define IMESH_MINOR_VERSION   8

Typedefs

typedef struct
iMesh_Instance_Private * 
iMesh_Instance
 Type used to store iMesh interface handle.
typedef struct
iMesh_EntityIterator_Private * 
iMesh_EntityIterator
 Type used to store an iterator returned by iMesh.
typedef struct
iMesh_EntityArrIterator_Private * 
iMesh_EntityArrIterator
 Type used to store an array iterator returned by iMesh.

Enumerations

enum  iMesh_EntityTopology {
  iMesh_POINT = 0, iMesh_LINE_SEGMENT, iMesh_POLYGON, iMesh_TRIANGLE,
  iMesh_QUADRILATERAL, iMesh_POLYHEDRON, iMesh_TETRAHEDRON, iMesh_HEXAHEDRON,
  iMesh_PRISM, iMesh_PYRAMID, iMesh_SEPTAHEDRON, iMesh_ALL_TOPOLOGIES
}
 Enumerator specifying entity topology. More...

Functions

void iMesh_getErrorType (iMesh_Instance instance, int *error_type, int *err)
 Get the error type returned from the last iMesh function.
void iMesh_getDescription (iMesh_Instance instance, char *descr, int *err, int descr_len)
 Get a description of the error returned from the last iMesh function.
void iMesh_newMesh (const char *options, iMesh_Instance *instance, int *err, int options_len)
 Construct a new iMesh instance.
void iMesh_dtor (iMesh_Instance instance, int *err)
 Destroy an iMesh instance.
void iMesh_load (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const char *name, const char *options, int *err, int name_len, int options_len)
 Load a mesh from a file.
void iMesh_save (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const char *name, const char *options, int *err, const int name_len, int options_len)
 Save a mesh to a file.
void iMesh_getRootSet (iMesh_Instance instance, iBase_EntitySetHandle *root_set, int *err)
 Get handle of the root set for this instance.
void iMesh_getGeometricDimension (iMesh_Instance instance, int *geom_dim, int *err)
 Get the geometric dimension of mesh represented in this instance.
void iMesh_setGeometricDimension (iMesh_Instance instance, int geom_dim, int *err)
 Set geometric dimension of vertex coordinates.
void iMesh_getDfltStorage (iMesh_Instance instance, int *order, int *err)
 Get the default storage order used by this implementation.
void iMesh_getAdjTable (iMesh_Instance instance, int **adjacency_table, int *adjacency_table_allocated, int *adjacency_table_size, int *err)
 Get the adjacency table for this implementation.
void iMesh_getNumOfType (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int entity_type, int *num_type, int *err)
 Get the number of entities with the specified type in the instance or set.
void iMesh_getNumOfTopo (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int entity_topology, int *num_topo, int *err)
 Get the number of entities with the specified topology in the instance or set.
void iMesh_areEHValid (iMesh_Instance instance, int doReset, int *areHandlesInvariant, int *err)
 Return whether entity handles have changed since last reset or since instance construction.
void iMesh_getEntities (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int entity_type, const int entity_topology, iBase_EntityHandle **entity_handles, int *entity_handles_allocated, int *entity_handles_size, int *err)
 Get entities of specific type and/or topology in set or instance.
void iMesh_getVtxArrCoords (iMesh_Instance instance, const iBase_EntityHandle *vertex_handles, const int vertex_handles_size, int storage_order, double **coords, int *coords_allocated, int *coords_size, int *err)
 Get coordinates of specified vertices.
void iMesh_initEntArrIter (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int requested_entity_type, const int requested_entity_topology, const int requested_array_size, iMesh_EntityArrIterator *entArr_iterator, int *err)
 Initialize an array iterator over specified entity type, topology, and size.
void iMesh_getNextEntArrIter (iMesh_Instance instance, iMesh_EntityArrIterator entArr_iterator, iBase_EntityHandle **entity_handles, int *entity_handles_allocated, int *entity_handles_size, int *has_data, int *err)
 Get entities contained in array iterator and increment iterator.
void iMesh_resetEntArrIter (iMesh_Instance instance, iMesh_EntityArrIterator entArr_iterator, int *err)
 Reset the array iterator.
void iMesh_endEntArrIter (iMesh_Instance instance, iMesh_EntityArrIterator entArr_iterator, int *err)
 Destroy the specified array iterator.
void iMesh_getEntArrTopo (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, int **topology, int *topology_allocated, int *topology_size, int *err)
 Get the entity topology for the specified entities.
void iMesh_getEntArrType (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, int **type, int *type_allocated, int *type_size, int *err)
 Get the entity type for the specified entities.
void iMesh_getEntArrAdj (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const int entity_type_requested, iBase_EntityHandle **adjacentEntityHandles, int *adjacentEntityHandles_allocated, int *adj_entity_handles_size, int **offset, int *offset_allocated, int *offset_size, int *err)
 Get entities of specified type adjacent to entities.
void iMesh_getEntArr2ndAdj (iMesh_Instance instance, iBase_EntityHandle const *entity_handles, int entity_handles_size, int bridge_entity_type, int requested_entity_type, iBase_EntityHandle **adj_entity_handles, int *adj_entity_handles_allocated, int *adj_entity_handles_size, int **offset, int *offset_allocated, int *offset_size, int *err)
 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.
void iMesh_getAdjEntIndices (iMesh_Instance instance, iBase_EntitySetHandle entity_set_handle, int entity_type_requestor, int entity_topology_requestor, int entity_type_requested, iBase_EntityHandle **entity_handles, int *entity_handles_allocated, int *entity_handles_size, iBase_EntityHandle **adj_entity_handles, int *adj_entity_handles_allocated, int *adj_entity_handles_size, int **adj_entity_indices, int *adj_entity_indices_allocated, int *adj_entity_indices_size, int **offset, int *offset_allocated, int *offset_size, int *err)
 Get indexed representation of mesh or subset of mesh.
void iMesh_createEntSet (iMesh_Instance instance, const int isList, iBase_EntitySetHandle *entity_set_created, int *err)
 Create an entity set.
void iMesh_destroyEntSet (iMesh_Instance instance, iBase_EntitySetHandle entity_set, int *err)
 Destroy an entity set.
void iMesh_isList (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, int *is_list, int *err)
 Return whether a specified set is ordered or unordered.
void iMesh_getNumEntSets (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int num_hops, int *num_sets, int *err)
 Get the number of entity sets contained in a set or interface.
void iMesh_getEntSets (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int num_hops, iBase_EntitySetHandle **contained_set_handles, int *contained_set_handles_allocated, int *contained_set_handles_size, int *err)
 Get the entity sets contained in a set or interface.
void iMesh_addEntToSet (iMesh_Instance instance, iBase_EntityHandle entity_handle, iBase_EntitySetHandle entity_set, int *err)
 Add an entity to a set.
void iMesh_rmvEntFromSet (iMesh_Instance instance, iBase_EntityHandle entity_handle, iBase_EntitySetHandle entity_set, int *err)
 Remove an entity from a set.
void iMesh_addEntArrToSet (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, int entity_handles_size, iBase_EntitySetHandle entity_set, int *err)
 Add an array of entities to a set.
void iMesh_rmvEntArrFromSet (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, int entity_handles_size, iBase_EntitySetHandle entity_set, int *err)
 Remove an array of entities from a set.
void iMesh_addEntSet (iMesh_Instance instance, iBase_EntitySetHandle entity_set_to_add, iBase_EntitySetHandle entity_set_handle, int *err)
 Add an entity set to a set.
void iMesh_rmvEntSet (iMesh_Instance instance, iBase_EntitySetHandle entity_set_to_remove, iBase_EntitySetHandle entity_set_handle, int *err)
 Remove an entity set from a set.
void iMesh_isEntContained (iMesh_Instance instance, iBase_EntitySetHandle containing_entity_set, iBase_EntityHandle contained_entity, int *is_contained, int *err)
 Return whether an entity is contained in another set.
void iMesh_isEntArrContained (iMesh_Instance instance, iBase_EntitySetHandle containing_set, const iBase_EntityHandle *entity_handles, int num_entity_handles, int **is_contained, int *is_contained_allocated, int *is_contained_size, int *err)
 Return whether entities are contained in a set.
void iMesh_isEntSetContained (iMesh_Instance instance, const iBase_EntitySetHandle containing_entity_set, const iBase_EntitySetHandle contained_entity_set, int *is_contained, int *err)
 Return whether an entity set is contained in another set.
void iMesh_addPrntChld (iMesh_Instance instance, iBase_EntitySetHandle parent_entity_set, iBase_EntitySetHandle child_entity_set, int *err)
 Add parent/child links between two sets.
void iMesh_rmvPrntChld (iMesh_Instance instance, iBase_EntitySetHandle parent_entity_set, iBase_EntitySetHandle child_entity_set, int *err)
 Remove parent/child links between two sets.
void iMesh_isChildOf (iMesh_Instance instance, const iBase_EntitySetHandle parent_entity_set, const iBase_EntitySetHandle child_entity_set, int *is_child, int *err)
 Return whether two sets are related by parent/child links.
void iMesh_getNumChld (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, const int num_hops, int *num_child, int *err)
 Get the number of child sets linked from a specified set.
void iMesh_getNumPrnt (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, const int num_hops, int *num_parent, int *err)
 Get the number of parent sets linked from a specified set.
void iMesh_getChldn (iMesh_Instance instance, const iBase_EntitySetHandle from_entity_set, const int num_hops, iBase_EntitySetHandle **entity_set_handles, int *entity_set_handles_allocated, int *entity_set_handles_size, int *err)
 Get the child sets linked from a specified set.
void iMesh_getPrnts (iMesh_Instance instance, const iBase_EntitySetHandle from_entity_set, const int num_hops, iBase_EntitySetHandle **entity_set_handles, int *entity_set_handles_allocated, int *entity_set_handles_size, int *err)
 Get the parent sets linked from a specified set.
void iMesh_setVtxArrCoords (iMesh_Instance instance, const iBase_EntityHandle *vertex_handles, const int vertex_handles_size, const int storage_order, const double *new_coords, const int new_coords_size, int *err)
 Set coordinates for an array of vertices.
void iMesh_createVtxArr (iMesh_Instance instance, const int num_verts, const int storage_order, const double *new_coords, const int new_coords_size, iBase_EntityHandle **new_vertex_handles, int *new_vertex_handles_allocated, int *new_vertex_handles_size, int *err)
 Create an array of new vertices at specified coordinates.
void iMesh_createEntArr (iMesh_Instance instance, const int new_entity_topology, const iBase_EntityHandle *lower_order_entity_handles, const int lower_order_entity_handles_size, iBase_EntityHandle **new_entity_handles, int *new_entity_handles_allocated, int *new_entity_handles_size, int **status, int *status_allocated, int *status_size, int *err)
 Create an array of new entities with specified lower-order topology.
void iMesh_deleteEntArr (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, int *err)
 Delete specified entities.
void iMesh_createTag (iMesh_Instance instance, const char *tag_name, const int tag_size, const int tag_type, iBase_TagHandle *tag_handle, int *err, const int tag_name_len)
 Create a tag with specified name, size, and type.
void iMesh_destroyTag (iMesh_Instance instance, iBase_TagHandle tag_handle, const int forced, int *err)
 Destroy a tag.
void iMesh_getTagName (iMesh_Instance instance, const iBase_TagHandle tag_handle, char *name, int *err, int name_len)
 Get the name for a given tag handle.
void iMesh_getTagSizeValues (iMesh_Instance instance, const iBase_TagHandle tag_handle, int *tag_size, int *err)
 Get size of a tag in units of numbers of tag data type.
void iMesh_getTagSizeBytes (iMesh_Instance instance, const iBase_TagHandle tag_handle, int *tag_size, int *err)
 Get size of a tag in units of bytes.
void iMesh_getTagHandle (iMesh_Instance instance, const char *tag_name, iBase_TagHandle *tag_handle, int *err, int tag_name_len)
 Get a the handle of an existing tag with the specified name.
void iMesh_getTagType (iMesh_Instance instance, const iBase_TagHandle tag_handle, int *tag_type, int *err)
 Get the data type of the specified tag handle.
void iMesh_setEntSetData (iMesh_Instance instance, iBase_EntitySetHandle entity_set_handle, const iBase_TagHandle tag_handle, const char *tag_value, const int tag_value_size, int *err)
 Set a tag value of arbitrary type on an entity set.
void iMesh_setEntSetIntData (iMesh_Instance instance, iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, const int tag_value, int *err)
 Set a tag value of integer type on an entity set.
void iMesh_setEntSetDblData (iMesh_Instance instance, iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, const double tag_value, int *err)
 Set a tag value of double type on an entity set.
void iMesh_setEntSetEHData (iMesh_Instance instance, iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, const iBase_EntityHandle tag_value, int *err)
 Set a tag value of entity handle type on an entity set.
void iMesh_getEntSetData (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const iBase_TagHandle tag_handle, char **tag_value, int *tag_value_allocated, int *tag_value_size, int *err)
 Get the value of a tag of arbitrary type on an entity set.
void iMesh_getEntSetIntData (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, int *out_data, int *err)
 Get the value of a tag of integer type on an entity set.
void iMesh_getEntSetDblData (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, double *out_data, int *err)
 Get the value of a tag of double type on an entity set.
void iMesh_getEntSetEHData (iMesh_Instance instance, const iBase_EntitySetHandle entity_set, const iBase_TagHandle tag_handle, iBase_EntityHandle *out_data, int *err)
 Get the value of a tag of entity handle type on an entity set.
void iMesh_getAllEntSetTags (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, iBase_TagHandle **tag_handles, int *tag_handles_allocated, int *tag_handles_size, int *err)
 Get all the tags associated with a specified entity set.
void iMesh_rmvEntSetTag (iMesh_Instance instance, iBase_EntitySetHandle entity_set_handle, const iBase_TagHandle tag_handle, int *err)
 Remove a tag value from an entity set.
void iMesh_setVtxCoord (iMesh_Instance instance, iBase_EntityHandle vertex_handle, const double x, const double y, const double z, int *err)
 Set coordinates for a vertex.
void iMesh_createVtx (iMesh_Instance instance, const double x, const double y, const double z, iBase_EntityHandle *new_vertex_handle, int *err)
 Create a new vertex at specified coordinates.
void iMesh_createEnt (iMesh_Instance instance, const int new_entity_topology, const iBase_EntityHandle *lower_order_entity_handles, const int lower_order_entity_handles_size, iBase_EntityHandle *new_entity_handle, int *status, int *err)
 Create a new entity with specified lower-order topology.
void iMesh_deleteEnt (iMesh_Instance instance, iBase_EntityHandle entity_handle, int *err)
 Delete specified entity.
void iMesh_getArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, char **tag_values, int *tag_values_allocated, int *tag_values_size, int *err)
 Get tag values of arbitrary type for an array of entities.
void iMesh_getIntArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, int **tag_values, int *tag_values_allocated, int *tag_values_size, int *err)
 Get tag values of integer type for an array of entities.
void iMesh_getDblArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, double **tag_values, int *tag_values_allocated, int *tag_values_size, int *err)
 Get tag values of double type for an array of entities.
void iMesh_getEHArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, iBase_EntityHandle **tag_value, int *tag_value_allocated, int *tag_value_size, int *err)
 Get tag values of entity handle type for an array of entities.
void iMesh_setArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, const char *tag_values, const int tag_values_size, int *err)
 Set tag values of arbitrary type on an array of entities.
void iMesh_setIntArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, const int *tag_values, const int tag_values_size, int *err)
 Set tag values of integer type on an array of entities.
void iMesh_setDblArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, const double *tag_values, const int tag_values_size, int *err)
 Set tag values of double type on an array of entities.
void iMesh_setEHArrData (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, const iBase_EntityHandle *tag_values, const int tag_values_size, int *err)
 Set tag values of entity handle type on an array of entities.
void iMesh_rmvArrTag (iMesh_Instance instance, const iBase_EntityHandle *entity_handles, const int entity_handles_size, const iBase_TagHandle tag_handle, int *err)
 Remove a tag value from an array of entities.
void iMesh_getData (iMesh_Instance instance, const iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, char **tag_value, int *tag_value_allocated, int *tag_value_size, int *err)
 Get the value of a tag of arbitrary type on an entity.
void iMesh_getIntData (iMesh_Instance instance, const iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, int *out_data, int *err)
 Get the value of a tag of integer type on an entity.
void iMesh_getDblData (iMesh_Instance instance, const iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, double *out_data, int *err)
 Get the value of a tag of double type on an entity.
void iMesh_getEHData (iMesh_Instance instance, const iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, iBase_EntityHandle *out_data, int *err)
 Get the value of a tag of entity handle type on an entity.
void iMesh_setData (iMesh_Instance instance, iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, const char *tag_value, const int tag_value_size, int *err)
 Set a tag value of arbitrary type on an entity.
void iMesh_setIntData (iMesh_Instance instance, iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, const int tag_value, int *err)
 Set a tag value of integer type on an entity.
void iMesh_setDblData (iMesh_Instance instance, iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, const double tag_value, int *err)
 Set a tag value of double type on an entity.
void iMesh_setEHData (iMesh_Instance instance, iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, const iBase_EntityHandle tag_value, int *err)
 Set a tag value of entity handle type on an entity.
void iMesh_getAllTags (iMesh_Instance instance, const iBase_EntityHandle entity_handle, iBase_TagHandle **tag_handles, int *tag_handles_allocated, int *tag_handles_size, int *err)
 Get all the tags associated with a specified entity handle.
void iMesh_rmvTag (iMesh_Instance instance, iBase_EntityHandle entity_handle, const iBase_TagHandle tag_handle, int *err)
 Remove a tag value from an entity.
void iMesh_initEntIter (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_handle, const int requested_entity_type, const int requested_entity_topology, iMesh_EntityIterator *entity_iterator, int *err)
 Initialize an iterator over specified entity type, topology, and size.
void iMesh_getNextEntIter (iMesh_Instance instance, iMesh_EntityIterator entity_iterator, iBase_EntityHandle *entity_handle, int *has_data, int *err)
 Get entity corresponding to an iterator and increment iterator.
void iMesh_resetEntIter (iMesh_Instance instance, iMesh_EntityIterator entity_iterator, int *err)
 Reset the iterator.
void iMesh_endEntIter (iMesh_Instance instance, iMesh_EntityIterator entity_iterator, int *err)
 Destroy the specified iterator.
void iMesh_getEntTopo (iMesh_Instance instance, const iBase_EntityHandle entity_handle, int *out_topo, int *err)
 Get the entity topology for the specified entity.
void iMesh_getEntType (iMesh_Instance instance, const iBase_EntityHandle entity_handle, int *out_type, int *err)
 Get the entity type for the specified entity.
void iMesh_getVtxCoord (iMesh_Instance instance, const iBase_EntityHandle vertex_handle, double *x, double *y, double *z, int *err)
 Get coordinates of specified vertex.
void iMesh_getEntAdj (iMesh_Instance instance, const iBase_EntityHandle entity_handle, const int entity_type_requested, iBase_EntityHandle **adj_entity_handles, int *adj_entity_handles_allocated, int *adj_entity_handles_size, int *err)
 Get entities of specified type adjacent to an entity.
void iMesh_getEnt2ndAdj (iMesh_Instance instance, iBase_EntityHandle entity_handle, int bridge_entity_type, int requested_entity_type, iBase_EntityHandle **adjacent_entities, int *adjacent_entities_allocated, int *adjacent_entities_size, int *err)
 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.
void iMesh_subtract (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_1, const iBase_EntitySetHandle entity_set_2, iBase_EntitySetHandle *result_entity_set, int *err)
 Subtract contents of one entity set from another.
void iMesh_intersect (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_1, const iBase_EntitySetHandle entity_set_2, iBase_EntitySetHandle *result_entity_set, int *err)
 Intersect contents of one entity set with another.
void iMesh_unite (iMesh_Instance instance, const iBase_EntitySetHandle entity_set_1, const iBase_EntitySetHandle entity_set_2, iBase_EntitySetHandle *result_entity_set, int *err)
 Unite contents of one entity set with another.

Define Documentation

#define IMESH_MAJOR_VERSION   0

#define IMESH_MINOR_VERSION   8


Typedef Documentation

typedef struct iMesh_EntityArrIterator_Private* iMesh_EntityArrIterator

Type used to store an array iterator returned by iMesh.

Type used to store an array iterator returned by iMesh

typedef struct iMesh_EntityIterator_Private* iMesh_EntityIterator

Type used to store an iterator returned by iMesh.

Type used to store an iterator returned by iMesh

typedef struct iMesh_Instance_Private* iMesh_Instance

Type used to store iMesh interface handle.

Type used to store iMesh interface handle


Enumeration Type Documentation

Enumerator specifying entity topology.

Enumerator specifying entity topology.

Enumerator:
iMesh_POINT  a general zero-dimensional entity
iMesh_LINE_SEGMENT  a general one-dimensional entity
iMesh_POLYGON  a general two-dimensional element
iMesh_TRIANGLE  a three-sided, two-dimensional element
iMesh_QUADRILATERAL  a four-sided, two-dimensional element
iMesh_POLYHEDRON  a general three-dimensional element
iMesh_TETRAHEDRON  a four-sided, three-dimensional element whose faces are triangles
iMesh_HEXAHEDRON  a six-sided, three-dimensional element whose faces are quadrilaterals
iMesh_PRISM  a five-sided, three-dimensional element which has three quadrilateral faces and two triangular faces
iMesh_PYRAMID  a five-sided, three-dimensional element which has one quadrilateral face and four triangular faces
iMesh_SEPTAHEDRON  a hexahedral entity with one collapsed edge
iMesh_ALL_TOPOLOGIES  allows the user to request information about all the topology types


Function Documentation

void iMesh_addEntArrToSet ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
int  entity_handles_size,
iBase_EntitySetHandle  entity_set,
int *  err 
)

Add an array of entities to a set.

Add an array of entities to a set

Parameters:
instance iMesh instance handle
entity_handles Array of entities being added
entity_handles_size Number of entities in entity_handles array
entity_set Pointer to the set being added to
*err Pointer to error type returned from function

void iMesh_addEntSet ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set_to_add,
iBase_EntitySetHandle  entity_set_handle,
int *  err 
)

Add an entity set to a set.

Add an entity set to a set

Parameters:
instance iMesh instance handle
entity_set_to_add The entity set being added
entity_set_handle Pointer to the set being added to
*err Pointer to error type returned from function

void iMesh_addEntToSet ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
iBase_EntitySetHandle  entity_set,
int *  err 
)

Add an entity to a set.

Add an entity to a set

Parameters:
instance iMesh instance handle
entity_handle The entity being added
entity_set Pointer to the set being added to
*err Pointer to error type returned from function

void iMesh_addPrntChld ( iMesh_Instance  instance,
iBase_EntitySetHandle  parent_entity_set,
iBase_EntitySetHandle  child_entity_set,
int *  err 
)

Add parent/child links between two sets.

Add parent/child links between two sets. Makes parent point to child and child point to parent.

Parameters:
instance iMesh instance handle
parent_entity_set Pointer to parent set
child_entity_set Pointer to child set
*err Pointer to error type returned from function

void iMesh_areEHValid ( iMesh_Instance  instance,
int  doReset,
int *  areHandlesInvariant,
int *  err 
)

Return whether entity handles have changed since last reset or since instance construction.

Return whether entity handles have changed since last reset or since instance construction. If non-zero value is returned, it is not guaranteed that a handle from before the last call to this function represents the same entity as the same handle value does now. If doReset is non-zero, resets the starting point for this function.

Parameters:
instance iMesh instance handle
doReset Perform a reset on the starting point after which handles are invariant.
areHandlesInvariant Pointer to invariant flag returned from function
*err Pointer to error type returned from function

void iMesh_createEnt ( iMesh_Instance  instance,
const int  new_entity_topology,
const iBase_EntityHandle *  lower_order_entity_handles,
const int  lower_order_entity_handles_size,
iBase_EntityHandle *  new_entity_handle,
int *  status,
int *  err 
)

Create a new entity with specified lower-order topology.

Create a new entity with specified lower-order topology. Specified new_entity_topology must be value in iMesh_EntityTopology enumeration. Value returned as status must be a value in the iBase_CreationStatus enumeration.

Parameters:
instance iMesh instance handle
new_entity_topology Topology of created entity
lower_order_entity_handles Array of lower order entity handles used to construct new entity
lower_order_entity_handles_size Number of entities in array of lower order entity handles
new_entity_handle Pointer to new entity handle returned from function
status Pointer to creation status returned from function
*err Pointer to error type returned from function

void iMesh_createEntArr ( iMesh_Instance  instance,
const int  new_entity_topology,
const iBase_EntityHandle *  lower_order_entity_handles,
const int  lower_order_entity_handles_size,
iBase_EntityHandle **  new_entity_handles,
int *  new_entity_handles_allocated,
int *  new_entity_handles_size,
int **  status,
int *  status_allocated,
int *  status_size,
int *  err 
)

Create an array of new entities with specified lower-order topology.

Create an array of new entities with specified lower-order topology. Specified new_entity_topology must be value in iMesh_EntityTopology enumeration. Values return in status array must be values in the iBase_CreationStatus enumeration.

Parameters:
instance iMesh instance handle
new_entity_topology Topology of created entity
lower_order_entity_handles Array of lower order entity handles used to construct new entities
lower_order_entity_handles_size Number of entities in array of lower order entity handles
*new_entity_handles Pointer to array of new_entity_handles returned from function
*new_entity_handles_allocated Pointer to allocated size of new_entity_handles array
*new_entity_handles_size Pointer to occupied size of new_entity_handles array
*status Pointer to array of creation status returned from function
*status_allocated Pointer to allocated size of status array
*status_size Pointer to occupied size of status array
*err Pointer to error type returned from function

void iMesh_createEntSet ( iMesh_Instance  instance,
const int  isList,
iBase_EntitySetHandle *  entity_set_created,
int *  err 
)

Create an entity set.

Create an entity set, either ordered (isList=1) or unordered (isList=0). Unordered entity sets can contain a given entity or set only once.

Parameters:
instance iMesh instance handle
isList If non-zero, an ordered list is created, otherwise an unordered set is created.
entity_set_created Entity set created by function
*err Pointer to error type returned from function

void iMesh_createTag ( iMesh_Instance  instance,
const char *  tag_name,
const int  tag_size,
const int  tag_type,
iBase_TagHandle *  tag_handle,
int *  err,
const int  tag_name_len 
)

Create a tag with specified name, size, and type.

Create a tag with specified name, size, and type. Tag size is in units of size of tag_type data types. Value input for tag type must be value in iBase_TagType enumeration.

Parameters:
instance iMesh instance handle
tag_name Character string indicating tag name
tag_size Size of each tag value, in units of number of tag_type entities
tag_type Data type for data stored in this tag
tag_handle Pointer to tag handle returned from function
*err Pointer to error type returned from function
tag_name_len Length of tag name string

void iMesh_createVtx ( iMesh_Instance  instance,
const double  x,
const double  y,
const double  z,
iBase_EntityHandle *  new_vertex_handle,
int *  err 
)

Create a new vertex at specified coordinates.

Create a new vertex at specified coordinates.

Parameters:
instance iMesh instance handle
x x coordinate of new vertex
y y coordinate of new vertex
z z coordinate of new vertex
new_vertex_handle Pointer to new vertex handles returned from function
*err Pointer to error type returned from function

void iMesh_createVtxArr ( iMesh_Instance  instance,
const int  num_verts,
const int  storage_order,
const double *  new_coords,
const int  new_coords_size,
iBase_EntityHandle **  new_vertex_handles,
int *  new_vertex_handles_allocated,
int *  new_vertex_handles_size,
int *  err 
)

Create an array of new vertices at specified coordinates.

Create an array of new vertices at specified coordinates. Value of storage_order must be either iBase_INTERLEAVED or iBase_BLOCKED.

Parameters:
instance iMesh instance handle
num_verts Number of new vertices to be created
storage_order Storage order of coordinates in new_coords array
new_coords Array of coordinates of new vertices
new_coords_size Number of coordinates in new_coords array, should be 3*num_verts
*new_vertex_handles Pointer to array of new vertex handles returned from function
*new_vertex_handles_allocated Pointer to allocated size of new_vertex_handles array
*new_vertex_handles_size Pointer to occupied size of new_vertex_handles array
*err Pointer to error type returned from function

void iMesh_deleteEnt ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
int *  err 
)

Delete specified entity.

Delete specified entity

Parameters:
instance iMesh instance handle
entity_handle Entity to be deleted
*err Pointer to error type returned from function

void iMesh_deleteEntArr ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
int *  err 
)

Delete specified entities.

Delete specified entities

Parameters:
instance iMesh instance handle
entity_handles Array of entity handles to be deleted
entity_handles_size Number of entities in array to be deleted
*err Pointer to error type returned from function

void iMesh_destroyEntSet ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set,
int *  err 
)

Destroy an entity set.

Destroy an entity set

Parameters:
instance iMesh instance handle
entity_set Entity set to be destroyed
*err Pointer to error type returned from function

void iMesh_destroyTag ( iMesh_Instance  instance,
iBase_TagHandle  tag_handle,
const int  forced,
int *  err 
)

Destroy a tag.

Destroy a tag. If forced is non-zero and entities still have values set for this tag, tag is deleted anyway and those values disappear, otherwise tag is not deleted.

Parameters:
instance iMesh instance handle
tag_handle Handle of tag to be deleted
forced If non-zero, delete the tag even if entities have values set for that tag
*err Pointer to error type returned from function

void iMesh_dtor ( iMesh_Instance  instance,
int *  err 
)

Destroy an iMesh instance.

Destroy an iMesh instance

Parameters:
instance iMesh instance to be destroyed
*err Pointer to error type returned from function

void iMesh_endEntArrIter ( iMesh_Instance  instance,
iMesh_EntityArrIterator  entArr_iterator,
int *  err 
)

Destroy the specified array iterator.

Destroy the specified array iterator

Parameters:
instance iMesh instance handle
entArr_iterator Iterator which gets destroyed
*err Pointer to error type returned from function

void iMesh_endEntIter ( iMesh_Instance  instance,
iMesh_EntityIterator  entity_iterator,
int *  err 
)

Destroy the specified iterator.

Destroy the specified iterator

Parameters:
instance iMesh instance handle
entity_iterator Iterator which gets destroyed
*err Pointer to error type returned from function

void iMesh_getAdjEntIndices ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set_handle,
int  entity_type_requestor,
int  entity_topology_requestor,
int  entity_type_requested,
iBase_EntityHandle **  entity_handles,
int *  entity_handles_allocated,
int *  entity_handles_size,
iBase_EntityHandle **  adj_entity_handles,
int *  adj_entity_handles_allocated,
int *  adj_entity_handles_size,
int **  adj_entity_indices,
int *  adj_entity_indices_allocated,
int *  adj_entity_indices_size,
int **  offset,
int *  offset_allocated,
int *  offset_size,
int *  err 
)

Get indexed representation of mesh or subset of mesh.

Given an entity set and optionally a type or topology, return:

  • The entities in the set of the specified type or topology
  • The entities adjacent to those entities with a specified type, as a list of unique handles.
  • For each entity in the first list, the adjacent entities, specified as indices into the second list.

Parameters:
entity_set_handle The set of entities from which to query
entity_type_requestor If not iBase_ALL_TYPES, act only on the subset of 'entity_set_handle' of the specified type.
entity_topology_requestor If not iMesh_ALL_TOPOLOGIES, act only on the subset of 'entity_set_handle' with the specified topology.
entity_type_requested The type of the adjacent entities to return.
entity_handles The handles of the (non-struct) subset of the entity set indicated by 'entity_set_handle' and the optional type and topology filtering arguments.
adj_entity_handles The union of the unique entities of type 'requested_entity_type' adjacent to each entity in 'entity_handles'. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
adj_entity_indices For each entity in 'entity_handles', the adjacent entities of type 'entity_type_requested', specified as indices into 'adj_entity_handles'. The values are concatenated into a single array in the order of the entity handles in 'entity_handles'.
offset For each entity in the corresponding position in 'entity_handles', the position in 'adj_entity_indices' at which values for that entity are stored.

void iMesh_getAdjTable ( iMesh_Instance  instance,
int **  adjacency_table,
int *  adjacency_table_allocated,
int *  adjacency_table_size,
int *  err 
)

Get the adjacency table for this implementation.

Get the adjacency table for this implementation. This table is a 4x4 array, with indices 0-based, where A(i,j) (i=row, j=column) represents the relative cost of retrieving adjacencies between entities of dimension i to entities of dimension j

Parameters:
instance iMesh instance handle
*adjacency_table Pointer to array representing adjacency table returned from function
adjacency_table_allocated Pointer to allocated size of adjacency table
adjacency_table_size Pointer to occupied size of adjacency table
*err Pointer to error type returned from function

void iMesh_getAllEntSetTags ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
iBase_TagHandle **  tag_handles,
int *  tag_handles_allocated,
int *  tag_handles_size,
int *  err 
)

Get all the tags associated with a specified entity set.

Get all the tags associated with a specified entity set

Parameters:
instance iMesh instance handle
entity_set_handle Entity being queried
*tag_handles Pointer to array of tag_handles returned from function
*tag_handles_allocated Pointer to allocated size of tag_handles array
*tag_handles_size Pointer to occupied size of tag_handles array
*err Pointer to error type returned from function

void iMesh_getAllTags ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
iBase_TagHandle **  tag_handles,
int *  tag_handles_allocated,
int *  tag_handles_size,
int *  err 
)

Get all the tags associated with a specified entity handle.

Get all the tags associated with a specified entity handle

Parameters:
instance iMesh instance handle
entity_handle Entity being queried
*tag_handles Pointer to array of tag_handles returned from function
*tag_handles_allocated Pointer to allocated size of tag_handles array
*tag_handles_size Pointer to occupied size of tag_handles array
*err Pointer to error type returned from function

void iMesh_getArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
char **  tag_values,
int *  tag_values_allocated,
int *  tag_values_size,
int *  err 
)

Get tag values of arbitrary type for an array of entities.

Get tag values of arbitrary type for an array of entities. Tag data is returned as char* type, but really represents arbitrary data.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
*tag_values Pointer to tag data array being returned from function. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_allocated Pointer to allocated size of tag data array
tag_values_size Pointer to occupied size of tag data array
*err Pointer to error type returned from function

void iMesh_getChldn ( iMesh_Instance  instance,
const iBase_EntitySetHandle  from_entity_set,
const int  num_hops,
iBase_EntitySetHandle **  entity_set_handles,
int *  entity_set_handles_allocated,
int *  entity_set_handles_size,
int *  err 
)

Get the child sets linked from a specified set.

Get the child sets linked from a specified set. If num_hops is non-zero, this represents the maximum hops from entity_set to any child.

Parameters:
instance iMesh instance handle
from_entity_set Entity set being queried
num_hops Maximum hops from entity_set_handle to child set, inclusive of the child set
*entity_set_handles Pointer to array of child sets returned from function
*entity_set_handles_allocated Pointer to allocated size of entity_set_handles array
*entity_set_handles_size Pointer to occupied size of entity_set_handles array
*err Pointer to error type returned from function

void iMesh_getData ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
char **  tag_value,
int *  tag_value_allocated,
int *  tag_value_size,
int *  err 
)

Get the value of a tag of arbitrary type on an entity.

Get the value of a tag of arbitrary type on an entity. Tag data is passed back as char* type, but really represents arbitrary data.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
*tag_value Pointer to tag data array being queried
*tag_value_allocated Pointer to tag data array allocated size
*tag_value_size Pointer to tag data array occupied size
*err Pointer to error type returned from function

void iMesh_getDblArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
double **  tag_values,
int *  tag_values_allocated,
int *  tag_values_size,
int *  err 
)

Get tag values of double type for an array of entities.

Get tag values of double type for an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
*tag_values Pointer to tag data array being returned from function. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_allocated Pointer to allocated size of tag data array
tag_values_size Pointer to occupied size of tag data array
*err Pointer to error type returned from function

void iMesh_getDblData ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
double *  out_data,
int *  err 
)

Get the value of a tag of double type on an entity.

Get the value of a tag of double type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getDescription ( iMesh_Instance  instance,
char *  descr,
int *  err,
int  descr_len 
)

Get a description of the error returned from the last iMesh function.

Get a description of the error returned from the last iMesh function

Parameters:
instance iMesh instance handle
descr Pointer to a character string to be filled with a description of the error from the last iMesh function
*err Pointer to error type returned from function
descr_len Length of the character string pointed to by descr

void iMesh_getDfltStorage ( iMesh_Instance  instance,
int *  order,
int *  err 
)

Get the default storage order used by this implementation.

Get the default storage order used by this implementation. Value returned is a member of the iBase_StorageOrder enumeration.

Parameters:
instance iMesh instance handle
order Pointer to storage order returned from function
*err Pointer to error type returned from function

void iMesh_getEHArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
iBase_EntityHandle **  tag_value,
int *  tag_value_allocated,
int *  tag_value_size,
int *  err 
)

Get tag values of entity handle type for an array of entities.

Get tag values of entity handle type for an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
*tag_value Pointer to tag data array being returned from function. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_value_allocated Pointer to allocated size of tag data array
tag_value_size Pointer to occupied size of tag data array
*err Pointer to error type returned from function

void iMesh_getEHData ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
iBase_EntityHandle *  out_data,
int *  err 
)

Get the value of a tag of entity handle type on an entity.

Get the value of a tag of entity handle type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getEnt2ndAdj ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
int  bridge_entity_type,
int  requested_entity_type,
iBase_EntityHandle **  adjacent_entities,
int *  adjacent_entities_allocated,
int *  adjacent_entities_size,
int *  err 
)

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.

Note 1: If the "bridge" dimension is the same as the "to" dimension or the dimension of the input entity, the output will be empty (and an error code of iBase_INVALID_ARGUMENT returned). This is consistent with the definition of adjacencies and the behavior of iMesh first adjacency calls. Note 2: An entity will never be returned as a second adjacency of itself, on the grounds that this is the most likely expectation of applications, and that it is easier for an application to add the original entity to the returned data than to find and remove it.

Parameters:
instance iMesh instance for this call
entity_handle Entity from which adjacencies are requested
bridge_entity_type Type of bridge entity for 2nd order adjacencies
requested_entity_type Type of adjacent entities returned
adjacent_entities Adjacent entities
adjacent_entities_allocated Allocated size of returned array
adjacent_entities_size Occupied size of returned array
err 

void iMesh_getEntAdj ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
const int  entity_type_requested,
iBase_EntityHandle **  adj_entity_handles,
int *  adj_entity_handles_allocated,
int *  adj_entity_handles_size,
int *  err 
)

Get entities of specified type adjacent to an entity.

Get entities of specified type adjacent to an entity. Specified type must be value in the iBase_EntityType enumeration.

Parameters:
instance iMesh instance handle
entity_handle Entity handle being queried
entity_type_requested Type of adjacent entities requested
*adj_entity_handles Pointer to array of adjacent entities returned from function
*adj_entity_handles_allocated Pointer to allocated size of adj_entity_handles array
*adj_entity_handles_size Pointer to occupied size of adj_entity_handles array
*err Pointer to error type returned from function

void iMesh_getEntArr2ndAdj ( iMesh_Instance  instance,
iBase_EntityHandle const *  entity_handles,
int  entity_handles_size,
int  bridge_entity_type,
int  requested_entity_type,
iBase_EntityHandle **  adj_entity_handles,
int *  adj_entity_handles_allocated,
int *  adj_entity_handles_size,
int **  offset,
int *  offset_allocated,
int *  offset_size,
int *  err 
)

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.

Note 1: If the "bridge" dimension is the same as the "to" dimension, the output will be empty (and an error code of iBase_INVALID_ARGUMENT returned). If the type of a particular entity matches the "bridge" dimension, there will be no entities returned for that input entity. This is consistent with the definition of adjacencies and the behavior of iMesh first adjacency calls. Note 2: An entity will never be returned as a second adjacency of itself, on the grounds that this is the most likely expectation of applications, and that it is easier for an application to add the original entity to the returned data than to find and remove it.

Parameters:
instance iMesh instance for this call
entity_handles Entities from which adjacencies are requested
entity_handles_size Number of entities whose adjacencies are requested
bridge_entity_type Type of bridge entity for 2nd order adjacencies
requested_entity_type Type of adjacent entities returned
adj_entity_handles Adjacent entities. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
adj_entity_handles_allocated Allocated size of returned array
adj_entity_handles_size Occupied size of returned array
offset Offset[i] is offset into adj_entity_handles of 2nd order adjacencies of ith entity in entity_handles
offset_allocated Allocated size of offset array
offset_size Occupied size of offset array
err 

void iMesh_getEntArrAdj ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const int  entity_type_requested,
iBase_EntityHandle **  adjacentEntityHandles,
int *  adjacentEntityHandles_allocated,
int *  adj_entity_handles_size,
int **  offset,
int *  offset_allocated,
int *  offset_size,
int *  err 
)

Get entities of specified type adjacent to entities.

Get entities of specified type adjacent to entities. Specified type must be value in the iBase_EntityType enumeration. offset(i) is index of first entity in adjacentEntityHandles array adjacent to entity_handles[i].

Parameters:
instance iMesh instance handle
entity_handles Array of entity handles being queried
entity_handles_size Number of entities in entity_handles array
entity_type_requested Type of adjacent entities requested
*adjacentEntityHandles Pointer to array of adjacentEntityHandles returned from function. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
*adjacentEntityHandles_allocated Pointer to allocated size of adjacentEntityHandles array
*adj_entity_handles_size Pointer to occupied size of adjacentEntityHandles array
*offset Pointer to array of offsets returned from function
*offset_allocated Pointer to allocated size of offset array
*offset_size Pointer to occupied size of offset array
*err Pointer to error type returned from function

void iMesh_getEntArrTopo ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
int **  topology,
int *  topology_allocated,
int *  topology_size,
int *  err 
)

Get the entity topology for the specified entities.

Get the entity topology for the specified entities. Topologies returned are values in the iMesh_EntityTopology enumeration.

Parameters:
instance iMesh instance handle
entity_handles Array of entity handles being queried
entity_handles_size Number of entities in entity_handles array
*topology Pointer to array of entity topologies returned from function
*topology_allocated Pointer to allocated size of topology array
*topology_size Pointer to occupied size of topology array
*err Pointer to error type returned from function

void iMesh_getEntArrType ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
int **  type,
int *  type_allocated,
int *  type_size,
int *  err 
)

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.

Parameters:
instance iMesh instance handle
entity_handles Array of entity handles being queried
entity_handles_size Number of entities in entity_handles array
*type Pointer to array of types returned from function
*type_allocated Pointer to allocated size of type array
*type_size Pointer to occupied size of type array
*err Pointer to error type returned from function

void iMesh_getEntities ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  entity_type,
const int  entity_topology,
iBase_EntityHandle **  entity_handles,
int *  entity_handles_allocated,
int *  entity_handles_size,
int *  err 
)

Get entities of specific type and/or topology 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.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being queried
entity_type Type of entities being requested
entity_topology Topology of entities being requested
*entity_handles Pointer to array of entity handles returned from function
*entity_handles_allocated Pointer to allocated size of entity_handles array
*entity_handles_size Pointer to occupied size of entity_handles array
*err Pointer to error type returned from function

void iMesh_getEntSetData ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const iBase_TagHandle  tag_handle,
char **  tag_value,
int *  tag_value_allocated,
int *  tag_value_size,
int *  err 
)

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 is passed back as char* type, but really represents arbitrary data.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set on which tag is being set
tag_handle Tag being set on an entity set
*tag_value Pointer to tag data array being queried
*tag_value_allocated Pointer to tag data array allocated size
*tag_value_size Pointer to tag data array occupied size
*err Pointer to error type returned from function

void iMesh_getEntSetDblData ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
double *  out_data,
int *  err 
)

Get the value of a tag of double type on an entity set.

Get the value of a tag of double type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getEntSetEHData ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
iBase_EntityHandle *  out_data,
int *  err 
)

Get the value of a tag of entity handle type on an entity set.

Get the value of a tag of entity handle type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getEntSetIntData ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
int *  out_data,
int *  err 
)

Get the value of a tag of integer type on an entity set.

Get the value of a tag of integer type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getEntSets ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  num_hops,
iBase_EntitySetHandle **  contained_set_handles,
int *  contained_set_handles_allocated,
int *  contained_set_handles_size,
int *  err 
)

Get the entity sets contained in a set or interface.

Get the entity sets contained in a set or interface. If a set is input which is not the root set, num_hops indicates the maximum number of contained sets from entity_set_handle to one of the contained sets, inclusive of the contained set.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being queried
num_hops Maximum hops from entity_set_handle to contained set, inclusive of the contained set
*contained_set_handles Pointer to array of set handles returned from function
contained_set_handles_allocated Pointer to allocated length of contained_set_handles array
contained_set_handles_size Pointer to occupied length of contained_set_handles array
*err Pointer to error type returned from function

void iMesh_getEntTopo ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
int *  out_topo,
int *  err 
)

Get the entity topology for the specified entity.

Get the entity topology for the specified entity. Topology returned is a value in the iMesh_EntityTopology enumeration.

Parameters:
instance iMesh instance handle
entity_handle Entity handle being queried
*out_topo Pointer to entity topology returned from function
*err Pointer to error type returned from function

void iMesh_getEntType ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
int *  out_type,
int *  err 
)

Get the entity type for the specified entity.

Get the entity type for the specified entity. Type returned is a value in the iBase_EntityType enumeration.

Parameters:
instance iMesh instance handle
entity_handle Entity handle being queried
*out_type Pointer to entity type returned from function
*err Pointer to error type returned from function

void iMesh_getErrorType ( iMesh_Instance  instance,
int *  error_type,
int *  err 
)

Get the error type returned from the last iMesh function.

Get the error type returned from the last iMesh function. Value returned is a member of the iBase_ErrorType enumeration.

Parameters:
instance iMesh instance handle
*error_type Error type returned from last iMesh function
*err Pointer to error type returned from function

void iMesh_getGeometricDimension ( iMesh_Instance  instance,
int *  geom_dim,
int *  err 
)

Get the geometric dimension of mesh represented in this instance.

Get the geometric dimension of mesh represented in this instance

Parameters:
instance iMesh instance handle
geom_dim Pointer to dimension returned from this function
*err Pointer to error type returned from function

void iMesh_getIntArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
int **  tag_values,
int *  tag_values_allocated,
int *  tag_values_size,
int *  err 
)

Get tag values of integer type for an array of entities.

Get tag values of integer type for an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
*tag_values Pointer to tag data array being returned from function. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_allocated Pointer to allocated size of tag data array
tag_values_size Pointer to occupied size of tag data array
*err Pointer to error type returned from function

void iMesh_getIntData ( iMesh_Instance  instance,
const iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
int *  out_data,
int *  err 
)

Get the value of a tag of integer type on an entity.

Get the value of a tag of integer type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
*out_data Pointer to tag value returned from function
*err Pointer to error type returned from function

void iMesh_getNextEntArrIter ( iMesh_Instance  instance,
iMesh_EntityArrIterator  entArr_iterator,
iBase_EntityHandle **  entity_handles,
int *  entity_handles_allocated,
int *  entity_handles_size,
int *  has_data,
int *  err 
)

Get entities contained in array iterator and increment iterator.

Get the entities corresponding to an array iterator (e.g. de-reference the array iterator), and increment the iterator. The de-referenced value(s) are returned in entity_handles. If the iterator is at the end of the iteration, the de-referenced value(s) are undefined and has_data will be returned with a value of zero. Otherwise, has_data will be returned with a non-zero value.

Parameters:
instance iMesh instance handle
entArr_iterator Iterator being queried
*entity_handles Pointer to array of entity handles contained in current value of iterator
*entity_handles_allocated Pointer to allocated size of entity_handles array
*entity_handles_size Pointer to occupied size of entity_handles array
has_data Pointer to a flag indicating if the value(s) returned in entity_handles are valid. A non-zero value indicates the value(s) are valid. A zero value indicates the value(s) are NOT valid.
*err Pointer to error type returned from function

void iMesh_getNextEntIter ( iMesh_Instance  instance,
iMesh_EntityIterator  entity_iterator,
iBase_EntityHandle *  entity_handle,
int *  has_data,
int *  err 
)

Get entity corresponding to an iterator and increment iterator.

Get the entity corresponding to an iterator (that is, de-reference the iterator), and increment the iterator. The de-referenced value is returned in 'entity_handle'. If the iterator is at the end of the iteration, the de-referenced value will be undefined and 'has_data' will have a value of zero. Otherwise, 'has_data' will have a non-zero value.

Parameters:
instance iMesh instance handle
entity_iterator Iterator being queried
entity_handle Pointer to an entity handle corresponding to the current value of iterator just prior to the call.
has_data Pointer to a flag indicating if the value returned in entity_handle is valid. A non-zero value indicates the value is valid. A zero value indicates the value is NOT valid.
*err Pointer to error type returned from function

void iMesh_getNumChld ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
const int  num_hops,
int *  num_child,
int *  err 
)

Get the number of child sets linked from a specified set.

Get the number of child sets linked from a specified set. If num_hops is non-zero, this represents the maximum hops from entity_set to any child in the count.

Parameters:
instance iMesh instance handle
entity_set Entity set being queried
num_hops Maximum hops from entity_set_handle to child set, inclusive of the child set
num_child Pointer to number of children returned from function
*err Pointer to error type returned from function

void iMesh_getNumEntSets ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  num_hops,
int *  num_sets,
int *  err 
)

Get the number of entity sets contained in a set or interface.

Get the number of entity sets contained in a set or interface. If a set is input which is not the root set, num_hops indicates the maximum number of contained sets from entity_set_handle to one of the contained sets, inclusive of the contained set.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being queried
num_hops Maximum hops from entity_set_handle to contained set, inclusive of the contained set
num_sets Pointer to the number of sets returned from function
*err Pointer to error type returned from function

void iMesh_getNumOfTopo ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  entity_topology,
int *  num_topo,
int *  err 
)

Get the number of entities with the specified topology in the instance or set.

Get the number of entities with the specified topology in the instance or set. If entity set handle is root set, return information for instance, otherwise for set. Value of entity topology must be from the iMesh_EntityTopology enumeration. If iMesh_ALL_TOPOLOGIES is specified, total number of entities (excluding entity sets) is returned.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being queried
entity_topology Topology of entity requested
num_topo Pointer to number of entities, returned from function
*err Pointer to error type returned from function

void iMesh_getNumOfType ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  entity_type,
int *  num_type,
int *  err 
)

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 root set, 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.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being queried
entity_type Type of entity requested
num_type Pointer to number of entities, returned from function
*err Pointer to error type returned from function

void iMesh_getNumPrnt ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
const int  num_hops,
int *  num_parent,
int *  err 
)

Get the number of parent sets linked from a specified set.

Get the number of parent sets linked from a specified set. If num_hops is non-zero, this represents the maximum hops from entity_set to any parent in the count.

Parameters:
instance iMesh instance handle
entity_set Entity set being queried
num_hops Maximum hops from entity_set_handle to parent set, inclusive of the parent set
num_parent Pointer to number of parents returned from function
*err Pointer to error type returned from function

void iMesh_getPrnts ( iMesh_Instance  instance,
const iBase_EntitySetHandle  from_entity_set,
const int  num_hops,
iBase_EntitySetHandle **  entity_set_handles,
int *  entity_set_handles_allocated,
int *  entity_set_handles_size,
int *  err 
)

Get the parent sets linked from a specified set.

Get the parent sets linked from a specified set. If num_hops is non-zero, this represents the maximum hops from entity_set to any parent.

Parameters:
instance iMesh instance handle
from_entity_set Entity set being queried
num_hops Maximum hops from entity_set_handle to parent set, inclusive of the parent set
*entity_set_handles Pointer to array of parent sets returned from function
*entity_set_handles_allocated Pointer to allocated size of entity_set_handles array
*entity_set_handles_size Pointer to occupied size of entity_set_handles array
*err Pointer to error type returned from function

void iMesh_getRootSet ( iMesh_Instance  instance,
iBase_EntitySetHandle *  root_set,
int *  err 
)

Get handle of the root set for this instance.

Get handle of the root set for this instance. All mesh in this instance can be accessed from this set.

Parameters:
instance iMesh instance handle
root_set Pointer to set handle returned from function
*err Pointer to error type returned from function

void iMesh_getTagHandle ( iMesh_Instance  instance,
const char *  tag_name,
iBase_TagHandle *  tag_handle,
int *  err,
int  tag_name_len 
)

Get a the handle of an existing tag with the specified name.

Get a the handle of an existing tag with the specified name

Parameters:
instance iMesh instance handle
tag_name Name of tag being queried
tag_handle Pointer to tag handle returned from function
*err Pointer to error type returned from function
tag_name_len Length of tag name string

void iMesh_getTagName ( iMesh_Instance  instance,
const iBase_TagHandle  tag_handle,
char *  name,
int *  err,
int  name_len 
)

Get the name for a given tag handle.

Get the name for a given tag handle

Parameters:
instance iMesh instance handle
tag_handle Tag handle being queried
name Pointer to character string to store name returned from function
*err Pointer to error type returned from function
name_len Length of character string input to function

void iMesh_getTagSizeBytes ( iMesh_Instance  instance,
const iBase_TagHandle  tag_handle,
int *  tag_size,
int *  err 
)

Get size of a tag in units of bytes.

Get size of a tag in units of bytes

Parameters:
instance iMesh instance handle
tag_handle Handle of tag being queried
tag_size Pointer to tag size returned from function
*err Pointer to error type returned from function

void iMesh_getTagSizeValues ( iMesh_Instance  instance,
const iBase_TagHandle  tag_handle,
int *  tag_size,
int *  err 
)

Get size of a tag in units of numbers of tag data type.

Get size of a tag in units of numbers of tag data type

Parameters:
instance iMesh instance handle
tag_handle Handle of tag being queried
tag_size Pointer to tag size returned from function
*err Pointer to error type returned from function

void iMesh_getTagType ( iMesh_Instance  instance,
const iBase_TagHandle  tag_handle,
int *  tag_type,
int *  err 
)

Get the data type of the specified tag handle.

Get the data type of the specified tag handle. Tag type is a value in the iBase_TagType enumeration.

Parameters:
instance iMesh instance handle
tag_handle Handle for the tag being queried
tag_type Pointer to tag type returned from function
*err Pointer to error type returned from function

void iMesh_getVtxArrCoords ( iMesh_Instance  instance,
const iBase_EntityHandle *  vertex_handles,
const int  vertex_handles_size,
int  storage_order,
double **  coords,
int *  coords_allocated,
int *  coords_size,
int *  err 
)

Get coordinates of specified vertices.

Get coordinates of specified vertices. Coordinates are returned in the storage order indicated by the storage_order argument.

Parameters:
instance iMesh instance handle
vertex_handles Array of mesh vertex handles whose coordinates are being requested
vertex_handles_size Number of vertices in vertex_handles array
storage_order Requested storage order of returned coordinates
*coords Pointer to array of coordinates returned from function
*coords_allocated Pointer to allocated size of coords array
*coords_size Pointer to occupied size of coords array
*err Pointer to error type returned from function

void iMesh_getVtxCoord ( iMesh_Instance  instance,
const iBase_EntityHandle  vertex_handle,
double *  x,
double *  y,
double *  z,
int *  err 
)

Get coordinates of specified vertex.

Get coordinates of specified vertex.

Parameters:
instance iMesh instance handle
vertex_handle Mesh vertex being queried
*x Pointer to x coordinate returned from function
*y Pointer to y coordinate returned from function
*z Pointer to z coordinate returned from function
*err Pointer to error type returned from function

void iMesh_initEntArrIter ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  requested_entity_type,
const int  requested_entity_topology,
const int  requested_array_size,
iMesh_EntityArrIterator entArr_iterator,
int *  err 
)

Initialize an array iterator over specified entity type, topology, 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 iMesh_ALL_TOPOLOGIES, respectively. Specified type or topology must be a value in the iBase_EntityType or iMesh_EntityTopology enumerations, respectively.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being iterated
requested_entity_type Type of entity to iterate
requested_entity_topology Topology of entity to iterate
requested_array_size Size of chunks of handles returned for each value of the iterator
entArr_iterator Pointer to iterator returned from function
*err Pointer to error type returned from function

void iMesh_initEntIter ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const int  requested_entity_type,
const int  requested_entity_topology,
iMesh_EntityIterator entity_iterator,
int *  err 
)

Initialize an iterator over specified entity type, topology, and size.

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 iMesh_ALL_TOPOLOGIES, respectively. Specified type or topology must be a value in the iBase_EntityType or iMesh_EntityTopology enumerations, respectively.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being iterated
requested_entity_type Type of entity to iterate
requested_entity_topology Topology of entity to iterate
entity_iterator Pointer to iterator returned from function
*err Pointer to error type returned from function

void iMesh_intersect ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_1,
const iBase_EntitySetHandle  entity_set_2,
iBase_EntitySetHandle *  result_entity_set,
int *  err 
)

Intersect contents of one entity set with another.

Intersect contents of one entity set with another

Parameters:
instance iMesh instance handle
entity_set_1 Entity set being intersected with another
entity_set_2 Entity set being intersected with another
result_entity_set Pointer to entity set returned from function
*err Pointer to error type returned from function

void iMesh_isChildOf ( iMesh_Instance  instance,
const iBase_EntitySetHandle  parent_entity_set,
const iBase_EntitySetHandle  child_entity_set,
int *  is_child,
int *  err 
)

Return whether two sets are related by parent/child links.

Return whether two sets are related (*is_child=1) or not (*is_child=0) by parent/child links

Parameters:
instance iMesh instance handle
parent_entity_set Pointer to parent set
child_entity_set Pointer to child set
is_child Pointer to flag returned from function
*err Pointer to error type returned from function

void iMesh_isEntArrContained ( iMesh_Instance  instance,
iBase_EntitySetHandle  containing_set,
const iBase_EntityHandle *  entity_handles,
int  num_entity_handles,
int **  is_contained,
int *  is_contained_allocated,
int *  is_contained_size,
int *  err 
)

Return whether entities are contained in a set.

Return whether each entity is contained in the set.

Parameters:
instance iMesh instance handle
containing_entity_set Entity set being queried
entity_handles List of entities for which to check containment.
is_contained One value for each input entity, 1 if contained in set, zero otherwise.
*err Pointer to error type returned from function

void iMesh_isEntContained ( iMesh_Instance  instance,
iBase_EntitySetHandle  containing_entity_set,
iBase_EntityHandle  contained_entity,
int *  is_contained,
int *  err 
)

Return whether an entity is contained in another set.

Return whether an entity is contained (*is_contained=1) or not contained (*is_contained=0) in another set

Parameters:
instance iMesh instance handle
containing_entity_set Entity set being queried
contained_entity Entity potentially contained in containing_entity_set
is_contained Pointer to flag returned from function
*err Pointer to error type returned from function

void iMesh_isEntSetContained ( iMesh_Instance  instance,
const iBase_EntitySetHandle  containing_entity_set,
const iBase_EntitySetHandle  contained_entity_set,
int *  is_contained,
int *  err 
)

Return whether an entity set is contained in another set.

Return whether a set is contained (*is_contained=1) or not contained (*is_contained=0) in another set

Parameters:
instance iMesh instance handle
containing_entity_set Entity set being queried
contained_entity_set Entity set potentially contained in containing_entity_set
is_contained Pointer to flag returned from function
*err Pointer to error type returned from function

void iMesh_isList ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set,
int *  is_list,
int *  err 
)

Return whether a specified set is ordered or unordered.

Return whether a specified set is ordered (*is_list=1) or unordered (*is_list=0)

Parameters:
instance iMesh instance handle
entity_set Entity set being queried
is_list Pointer to flag returned from function
*err Pointer to error type returned from function

void iMesh_load ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const char *  name,
const char *  options,
int *  err,
int  name_len,
int  options_len 
)

Load a mesh from a file.

Load a mesh from a file. If entity set is specified, loaded mesh is added to that set; specify root set if that is not desired.

Parameters:
instance iMesh instance handle
entity_set_handle Set to which loaded mesh will be added, root set if not desired
name File name from which mesh is to be loaded
options Pointer to implementation-specific options string
*err Pointer to error type returned from function
name_len Length of the file name character string
options_len Length of the options character string

void iMesh_newMesh ( const char *  options,
iMesh_Instance instance,
int *  err,
int  options_len 
)

Construct a new iMesh instance.

Construct a new iMesh instance, using implementation-specific options

Parameters:
options Pointer to implementation-specific options string
instance Pointer to iMesh instance handle returned from function
*err Pointer to error type returned from function
options_len Length of the character string pointed to by options

void iMesh_resetEntArrIter ( iMesh_Instance  instance,
iMesh_EntityArrIterator  entArr_iterator,
int *  err 
)

Reset the array iterator.

Reset the array iterator

Parameters:
instance iMesh instance handle
entArr_iterator Iterator to reset
*err Pointer to error type returned from function

void iMesh_resetEntIter ( iMesh_Instance  instance,
iMesh_EntityIterator  entity_iterator,
int *  err 
)

Reset the iterator.

Reset the iterator

Parameters:
instance iMesh instance handle
entity_iterator Iterator to reset
*err Pointer to error type returned from function

void iMesh_rmvArrTag ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
int *  err 
)

Remove a tag value from an array of entities.

Remove a tag value from an array of entities

Parameters:
instance iMesh instance handle
entity_handles Entity from which tag is being removed
entity_handles_size Number of entities in entity array
tag_handle Tag handle of tag being removed
*err Pointer to error type returned from function

void iMesh_rmvEntArrFromSet ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
int  entity_handles_size,
iBase_EntitySetHandle  entity_set,
int *  err 
)

Remove an array of entities from a set.

Remove an array of entities from a set

Parameters:
instance iMesh instance handle
entity_handles Array of entities being remove
entity_handles_size Number of entities in entity_handles array
entity_set Pointer to the set being removed from
*err Pointer to error type returned from function

void iMesh_rmvEntFromSet ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
iBase_EntitySetHandle  entity_set,
int *  err 
)

Remove an entity from a set.

Remove an entity from a set

Parameters:
instance iMesh instance handle
entity_handle The entity being removed
entity_set Pointer to the set being removed from
*err Pointer to error type returned from function

void iMesh_rmvEntSet ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set_to_remove,
iBase_EntitySetHandle  entity_set_handle,
int *  err 
)

Remove an entity set from a set.

Remove an entity set from a set

Parameters:
instance iMesh instance handle
entity_set_to_remove The entity set being removed
entity_set_handle Pointer to the set being removed from
*err Pointer to error type returned from function

void iMesh_rmvEntSetTag ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set_handle,
const iBase_TagHandle  tag_handle,
int *  err 
)

Remove a tag value from an entity set.

Remove a tag value from an entity set

Parameters:
instance iMesh instance handle
entity_set_handle Entity set from which tag is being removed
tag_handle Tag handle of tag being removed
*err Pointer to error type returned from function

void iMesh_rmvPrntChld ( iMesh_Instance  instance,
iBase_EntitySetHandle  parent_entity_set,
iBase_EntitySetHandle  child_entity_set,
int *  err 
)

Remove parent/child links between two sets.

Remove parent/child links between two sets.

Parameters:
instance iMesh instance handle
parent_entity_set Pointer to parent set
child_entity_set Pointer to child set
*err Pointer to error type returned from function

void iMesh_rmvTag ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
int *  err 
)

Remove a tag value from an entity.

Remove a tag value from an entity

Parameters:
instance iMesh instance handle
entity_handle Entity from which tag is being removed
tag_handle Tag handle of tag being removed
*err Pointer to error type returned from function

void iMesh_save ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_handle,
const char *  name,
const char *  options,
int *  err,
const int  name_len,
int  options_len 
)

Save a mesh to a file.

Save a mesh to a file. If entity set is specified, save only the mesh contained in that set.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set being saved
name File name to which mesh is to be saved
options Pointer to implementation-specific options string
*err Pointer to error type returned from function
name_len Length of the file name character string
options_len Length of the options character string

void iMesh_setArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
const char *  tag_values,
const int  tag_values_size,
int *  err 
)

Set tag values of arbitrary type on an array of entities.

Set tag values of arbitrary type on an array of entities. Tag data is passed as char* type, but really represents pointer to arbitrary data.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
tag_values Pointer to tag data being set on entity. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_size Size in total bytes of tag data
*err Pointer to error type returned from function

void iMesh_setData ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
const char *  tag_value,
const int  tag_value_size,
int *  err 
)

Set a tag value of arbitrary type on an entity.

Set a tag value of arbitrary type on an entity. Tag data is passed as char* type, but really represents pointer to arbitrary data.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
tag_value Pointer to tag data being set on entity
tag_value_size Size in bytes of tag data
*err Pointer to error type returned from function

void iMesh_setDblArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
const double *  tag_values,
const int  tag_values_size,
int *  err 
)

Set tag values of double type on an array of entities.

Set tag values of double type on an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
tag_values Pointer to tag data being set on entities. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_size Size in total number of doubles of tag data
*err Pointer to error type returned from function

void iMesh_setDblData ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
const double  tag_value,
int *  err 
)

Set a tag value of double type on an entity.

Set a tag value of double type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
tag_value Tag value being set on entity
*err Pointer to error type returned from function

void iMesh_setEHArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
const iBase_EntityHandle *  tag_values,
const int  tag_values_size,
int *  err 
)

Set tag values of entity handle type on an array of entities.

Set tag values of entity handle type on an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
tag_values Pointer to tag data being set on entities. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_size Size in total number of entity handles of tag data
*err Pointer to error type returned from function

void iMesh_setEHData ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
const iBase_EntityHandle  tag_value,
int *  err 
)

Set a tag value of entity handle type on an entity.

Set a tag value of entity handle type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
tag_value Tag value being set on entity
*err Pointer to error type returned from function

void iMesh_setEntSetData ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set_handle,
const iBase_TagHandle  tag_handle,
const char *  tag_value,
const int  tag_value_size,
int *  err 
)

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 passed as char* type, but really represents pointer to arbitrary data.

Parameters:
instance iMesh instance handle
entity_set_handle Entity set on which tag is being set
tag_handle Tag being set on an entity set
tag_value Pointer to tag data being set on entity set
tag_value_size Size in bytes of tag data
*err Pointer to error type returned from function

void iMesh_setEntSetDblData ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
const double  tag_value,
int *  err 
)

Set a tag value of double type on an entity set.

Set a tag value of double type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
tag_value Tag value being set on entity set
*err Pointer to error type returned from function

void iMesh_setEntSetEHData ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
const iBase_EntityHandle  tag_value,
int *  err 
)

Set a tag value of entity handle type on an entity set.

Set a tag value of entity handle type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
tag_value Tag value being set on entity set
*err Pointer to error type returned from function

void iMesh_setEntSetIntData ( iMesh_Instance  instance,
iBase_EntitySetHandle  entity_set,
const iBase_TagHandle  tag_handle,
const int  tag_value,
int *  err 
)

Set a tag value of integer type on an entity set.

Set a tag value of integer type on an entity set.

Parameters:
instance iMesh instance handle
entity_set Entity set on which tag is being set
tag_handle Tag being set on an entity set
tag_value Tag value being set on entity set
*err Pointer to error type returned from function

void iMesh_setGeometricDimension ( iMesh_Instance  instance,
int  geom_dim,
int *  err 
)

Set geometric dimension of vertex coordinates.

Set the geometric dimension of the mesh. Notes: An application should not expect this function to succeed unless the mesh database is empty (no vertices created, no files read, etc.)

Parameters:
instance Mesh database from which to request change.
geom_dim Requested geometric dimension.

void iMesh_setIntArrData ( iMesh_Instance  instance,
const iBase_EntityHandle *  entity_handles,
const int  entity_handles_size,
const iBase_TagHandle  tag_handle,
const int *  tag_values,
const int  tag_values_size,
int *  err 
)

Set tag values of integer type on an array of entities.

Set tag values of integer type on an array of entities.

Parameters:
instance iMesh instance handle
entity_handles Entity array on which tag is being set
entity_handles_size Number of entities in array
tag_handle Tag being set on an entity
tag_values Pointer to tag data being set on entities. Note that the implicit INTERLEAVED storage order rule applies (see section ITAPS Storage Orders)
tag_values_size Size in total number of integers of tag data
*err Pointer to error type returned from function

void iMesh_setIntData ( iMesh_Instance  instance,
iBase_EntityHandle  entity_handle,
const iBase_TagHandle  tag_handle,
const int  tag_value,
int *  err 
)

Set a tag value of integer type on an entity.

Set a tag value of integer type on an entity.

Parameters:
instance iMesh instance handle
entity_handle Entity on which tag is being set
tag_handle Tag being set on an entity
tag_value Tag value being set on entity
*err Pointer to error type returned from function

void iMesh_setVtxArrCoords ( iMesh_Instance  instance,
const iBase_EntityHandle *  vertex_handles,
const int  vertex_handles_size,
const int  storage_order,
const double *  new_coords,
const int  new_coords_size,
int *  err 
)

Set coordinates for an array of vertices.

Set coordinates for an array of vertices. Specified storage order must be either iBase_INTERLEAVED or iBase_BLOCKED, and indicates order of x, y, and z coordinates in coordinate array.

Parameters:
instance iMesh instance handle
vertex_handles Array of vertex handles
vertex_handles_size Number of vertex handles in array
storage_order Storage order of coordinates in coordinate array
new_coords Coordinate array
new_coords_size Size of coordinate array; should be 3*vertex_handles_size
*err Pointer to error type returned from function

void iMesh_setVtxCoord ( iMesh_Instance  instance,
iBase_EntityHandle  vertex_handle,
const double  x,
const double  y,
const double  z,
int *  err 
)

Set coordinates for a vertex.

Set coordinates for a vertex.

Parameters:
instance iMesh instance handle
vertex_handle vertex handle being set
x x coordinate being set
y y coordinate being set
z z coordinate being set
*err Pointer to error type returned from function

void iMesh_subtract ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_1,
const iBase_EntitySetHandle  entity_set_2,
iBase_EntitySetHandle *  result_entity_set,
int *  err 
)

Subtract contents of one entity set from another.

Subtract contents of one entity set from another

Parameters:
instance iMesh instance handle
entity_set_1 Entity set from which other set is being subtracted
entity_set_2 Entity set being subtracted from other set
result_entity_set Pointer to entity set returned from function
*err Pointer to error type returned from function

void iMesh_unite ( iMesh_Instance  instance,
const iBase_EntitySetHandle  entity_set_1,
const iBase_EntitySetHandle  entity_set_2,
iBase_EntitySetHandle *  result_entity_set,
int *  err 
)

Unite contents of one entity set with another.

Unite contents of one entity set with another

Parameters:
instance iMesh instance handle
entity_set_1 Entity set being united with another
entity_set_2 Entity set being united with another
result_entity_set Pointer to entity set returned from function
*err Pointer to error type returned from function


Generated on Tue Apr 14 13:14:54 2009 for iMesh by  doxygen 1.5.7