C++ Syntax

class MKI_ENTITY_CLIP : public MKI_ENTITY_BASE

{

public:

MKI_XPROPERTY m_cXProperty;

MKI_MATRIX m_cDisplayMatrix;

__int32 m_nDisplayMode;

MKI_HIDELAYERS m_afHideLayers;

char m_pData[];

};

This structure describes an entity of type MKI_ENTITYTYPE_CLIP, i.e. a clipping surface. Header.EntityType must be MKI_ENTITYTYPE_CLIP (3).

Element Description

XProperty

[MKI_XPROPERTY] Properties of the display data including transmission. If the filling mode is either MKI_FILLMODE_FILLED or MKI_FILLMODE_FILLED_FRAMED, the clipping will display all object inside the path, if the filling mode is MKI_FILLMODE_ERASER or MKI_FILLMODE_ERASER_FRAMED, it will display all objects outside the path.

DisplayMatrix

[MKI_MATRIX] Display matrix of the display data. All entities stored in the display data have to be multiplied with this matrix before display. It contains translation, rotation, scaling and distortion.

DisplayMode

[__int32] Bit-wise OR combination of some flags indicating the display mode for clipping surfaces. Possible values are (see MKI_DISPLAYMODE_*):

MKI_DISPLAYMODE_DEFAULT

MKI_DISPLAYMODE_SCALED_WIDTH

MKI_DISPLAYMODE_NOPOINTS

MKI_DISPLAYMODE_NOSNAP

MKI_DISPLAYMODE_SCALED_LENGTH

MKI_DISPLAYMODE_NO_SMOOTHING New in Version 2015.2

MKI_DISPLAYMODE_NOHIDE New in Version 2021.1

HideLayers New in Version 6.50

[MKI_HIDELAYERS] This array contains one bit for each layer indicating if the layer shall be output or not.

Data

[char[]] This data section contains a list of data blocks (see Data Blocks). The sequence of data blocks stored here is identical to those stored in an object of type "Surface", see Object 13 "Surface".

Attributes New in Version 2021.0

A clipping surface may contain attribute data blocks (see MKI_BLOCK_ATTRIBUTE) of type "local", "outline", and "point". For details, see Object 13 "Surface". Attributes of types "global" must not exist. The total number of attributes per clipping surface is limited to MKI_ATTRIBS_PER_OBJECT.

MKD Syntax

This entity represents a clipping surface, i.e. an entity that contains a clipping path and a list of objects to be clipped. An entity of type "Clipping Surface" has the following structure:

0,EntityOwner,3,UniqueID,XProperty,

DisplayMatrix,DisplayMode,

HideLayers;

-Data Block List-

,999,0,0;

-Entity Link List-

,,999,,"";

If HideLayers is completely zero, it may be omitted.

Element Description

EntityOwner

[__int16] This value is a unique identification of the plug-in that created the entity. The value MKI_DB_OWNER_MK is reserved for use by Malz++Kassner, especially for objects and data blocks that are created and handled directly by the application. Valid range: 0 <= Value < 10000.

Third-party vendors that plan to implement a plug-in should contact Malz++Kassner to receive their unique identification (see Getting Your Private Owner ID).

-Data Block List-

The data block list contains a list of data blocks (see Data Blocks). Clipping surfaces contain many different kinds of data blocks including local, outline, and point attributes.

-Entity Link List-

The entity link list contains the extended object's sub-entity link-list ("link data") as defined by Header.LinkFirst and Header.LinkLast. Currently, this list is usually empty (except for maybe entities of extended object's link lists).