NodeData::GetDDescription() Manual

内容表

关于
用法
延伸阅读

关于

NodeData based classic plugin classes can implement NodeData::GetDDescription() . This allows to dynamically add parameters to the element's parameter description. This description is then used by Cinema 4D to define the parameters that are displayed in the Attribute Manager.

NodeData::GetDDescription() corresponds to C4DAtom::GetDescription() .

注意: NodeData::GetDDescription() will be called when the DIRTYFLAGS::DESCRIPTION flag of an object is set.

用法

当 NodeData::GetDDescription() is called it is supposed to fill the given 描述对象。

// This example defines the element's parameter description by loading the registered description of the plugin type.

virtual Bool GetDDescription( GeListNode * node, 描述 * description, DESCFLAGS_DESC & flags) { const Bool invalidNode = node == nullptr ; const Bool invalidDescription = description == nullptr ;

if (invalidNode || invalidDescription) return false ;

// load the description of this type if (description-> LoadDescription (node-> GetType ()) == false ) return false ; flags |= DESCFLAGS_DESC::LOADED ; return SUPER::GetDDescription(node, description, flags); }

The arguments of the function are:

The node itself.
The 描述 object to fill.
Some Flags. The possible values are:
- DESCFLAGS_DESC::LOADED : Set if elements have been added to the description, either by loading or manual addition.
- DESCFLAGS_DESC::MAPTAGS : If set, the object description will also contain the tag's descriptions (as sub-containers).
- DESCFLAGS_DESC::NEEDDEFAULTVALUE : Set if "Reset to Default" was called by the user.

Details on how to handle a 描述 are described in Description Manual and Description Settings Manual .

延伸阅读

Description::LoadDescription

Bool LoadDescription(const BCResourceObj *bc, Bool copy)

定义： lib_description.h:527

DESCFLAGS_DESC

定义： ge_prepass.h:3079

Represents a C4DAtom that resides in a 4D list.

定义： c4d_baselist.h:1767

DESCFLAGS_DESC::LOADED

@ LOADED

Set if elements have been added to the description, either by loading or manual addition.

maxon::Bool Bool

定义： ge_sys_math.h:53

C4DAtom::GetType

Int32 GetType() const

定义： c4d_baselist.h:1348