NodeData::GetDEnabling() Manual

Table of Contents

About

NodeData based classic plugin classes can implement NodeData::GetDEnabling(). This allows to dynamically enable and disable parameters in the Attribute Manager.

NodeData::GetDEnabling() corresponds to C4DAtom::GetEnabling().

Usage

NodeData::GetDEnabling() is called with the DescID of each parameter. The function simply returns true if the given parameter should be enabled and false if the given parameter should be disabled.

Bool GetDEnabling(const GeListNode* node, const DescID& id, const GeData& t_data, DESCFLAGS_ENABLE flags, const BaseContainer* itemdesc) const
{
if (node == nullptr)
return false;
// check parameter ID
switch (id[0].id)
{
case EXAMPLE_GENERATOR_PARAMETER_VALUE:
{
// get the value of another parameter
GeData data;
node->GetParameter(ConstDescID(DescLevel(EXAMPLE_GENERATOR_PARAMETER_BOOL)), data, DESCFLAGS_GET::NONE);
// if true, then enable the parameter
// if not, disable the parameter
if (data.GetBool())
return true;
else
return false;
break;
}
}
return SUPER::GetDEnabling(node, id, t_data, flags, itemdesc);
}
flags
PyCompilerFlags * flags
Definition: ast.h:14
BaseContainer
Definition: c4d_basecontainer.h:48
DescID
Definition: lib_description.h:355
GeData
Definition: c4d_gedata.h:83
GeData::GetBool
Bool GetBool() const
Definition: c4d_gedata.h:450
GeListNode
Represents a C4DAtom that resides in a 4D list.
Definition: c4d_baselist.h:1975
Bool
maxon::Bool Bool
Definition: ge_sys_math.h:51
DESCFLAGS_ENABLE
DESCFLAGS_ENABLE
Definition: ge_prepass.h:3383
DESCFLAGS_GET::NONE
@ NONE
None.
ConstDescID
#define ConstDescID(...)
Definition: lib_description.h:594
_node
Definition: node.h:10
DescLevel
Represents a level within a DescID.
Definition: lib_description.h:298

The arguments of the function are:

  • The node itself.
  • The parameter DescID in question.
  • The parameter value.
  • Some flags that are currently not used.
  • The parameter description stored in a BaseContainer.

Further Reading