MKI_ENTITY_HEADER (Entity Classes) Changed in Version 2018.0

C++ Syntax

class MKI_ENTITY_HEADER

{

  public:

  MKI_RECT m_cRect;

  __int32 m_nIdent,

          m_nFlag,

          m_nUndo1,

          m_nUndo2,

          m_nReserved1,

          m_nReserved2;

  MKI_ENTITY_PTR m_pLinkFirst,

               m_pLinkLast,

               m_pDataFirst,

               m_pDataLast;

  __int32 m_nEntityOwner,

          m_nEntityType,

  MKI_UNIQUE_ID m_cUniqueID;

  __int32 m_nEntityMode;

  __int16 m_nPlugInNum;

  unsigned __int16 m_fDataValid :1,

                   m_fFrameValid:1,

                   m_fNotFound  :1,

                   m_afUnused   :13;

};

This structure contains basic application-related information about an entity.

Element Description

Rect

[MKI_RECT] Surrounding frame of the entity. This value must not be modified!

Ident

[__int32] Identification index. This value must not be modified!

Flag

[__int32] Bit-wise OR combination of some general flags indicating the state of the entity (see MKI_FLAG_*). This value must not be modified!

Undo1

Undo2

[__int32] Undo time interval inside which the entity is valid, based on the internal undo count. These values must not be modified!

Reserved1 New in Version 6.0

Reserved2

[__int32] Additional internal caching information, usually both zero. These values must not be modified!

LinkFirst

LinkLast

[MKI_ENTITY_PTR] Address of the first and last entity in the sub-entity link-list ("link list" or "display list") of this entity (nullptr if none). This value must not be modified!

DataFirst New in Version 6.50

DataLast

[MKI_ENTITY_PTR] Address of the first and last entity in the sub-entity data-list ("extended data") of this entity (nullptr if none). Currently only used within extended objects. This value must not be modified!

EntityOwner

[__int32] 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).

EntityType

[__int32] Specifies the type of the entity (see MKI_ENTITYTYPE_*). Must always be set to the correct value!

UniqueID New in Version 6.04

[MKI_UNIQUE_ID] Unique identifier of the entity. This value may contain either a valid UUID (Universally Unique Identifier) or all 0 if unused.

EntityMode New in Version 2018.0

[__int32] General flags affecting the entity (see MKI_ENTITYMODE_*).

PlugInNum New in Version 6.40

[__int16] Internal index of the plug-in that is responsible for this entity. This value must not be modified!

DataValid New in Version 6.40

[__int16:1] Indicates if the temporary data has already been initialized. This value must not be modified!

FrameValid New in Version 6.40

[__int16:1] Indicates if the surrounding frame has already been recalculated. This value must not be modified!

NotFound New in Version 6.40

[__int16:1] Indicates if the contained link could not be resolved. This value must not be modified!

Unused New in Version 6.40

[__int16:13] Reserved for future use. This value must not be modified!

MKD Syntax

Flag,EntityOwner,EntityType,EntityMode,UniqueID

Element Description

Flag New in Version 6.0

[__int32] A flag indicating whether the following entity is secured or not. If this value is non-zero (indicating a secured entity), two more values will follow and you will not be able to read or interpret the entity’s header. In this case, terminate reading the file.

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).

EntityType

[__int16] Specifies the type of the entity (see MKI_ENTITYTYPE_*).

EntityMode New in Version 2018.0

[__int32] General flags affecting the entity (see MKI_ENTITYMODE_*).

UniqueID New in Version 6.04

[MKI_UNIQUE_ID] Unique identifier of the entity. This value may contain either a valid UUID (Universally Unique Identifier) in binary notation or all 0 in binary notation if unused.