Description

Detailed Description

Groups

 COLOR
 
 COLORA
 
 CUSTOMGUI
 
 DESC
 
 DTYPE
 
 VECTOR
 
 VECTOR4D
 

Classes

struct  DescLevel
 
class  DescID
 
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
 

Macros

#define DESCID_ROOT
 
#define ID_USERDATA
 
#define DESCID_DYNAMICSUB
 
#define BOOL_PAGEMODE
 
#define VECTOR_NO_Z_COMPONENT
 
#define CUSTOMDATATYPE_DESCID
 
#define HandleDescGetVector(tid, vector, t_data, flags)
 
#define HandleDescSetVector(v, tid, vector, t_data, flags)
 

Functions

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.

◆ 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

◆ Description_Register()

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

Internal. Use RegisterDescription() instead.