就业培训     下载中心     Wiki     联络 登录   注册

---

// If a SingleDescID is set, check if the cid is part of it. // This is a check if only the description of the given SingleDescID // should be set or not. if (singleid == nullptr || cid. IsPartOf (*singleid, nullptr )) { BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_BOOL ); 设置。 SetString ( DESC_NAME , "Boolean Parameter" _s);

// check if the new parameter description could be inserted if (!description-> SetParameter (cid, settings, ID_OBJECTPROPERTIES )) return ; }

Other parameter types are

• DTYPE_BUTTON : A button parameter.
• DTYPE_SEPARATOR : A separator parameter.
• DTYPE_STATICTEXT : A static text parameter.
• DTYPE_POPUP : A popup parameter.
• DTYPE_SUBCONTAINER : A sub-container. Typically for user data.
• DTYPE_GROUP : A parameter group. See Groups

Other data types are defined as custom data types like CUSTOMDATATYPE_BITMAPBUTTON etc.

Groups

Parameters are organized in parameter groups. These groups are used to define the structure and the layout of the parameters.

• DTYPE_GROUP : The type of a parameter group.
• DESC_COLUMNS : Number of columns for layout groups.
• DESC_LAYOUTGROUP : Set to true for layout groups. The content of such layout groups must be organized in sub-groups, see Layout Groups .
• DESC_GROUPSCALEV : Allow the group height to be scaled.
• DESC_TITLEBAR : Main group title bar option. If the title bar should be hidden DESC_NAME must not be set, only DESC_SHORT_NAME .
• DESC_DEFAULT : If set to 1 the group is unfolded by default. If set to -1 it will always be unfolded when re-created.

// define the group MAXON_SCOPE { const DescID groupID = DescLevel (ID_GROUP, DTYPE_GROUP , 0); BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_GROUP ); 设置。 SetString ( DESC_NAME , "New Group" _s); 设置。 SetInt32 ( DESC_COLUMNS , 2); // group has two columns 设置。 SetInt32 ( DESC_DEFAULT , 1); // group is unfolded by default 设置。 SetInt32 ( DESC_SCALEH , 1); // group is scaled horizontally description-> SetParameter (groupID, settings, 0); }

// add the first child parameter MAXON_SCOPE { const DescID cid = DescID ( DescLevel (ID_STRING_A, DTYPE_STRING , 0)); BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_STRING ); 设置。 SetString ( DESC_NAME , "Parameter A" _s); 设置。 SetInt32 ( DESC_SCALEH , 1); description-> SetParameter (cid, settings, ID_GROUP); }

// add the second child parameter MAXON_SCOPE { const DescID cid = DescID ( DescLevel (ID_STRING_B, DTYPE_STRING , 0)); BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_STRING ); 设置。 SetString ( DESC_NAME , "Parameter B" _s); 设置。 SetInt32 ( DESC_SCALEH , 1); description-> SetParameter (cid, settings, ID_GROUP); } }

A parameter is typically part of a group:

• DESC_PARENTGROUP : The ID of the parent group.

The group IDs of specific elements are defined in the corresponding header files like ID_OBJECTPROPERTIES in Obase.h .

// check if the GeData stores a DescID if (parentid. GetType () == CUSTOMDATATYPE_DESCID ) { // get DescID CustomDataType * const customData = parentid. GetCustomDataType ( CUSTOMDATATYPE_DESCID ); const DescID * const descID = static_cast< const DescID * > (customData); if (descID == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// print ID const Int32 id = descID->operator[](-1). id ; ApplicationOutput ( "Parent Group ID: " + String::IntToString ( id )); }

A row of a group can be filled with dummy elements so that the next elements start in a new row:

• DESC_NEWLINE : The element in question is used as a "line break". Typically used with a static text element.

Parent Parameters

A parameter can be a parent parameter of another parameter. The child parameter is hidden until the user clicks on a little arrow.

• DESC_PARENT_COLLAPSE : The ID of the parent parameter.

// add the parent parameter MAXON_SCOPE { BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_STRING ); 设置。 SetString ( DESC_NAME , "Parent" _s); 设置。 SetData ( DESC_PARENT_COLLAPSE , NOTOK ); description-> SetParameter (parentID, settings, ID_OBJECTPROPERTIES ); }

