About

NodeData based Cinema API plugin classes can implement NodeData::SetDParameter(). This allows to change parameters that are set and it allows to react to this event. This is typically done to handle data that is not stored in the object's BaseContainer. It is also used to change parameter values when another parameter was changed.

NodeData::SetDParameter() corresponds to C4DAtom::SetParameter().

Note: In most cases, when implementing NodeData::SetDParameter(), one will also need to implement NodeData::GetDParameter(). For example, if the value is stored in a member variable.

Usage

NodeData::SetDParameter() is called when the value of a parameter is set with C4DAtom::SetParameter(). It is possible to change this value before it is stored in the element's BaseContainer.

  Bool SetDParameter(GeListNode* node, const DescID& id, const GeData& t_data, DESCFLAGS_SET& flags)
  {
    if (node == nullptr)
      return false;
 
    switch (id[0].id)
    {
      // This parameter will not be stored in the BaseContainer
      case EXAMPLE_GENERATOR_PARAMETER_NOT_BC:
      {
        // store the set value in a member variable.
        _value = t_data.GetInt32();
 
        // mark parameter as set
        flags |= DESCFLAGS_SET::PARAM_SET;
 
        // return from the function, don't call the function of the base class.
        return true;
      }
      // This example sets the value of another parameter based on the value of the given parameter.
 
      case EXAMPLE_GENERATOR_PARAMETER_VALUE:
      {
        const Int32 twice = t_data.GetInt32() * 2;
        node->SetParameter(ConstDescID(DescLevel(EXAMPLE_GENERATOR_PARAMETER_VALUE_TWICE)), twice, DESCFLAGS_SET::NONE);
 
        break;
      }
    }
 
    return SUPER::SetDParameter(node, id, t_data, flags);
  }

Note: Such member variables must also be handled in NodeData::Read(), NodeData::Write(), NodeData::CopyTo() and NodeData::GetDParameter().

The arguments of the function are:

The node itself.
The parameter DescID in question.
The value of the parameter as GeData object
These flags:
- DESCFLAGS_SET::PARAM_SET : Parameter set.
- DESCFLAGS_SET::USERINTERACTION : Set when the GUI is calling C4DAtom::SetParameter().
- DESCFLAGS_SET::DONTCHECKMINMAX : No check is internally done if the passed parameter is within the [min/max] range of the description, to save some time.
- DESCFLAGS_SET::DONTAFFECTINHERITANCE : No parameter inheritance, for render settings and post effects only.
- DESCFLAGS_SET::FORCESET : Force setting of the value without GetParameter/Compare.
- DESCFLAGS_SET::INDRAG : In drag.

If the parameter is set through user-interaction in the Attribute Manager the message MSG_DESCRIPTION_POSTSETPARAMETER will be sent to the element. See also Interaction.

Certain cases have to be handled with special functions:

The macro HandleDescSetVector has to be used to handle vector parameter values.
In nodes with a material preview description SetDParameterPreview() can be used.

Note: It is not safe to call DrawViews() from NodeData::SetDParameter().

Table of Contents

About

Usage

Further Reading