Detailed Description

IDs into the information container for a description parameter.

Enumerations

enum  DESC {
  DESC_NAME,
  DESC_SHORT_NAME,
  DESC_VERSION,
  DESC_VERSION_DEMO,
  DESC_VERSION_XL,
  DESC_VERSION_ALL,
  DESC_CHILDREN,
  DESC_MIN,
  DESC_MAX,
  DESC_MINEX,
  DESC_MAXEX,
  DESC_STEP,
  DESC_ANIMATE,
  DESC_ANIMATE_OFF,
  DESC_ANIMATE_ON,
  DESC_ANIMATE_MIX,
  DESC_ASKOBJECT,
  DESC_UNIT,
  DESC_UNIT_FLOAT,
  DESC_UNIT_INT,
  DESC_UNIT_PERCENT,
  DESC_UNIT_DEGREE,
  DESC_UNIT_METER,
  DESC_UNIT_TIME,
  DESC_PARENTGROUP,
  DESC_CYCLE,
  DESC_HIDE,
  DESC_DEFAULT,
  DESC_ACCEPT,
  DESC_SEPARATORLINE,
  DESC_REFUSE,
  DESC_PARENTID,
  DESC_CUSTOMGUI,
  DESC_COLUMNS,
  DESC_LAYOUTGROUP,
  DESC_REMOVEABLE,
  DESC_GUIOPEN,
  DESC_EDITABLE,
  DESC_MINSLIDER,
  DESC_MAXSLIDER,
  DESC_GROUPSCALEV,
  DESC_SCALEH,
  DESC_LAYOUTVERSION,
  DESC_ALIGNLEFT,
  DESC_FITH,
  DESC_NEWLINE,
  DESC_TITLEBAR,
  DESC_CYCLEICONS,
  DESC_CYCLESYMBOLS,
  DESC_PARENT_COLLAPSE,
  DESC_FORBID_INLINE_FOLDING,
  DESC_FORBID_SCALING,
  DESC_ANGULAR_XYZ,
  DESC_INPORT,
  DESC_OUTPORT,
  DESC_STATICPORT,
  DESC_NEEDCONNECTION,
  DESC_MULTIPLE,
  DESC_PORTONLY,
  DESC_CREATEPORT,
  DESC_PORTSMIN,
  DESC_PORTSMAX,
  DESC_NOTMOVABLE,
  DESC_EDITPORT,
  DESC_ITERATOR,
  DESC_PARENTMSG,
  DESC_MATEDNOTEXT,
  DESC_COLUMNSMATED,
  DESC_SHADERLINKFLAG,
  DESC_NOGUISWITCH,
  DESC_COLORALWAYSLINEAR,
  DESC_HIDE_WHEN_INLINE,
  DESC_MATERIALEDITOR_LEFTSIDE,
  DESC_CHANGED,
  DESC_HIDEINFIELDS,
  DESC_SHOWINFIELDS,
  DESC_FIELDCOLORCHANNEL,
  DESC_FIELDDIRECTIONCHANNEL,
  DESC_FIELDVALUECHANNEL,
  DESC_FIELDROTATIONCHANNEL,
  DESC_NODEPORT,
  DESC_NODEISLINKEDPORT,
  DESC_REPLACECOMPLEXUI,
  DESC_REPLACE_HIDE,
  DESC_RESOURCEPATH,
  DESC_RESOURCELINE,
  DESC_TEMPDESCID,
  DESC_IDENT,
  DESC_IDENT_ORIGIN,
  DESC_DISABLELAYOUTSWITCH,
  DESC_
}
 

Enumeration Type Documentation

◆ DESC

enum DESC
Enumerator
DESC_NAME 

String Name for standalone use.

DESC_SHORT_NAME 

String Short name, for attributes dialog.

DESC_VERSION 

Int32 Show in versions:

DESC_VERSION_DEMO 

Demo versions.

DESC_VERSION_XL 

XL Versions.

DESC_VERSION_ALL 

All versions.

DESC_CHILDREN 

BaseContainer Internal.

DESC_MIN 

Int32/Float/Vector Minimum value.

DESC_MAX 

Int32/Float/Vector Maximum value.

DESC_MINEX 

Bool true if DESC_MIN is exclusive, otherwise it is inclusive.

DESC_MAXEX 

Bool true if DESC_MAX is exclusive, otherwise it is inclusive.

DESC_STEP 

Int32/Float/Vector The step for the edit field arrows.

DESC_ANIMATE 

Int32 Animation mode:

DESC_ANIMATE_OFF 

Parameter is not animatable.

DESC_ANIMATE_ON 

Parameter is animatable.

DESC_ANIMATE_MIX 

Parameter is animatable, but needs to know the left and right data element.
An example is the Target expression that interpolates the Name parameter. If MIX is specified, the expression can at any time call BaseList2D::GetAnimatedParameter() to get the left, right and mix values.

DESC_ASKOBJECT 

Bool true means ask object for this parameter, false means look in container.

DESC_UNIT 

Int32 Unit for DTYPE_REAL/DTYPE_VECTOR:

DESC_UNIT_FLOAT 

FORMAT_FLOAT

DESC_UNIT_INT 

FORMAT_INT

DESC_UNIT_PERCENT 

FORMAT_PERCENT

DESC_UNIT_DEGREE 

FORMAT_DEGREE

DESC_UNIT_METER 

FORMAT_METER

DESC_UNIT_TIME 

FORMAT_FRAMES

DESC_PARENTGROUP 

Int32/DescID Parent ID.

DESC_CYCLE 

BaseContainer Contains members of cycle as string. (E.g. GetString(10041) == "-X".)

DESC_HIDE 

