MKI_ClipInsert (Entity Creation) Changed in Version 2024.1

C++ Syntax

MKI_ENTITY_CLIP_PTR

MKI_ClipInsert(

 MKI_CONST_ENTITY_PTR f_pRefEntity );

Inserts the most recently opened clipping surface (see MKI_ClipOpen) to a memory list. If no further clipping surface and no provisional extended object, group, or block is currently open, the clipping surface is inserted to the main memory list of the drawing behind the object pointed to by RefEntity. If RefEntity is nullptr, the clipping surface is appended at the end.

If a further clipping surface, a provisional extended object, group, or block is currently open (in that order), the clipping surface is appended to that entity. RefEntity is ignored in this case.

In most cases, you can use MKI_ClipFastInsert instead of this procedure to speed up execution and to reduce code size. See the description of that procedure for details.

Parameters

RefEntity

[MKI_CONST_ENTITY_PTR] Address of a reference entity behind which the clipping surface shall be inserted. If RefEntity is nullptr, the clipping surface is appended at the end.

Return Value

Returns the address of the inserted clipping surface. Returns nullptr if the insertion was not successful, normally due to insufficient memory.