Mesh Modification

Collaboration diagram for Mesh Modification:

Functions
void	iMesh_optimize (iMesh_Instance instance, int *handles_invalidated, int *err)
	Permit implementation to 'optimize' the mesh instance.

---

Function Documentation

void iMesh_optimize	(	iMesh_Instance	instance,
		int *	handles_invalidated,
		int *	err
	)

Permit implementation to 'optimize' the mesh instance.

Its concievable that after a series of operations modifying the mesh instance, the implementation's internal representation of the mesh may include data and tie up memory resources that could be 'optimized' away. For example, if the implementation only marks removed entities for deletion but does not actually free up memory resources associated those entities, a call to this function gives the implementation the 'ok' to go ahead and free up such memory.

Depending on the implementation as well as the amount and kind of changes to the mesh that have been made prior to calling it, this call may be very expensive in time complexity. On the other hand, it is also perfectly acceptable that an implementation basically treat this operation as a no-op.

In any event, any entity, entity set, iterator or tag handle obtained prior to calling this method will may be invalidated as a result of this call. In that case, the caller must re-acquire handles after making this call. A return argument indicates if handles have been invalidated.

Parameters:

[in]	instance	iMesh instance handle
[out]	handles_invalidated	Returned flag indicating if any handles the caller held before calling this function have been invalidated as a result of this call. A value of non-zero returned here indicates that any handles the caller had prior to this call must not be trusted and must be re-acquired by caller.
[out]	err	Returned Error status (see iBase_ErrorType)

Definition at line 460 of file iMesh_MOAB.cpp.

References iBase_SUCCESS, and RETURN.

  {
    // TODO: implement this for real
    *handles_invalidated = 0;
    RETURN(iBase_SUCCESS);
  }