API_​Neig

Describes a neig point of an element.

    typedef struct {
        API_NeigID             neigID;
        Int32                  filler_1;
        API_Guid               guid;
        Int32                  inIndex;
        Int32                  flags;
        API_NeigElemPartID     elemPartType;
        UInt32                 elemPartIndex;
        Int32                  subType;
        Int32                  nodeType;
        UInt32                 supplUnId;
    } API_Neig;

 

Members

neigID
Type of the element neig. It also defines the type of the element; you can convert the neigID to API_ElemTypeID with the APIAny_NeigIDToElemTypeID function.
guid Changed in API 12
Guid of the element.
inIndex
Subindex inside the element.
flags
Flags of the neig:

Value

Description

API_NeigFlg_Normal

Normal neig.

API_NeigFlg_HoleSel

The neig is part of a hole.

API_NeigFlg_Extra3D

The neig appears only in 3D.

API_NeigFlg_Ghost

The neig is for an element coming from the ghost story.

API_NeigFlg_Surface API 18

The neig refers to a surface of an element (e.g. Morph face).

elemPartType API 18
Type of the element part in case of partial selection (currently available with Morph only):

Value

Description

APINeigElemPart_None

The whole element is selected.

APINeigElemPart_Edge

An edge of the element is selected.

APINeigElemPart_Vertex

A vertex of the element is selected.

APINeigElemPart_Face

A face of the element is selected.

APINeigElemPart_SubelemAPI 21

A subelement is selected.

elemPartIndex API 18
Index of the element part (edge, vertex, face) partially selected.
subType New in API 22
.
nodeType New in API 22
.
supplUnId New in API 22
.

 

Remarks

This structure is used in requiring the current element selection (ACAPI_Selection_Get), selecting elements or element parts (ACAPI_Element_Select), and getting user input (APIIo_GetPointID, etc.).

 

Requirements

Version: API 2.1 or later
Header: APIdefs_Elements.h

 

See Also

API_NeigID, API_Guid, API_DimElem, API Types