C++ Syntax

MKI_ENTITY_PTR

MKI_ENTITY_ENUM::Reset(

MKI_CONST_ENTITY_PTR f_pEntity,

__int32 f_nFlag1,

__int32 f_nFlag2,

bool f_fValid,

__int32 f_nEnumMode = MKI_ENTITYENUM_TOP );

Resets the enumeration to a specified entity and sets its parameters anew.

Parameters

f_pEntity

[MKI_CONST_ENTITY_PTR] Address of the entity to which the enumeration shall be reset.

f_pFlag1

f_pFlag2

[__int32] Two flag combinations used to filter special entities for the enumeration. The enumeration will only include entities where the following boolean expression is true:

( (Entity->Header.Flag & f_nFlag1 ) == f_nFlag2 )

Both values can be a bit-wise OR combination of MKI_FLAG_* flags. Typical combinations of f_nFlag1 and f_nFlag2 are:

f_nFlag1 = MKI_FLAG_SELECT, f_nFlag2 = MKI_FLAG_SELECT

Enumerate only permanently selected entities.

f_nFlag1 = MKI_FLAG_USE, f_nFlag2 = MKI_FLAG_USE

Enumerate only identified entities.

f_nFlag1 = MKI_FLAG_USE | MKI_FLAG_LOCKED | MKI_FLAG_NODISPLAY, f_nFlag2 = MKI_FLAG_USE

Enumerate only identified entities that are neither invisible nor locked.

f_fValid

[bool] If true, only entities that are currently "valid" according to the current undo state are enumerated. If false, all entities in memory will be enumerated, even if they are currently marked as "deleted".

f_nEnumMode

[__int32] The enumeration mode defines how possible groups shall be parsed, see MKI_ENTITYENUM_*.

Return Value

Returns the address of the current entity in the enumeration (f_pEntity), or nullptr in case of an error.