Bool Indicates whether the property is hidden or not.

DESC_DEFAULT 

Int32/Float/Vector Default numeric value.

DESC_ACCEPT 

BaseContainer Contains the accepted IDs as strings. For C4DAtom::IsInstanceOf() checks. (E.g. GetString(5155) == "Obase".)

DESC_SEPARATORLINE 

Bool true if separators should have a visible line.

DESC_REFUSE 

BaseContainer Contains the refused IDs as strings. For C4DAtom::IsInstanceOf() checks. (E.g. GetString(5155) == "Obase".)

DESC_PARENTID 

Int32 The ID of the parent element used for indentation and animation track.

DESC_CUSTOMGUI 

Int32 The ID of the GUI for this element. Either a custom ID or one of: CUSTOMGUI

DESC_COLUMNS 

Int32 Number of columns for layout groups (DTYPE_GROUP).

DESC_LAYOUTGROUP 

Bool true for layout groups (LAYOUTGROUP).

DESC_REMOVEABLE 

Bool true if entry is removable.

DESC_GUIOPEN 

Bool true if the maximized GUI is shown by default.

DESC_EDITABLE 

Bool true if entry is editable.

DESC_MINSLIDER 

Int32/Float/Vector Minimum value for slider.

DESC_MAXSLIDER 

Int32/Float/Vector Maximum value for slider.

DESC_GROUPSCALEV 

Bool Allow the group height to be scaled.

DESC_SCALEH 

Bool Scale element horizontally.

DESC_LAYOUTVERSION 

Int32 Layout version.

DESC_ALIGNLEFT 

Bool Align element left.

DESC_FITH 

Bool Fit element.

DESC_NEWLINE 

Bool Line break.

DESC_TITLEBAR 

Bool Main group title bar.

DESC_CYCLEICONS 

BaseContainer Icon IDs for cycle.

DESC_CYCLESYMBOLS 

BaseContainer String identifiers for help symbol export.

DESC_PARENT_COLLAPSE 

Int32 Parent collapse ID.

DESC_FORBID_INLINE_FOLDING 

Bool Instructs the Attribute Manager to not allow expanding inline objects for entry.

DESC_FORBID_SCALING 

Bool Prevents auto-scaling of the parameter with the scale tool (for DESC_UNIT_METER).

DESC_ANGULAR_XYZ 

Bool true for XYZ as angular representation, or false for HPB.

DESC_INPORT 

Bool GV in port.

DESC_OUTPORT 

Bool GV out port.

DESC_STATICPORT 

Bool GV static port.

DESC_NEEDCONNECTION 

Bool GV needs connection.

DESC_MULTIPLE 

Bool GV multiple ports allowed.

DESC_PORTONLY 

Bool GV port only.

DESC_CREATEPORT 

Bool GV create port.

DESC_PORTSMIN 

Int32 GV minimum number of ports.

DESC_PORTSMAX 

Int32 GV maximum number of ports.

DESC_NOTMOVABLE 

Bool GV not movable.

DESC_EDITPORT 

Bool GV editable.

DESC_ITERATOR 

Bool GV iterator port.

DESC_PARENTMSG 

DescID Used in the Material Editor on the boolean tabs to specify which section to open.

DESC_MATEDNOTEXT 

Bool No text in Material Editor window.

DESC_COLUMNSMATED 

Int32 Number of columns in left Material Editor window.

DESC_SHADERLINKFLAG 

Bool Specifies that this element is a shader link. (Only if datatype==DTYPE_BASELISTLINK.)

DESC_NOGUISWITCH 

Bool Disables GUI switching for this description element.

DESC_COLORALWAYSLINEAR 

:: treat color field always as linear input.

DESC_HIDE_WHEN_INLINE 

Bool True to hide this attribute in inline descriptions

DESC_MATERIALEDITOR_LEFTSIDE 

Bool True if the property should appear on the left side of the material editor.

DESC_CHANGED 

Bool true if entry is changed.

DESC_HIDEINFIELDS 

Bool true if group is visible in fields UI.

DESC_SHOWINFIELDS 

Bool true if group is shown in fields UI even though group may be hidden

DESC_FIELDCOLORCHANNEL 

Bool true if the group belongs only to the color channel in the fields list (so will be hidden when the channel is disabled in the UI)

DESC_FIELDDIRECTIONCHANNEL 

Bool true if the group belongs only to the direction channel in the fields list (so will be hidden when the channel is disabled in the UI)

DESC_FIELDVALUECHANNEL 

Bool true if the group belongs only to the value channel in the fields list (so will be hidden when the channel is disabled in the UI)

DESC_FIELDROTATIONCHANNEL 

Bool true if the group belongs only to the rotation channel in the fields list (so will be hidden when the channel is disabled in the UI)

DESC_NODEPORT 

Bool True to indicate a nodeport.

DESC_NODEISLINKEDPORT 

Int32 - 0 not linked, 1 - linked, 2 - linked but muted.

DESC_REPLACECOMPLEXUI 

BaseContainer filled with descids of props to replace.

DESC_REPLACE_HIDE 

Bool property hidden because replaced by a complex ui replaces this entry

DESC_RESOURCEPATH 

Private.

Since
R18
DESC_RESOURCELINE 

Private.

Since
R18
DESC_TEMPDESCID 

Internal. Used internally to store the preferred description ID.

DESC_IDENT 

String Resource identifier, e.g. ID_BASEOBJECT_REL_POSITION.

DESC_IDENT_ORIGIN 

Origin Resource identifier, e.g. ID_BASEOBJECT_REL_POSITION.

DESC_DISABLELAYOUTSWITCH 

Hides the Layout Switch arrow displayed on CUSTOMGUI elements.

DESC_