Open Search
    Description

    Detailed Description

    Groups

     COLOR
     
     COLORA
     
     CUSTOMGUI
     
     DESC
     
     DTYPE
     
     VECTOR
     
     VECTOR4D
     

    Classes

    struct  DescLevel
     
    class  DescID
     
    class  ConstDescIDMem< T >
     
    class  Description
     
    class  DynamicDescription
     
    struct  DescriptionBaseMessage
     
    struct  DescriptionCommand
     
    struct  DescriptionPopup
     
    struct  DescriptionCheckDragAndDrop
     
    struct  DescriptionInExDeleted
     
    struct  DescriptionInExAdded
     
    struct  DescriptionInExSelChanged
     
    struct  DescriptionCustomGuiNotification
     
    struct  DescriptionGetBitmap
     
    struct  DescriptionGetObjects
     
    struct  DescriptionAllowOverride
     
    struct  DescriptionTakeChanged
     
    struct  DescriptionImExportVerifySuffix
     
    struct  DescriptionImExportVerifyFilename
     

    Macros

    #define DESCID_ROOT
     
    #define ID_USERDATA
     
    #define DESCID_DYNAMICSUB
     
    #define BOOL_PAGEMODE
     
    #define VECTOR_NO_Z_COMPONENT
     
    #define CUSTOMDATATYPE_DESCID
     
    #define YDescLevel(A, B, C, ...)
     
    #define XDescLevel(...)
     
    #define AddDescX(t, i, a)
     
    #define ConstDescID(...)
     
    #define CreateDescID(...)
     
    #define HandleDescGetVector(tid, vector, t_data, flags)
     
    #define HandleDescSetVector(v, tid, vector, t_data, flags)
     

    Functions

    DescriptionLib * CheckDescriptionLib (Int32 offset)
     
    Bool Description_Register (Int32 id, const String &idstr, LocalResource *res)
     

    Macro Definition Documentation

    ◆ DESCID_ROOT

    #define DESCID_ROOT

    Root description ID.

    ◆ ID_USERDATA

    #define ID_USERDATA

    User data ID.

    ◆ DESCID_DYNAMICSUB

    #define DESCID_DYNAMICSUB

    User data/dynamic parameters description level.

    ◆ BOOL_PAGEMODE

    #define BOOL_PAGEMODE

    Page mode for boolean elements. If set it means that this boolean will have no checkbox. (Used for the Material Editor navigation.)

    ◆ VECTOR_NO_Z_COMPONENT

    #define VECTOR_NO_Z_COMPONENT

    Private. Restricts the displayed vector to two instead of three components.

    ◆ CUSTOMDATATYPE_DESCID

    #define CUSTOMDATATYPE_DESCID

    DescID custom data type ID.

    ◆ YDescLevel

    #define YDescLevel (   A,
      B,
      C,
      ... 
    )

    ◆ XDescLevel

    #define XDescLevel (   ...)

    ◆ AddDescX

    #define AddDescX (   t,
      i,
     
    )

    ◆ ConstDescID

    #define ConstDescID (   ...)

    ◆ CreateDescID

    #define CreateDescID (   ...)

    ◆ HandleDescGetVector

    #define HandleDescGetVector (   tid,
      vector,
      t_data,
      flags 
    )

    Macro that handles GetParameter() calls for Vector. (For an example of usage see datatype.cpp SDK example.)

    ◆ HandleDescSetVector

    #define HandleDescSetVector (   v,
      tid,
      vector,
      t_data,
      flags 
    )

    Macro that handles SetParameter() calls for Vector. (For an example of usage see datatype.cpp SDK example.)

    Function Documentation

    ◆ CheckDescriptionLib()

    DescriptionLib* CheckDescriptionLib ( Int32  offset)

    ◆ Description_Register()

    Bool Description_Register ( Int32  id,
    const String idstr,
    LocalResource *  res 
    )

    Internal. Use RegisterDescription() instead.