// add the child parameter MAXON_SCOPE { const DescID cid = DescID ( DescLevel (ID_CHILD, DTYPE_STRING , 0)); BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_STRING ); 设置。 SetString ( DESC_NAME , "Child" _s); GeData parentIdData; parentIdData. SetCustomDataType ( CUSTOMDATATYPE_DESCID , parentID); 设置。 SetData ( DESC_PARENT_COLLAPSE , parentIdData); description-> SetParameter (cid, settings, ID_OBJECTPROPERTIES ); }

Layout

The parameter description includes settings that define how a group or parameter should be scaled in the Attribute Manager.

• DESC_SCALEH : The element is scaled horizontally.
• DESC_FITH : The element fits horizontally.
• DESC_ALIGNLEFT : The element is aligned left.

Visibility

The parameter description also includes information on how the parameter is displayed:

• DESC_HIDE : Indicates whether the element is hidden or not. Especially used to hide a parameter from a loaded parameter description.
• DESC_CUSTOMGUI : The ID of the custom GUI element.
• DESC_GUIOPEN : Set to true if the maximized GUI is shown by default.
• DESC_FORBID_INLINE_FOLDING : Instructs the Attribute Manager to not allow expanding inline objects.
• DESC_NOGUISWITCH : Disables GUI switching for this element.
• DESC_DISABLELAYOUTSWITCH : Hides the Layout Switch arrow.
• DESC_HIDE_WHEN_INLINE : Hide this attribute in inline descriptions.
• DESC_REPLACE_HIDE : Element replaced by a complex UI.
• DESC_REPLACECOMPLEXUI : BaseContainer filled with descids of props to replace.

注意

To enable or disable a parameter in the Attribute Manager one must implement NodeData::GetDEnabling() ，见 NodeData::GetDEnabling() Manual .

// This example creates a shader link parameter description that cannot be unfolded. BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_BASELISTLINK ); 设置。 SetString ( DESC_NAME , "Shader" _s); 设置。 SetInt32 ( DESC_CUSTOMGUI , CUSTOMGUI_TEXBOX ); // use the tex box gui to handle shaders 设置。 SetBool ( DESC_SHADERLINKFLAG , true ); // is a shader link

// don't unfold the GUI in the Attribute Manager 设置。 SetInt32 ( DESC_FORBID_INLINE_FOLDING , true ); description-> SetParameter (cid, settings, DescLevel ( ID_OBJECTPROPERTIES ));

The settings of a custom GUI also have to be stored in the BaseContainer .

名称

The name of a parameter is displayed in the Attribute Manager or other contexts:

• DESC_NAME : The parameter name for standalone use.
• DESC_SHORT_NAME : The short name, displayed in the Attribute Manager.
• DESC_IDENT : The resource identifier, e.g. "ID_BASEOBJECT_REL_POSITION". This value is typically read-only.
• DESC_IDENT_ORIGIN : The resource identifier, e.g. "ID_BASEOBJECT_REL_POSITION". This value is typically read-only.

动画

One can enable or disable if a parameter should be animateable:

• DESC_ANIMATE : The 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.

值

For specific parameter types certain values can be set:

For DTYPE_REAL , DTYPE_LONG and DTYPE_VECTOR parameters:

• DESC_MIN : Minimum value.
• DESC_MAX : Maximum value.
• DESC_MINEX : Defines if DESC_MIN is exclusive, otherwise it is inclusive.
• DESC_MAXEX : Defines if DESC_MAX is exclusive, otherwise it is inclusive.
• DESC_STEP : The step for the edit field arrows.
• DESC_DEFAULT : Default numeric value.
• DESC_MINSLIDER : Minimum value for slider.
• DESC_MAXSLIDER : Maximum value for slider.

DTYPE_REAL and DTYPE_VECTOR can display values with a given unit:

• DESC_UNIT : Unit type.
  • DESC_UNIT_FLOAT : Float.
  • DESC_UNIT_INT : Integer.
  • DESC_UNIT_PERCENT : Percentage.
  • DESC_UNIT_DEGREE : Degree.
  • DESC_UNIT_METER : Meters. The "Scale" tool will auto-scale these parameters when the host BaseObject is scaled.
  • DESC_UNIT_TIME : Time.
• DESC_FORBID_SCALING : Prevents auto-scaling "meter" parameters.

注意

These are the same formats as used with GeDialog::SetFloat() .

// don't scale this parameter when the host BaseObject is scaled 设置。 SetBool ( DESC_FORBID_SCALING , true );

The values selectable in a drop down parameter (based on DTYPE_LONG ) are stored in sub-containers:

