About

NodeData based Cinema API 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().

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

Usage

When NodeData::GetDDescription() is called it is supposed to fill the given Description object.

  // This example defines the element's parameter description by loading the registered description of the plugin type.
 
  virtual Bool GetDDescription(const GeListNode* node, Description* description, DESCFLAGS_DESC& flags) const
  {
    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 Description 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 Description are described in Description Manual and Description Settings Manual.

Table of Contents

About

Usage

Further Reading