HM_Face

Syntax

struct HM_Face {
int size;
int error_status;
HM_EntityTopology mapped_hm_topo;
int num_loops;
int num_points;
int* loops;
int* points;
double mesh_size;
int component;
int local_batchparamset_num;
};

Type

HyperMesh Ext API

Description

This structure contains information about an individual face in the topology of mesh areas defined by the HM_Topology structure.

The structure information is declared in hm_extapi.h.

The members are: size, error_status, num_loops, num_points, loops, points, mesh_size, component, and local_batchparamset_num

Inputs

size: Specifies the length, in bytes, of the structure. Use sizeof(HM_Face) for this member. This is used to distinguish the current version of HM_Face from possible future extended versions with additional members.
error_status: Used by API functions to return an error status. A value of zero indicates successful completion of a function using this structure.
mapped_hm_topo: Some API functions will use this member to return a handle to an edge entity corresponding to the edge specified by the HM_Face structure. On input, set to zero. The function HM_ExtAPI::GenerateMesh() does not use this member to return any values.
num_loops: The total number of face loops defining the face specified by this HM_Face structure.
num_points: The total number of internal fixed points, not connected to any edges, within the face specified by this HM_Face structure.
loops: Pointer to an array of face loop references. The number of values in the array must not be smaller than the value specified by the num_loops member of this HM_Face structure.; Each number in the array pointed to by loops represents a zero-based index in the array of the HM_FaceLoop structures pointed to by the loops member of the HM_Topology structure that contains this HM_Face structure in its faces array.
points: Pointer to an array of internal fixed point references. The number of values in the array must not be smaller than the value specified by the num_points member of this HM_Face structure. If num_points is zero then the points member is not used and should be set to NULL.; Each number in the array pointed to by points represents a zero-based index in the array of HM_Vertex structures pointed to by the vertices member of the HM_Topology structure that contains this HM_Face structure in its faces array.
mesh_size (optional): Set individual mesh size for the face specified by this HM_Face structure. Set to positive value in order for individual mesh size to be used for this face. Set to -1 to have the mesh size the same as the value specified by global mesh size parameter.
component: A reference to the HM_Component structure of the component comprising the face.; It represents a zero-based index of the component structure in the components array of the HM_Topology structure that contains this HM_Face structure.
local_batchparamset_num (optional): Reference to an individual batch mesh parameter/criteria file set for meshing of the face in the batch mesh mode. Assign it as a positive number to specify a local batch mesh parameter set using the number of the set in the HM_GenerateMeshParamStruct local_batchparamsets array (zero-based index of the set in the array local_batchparamsets incremented by 1). Assign it as 0 to specify explicit batch meshing of the face with the global parameter and criteria files from HM_GenerateMeshParamStruct. Assign it as -1 to use the batch mesh parameter and criteria set specified for the topology component HM_Component comprising the face.

Errors

None.