• DESC_CYCLE : Setting for a BaseContainer with the members of the cycle as string.
• DESC_CYCLEICONS : Setting for a BaseContainer with the icon IDs for cycle.

// a drop down is a long parameter with a custom GUI BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_LONG ); 设置。 SetString ( DESC_NAME , "Drop Down" _s); 设置。 SetInt32 ( DESC_CUSTOMGUI , CUSTOMGUI_CYCLE );

// add cycle elements BaseContainer items; items. SetString (0, "Item 1" _s); items. SetString (1, "Item 2" _s); items. SetString (2, "Item 3" _s); 设置。 SetContainer ( DESC_CYCLE , items);

// add cycle icons BaseContainer icons; icons. SetInt32 (0, 5159); // use "Cube" icon icons. SetInt32 (1, IDM_CUT ); // use "Cut" icon icons. SetInt32 (2, IDM_DELETE ); // use "Delete" icon 设置。 SetContainer ( DESC_CYCLEICONS , icons);

Both DTYPE_BASELISTLINK and CUSTOMDATATYPE_INEXCLUDE_LIST parameter types can reference Cinema 4D 元素。

• DESC_ACCEPT : Setting for a BaseContainer with accepted element IDs.
• DESC_REFUSE : Setting for a BaseContainer with refused element IDs.

注意

The check is done with C4DAtom::IsInstanceOf() , so also category types like Obase etc. can be used.

A DTYPE_BASELISTLINK parameter can also reference and manage a shader:

• DESC_SHADERLINKFLAG : Specifies that this element is a shader link.

// don't unfold the GUI in the Attribute Manager 设置。 SetInt32 ( DESC_FORBID_INLINE_FOLDING , true ); description-> SetParameter (cid, settings, DescLevel ( ID_OBJECTPROPERTIES ));

A DTYPE_SEPARATOR can be displayed with or without a line:

• DESC_SEPARATORLINE : Set to true if the separator should have a visible line.

若 DTYPE_VECTOR is used to display a rotation ( DESC_UNIT_DEGREE ) it can display this as XYZ or HPB:

• DESC_ANGULAR_XYZ : Set to true for XYZ as angular representation, or false for HPB.

Material Editor

Materials can include parameter groups that are presented as "channels" in the Material Editor window. The left column of the Material Editor can include references to these channels or simple parameters:

• DESC_MATEDNOTEXT : Defines if the parameter name is displayed in the Material Editor window.
• DESC_COLUMNSMATED : Number of columns in left Material Editor window.
• DESC_MATERIALEDITOR_LEFTSIDE : True if the property should appear on the left side of the material editor.

// don't display the name in the Material Editor left column 设置。 SetBool ( DESC_MATEDNOTEXT , true ); description-> SetParameter (cid, settings, Tbaselist2d );

A DTYPE_BOOL can be used to enable or disable a channel group.

• DESC_PARENTMSG : ID of the associated group.
• BOOL_PAGEMODE : Defines if a checkbox is displayed or not.

// add the Boolean parameter to select the group MAXON_SCOPE { const DescID cid { DescLevel { ID_SETTINGS_BOOL, DTYPE_BOOL , 0 } }; BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_BOOL ); 设置。 SetString ( DESC_NAME , "Settings" _s); 设置。 SetInt32 ( DESC_PARENTMSG , ID_SETTINGS_GROUP); // the group to select 设置。 SetBool ( BOOL_PAGEMODE , true ); // page mode; no checkbox is displayed 设置。 SetBool ( DESC_HIDE , true ); // hide in Attribute Manager description-> SetParameter (cid, settings, Tbaselist2d ); }

// add a material group MAXON_SCOPE { const DescID cid = DescLevel (ID_SETTINGS_GROUP, DTYPE_GROUP , 0); BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_GROUP ); 设置。 SetString ( DESC_NAME , "Material Properties" _s); description-> SetParameter (cid, settings, 0); }

// add a parameter to that group MAXON_SCOPE { const DescID cid { DescLevel { ID_PARAMETER, DTYPE_BOOL , 0 } }; BaseContainer settings = GetCustomDataTypeDefault ( DTYPE_BOOL ); 设置。 SetString ( DESC_NAME , "Some Parameter" _s); description-> SetParameter (cid, settings, ID_SETTINGS_GROUP); }

延伸阅读

• Description Manual
• DynamicDescription Manual
• DescID Manual
• C4DAtom Manual
• NodeData::GetDDescription() Manual
• NodeData::GetDEnabling() Manual