DescriptionAllowOverride Struct Reference

#include <lib_description.h>

Detailed Description

Message struct for the MSG_DESCRIPTION_ALLOWOVERRIDE message.

Since

R17.032

See also

Take System Messages.

Public Member Functions
	DescriptionAllowOverride (TakeData *takeData=nullptr, BaseTake *overrideTake=nullptr, const DescID *descId=nullptr)

Public Attributes
TakeData *	_takeData
BaseTake *	_overrideTake
const DescID *	_descId
BaseList2D *	_parent
DescID	_parentId
Bool	_allow
Bool	_overrideEnabled

Constructor & Destructor Documentation

DescriptionAllowOverride()

DescriptionAllowOverride	(	TakeData *	takeData = nullptr,
		BaseTake *	overrideTake = nullptr,
		const DescID *	descId = nullptr
	)

Default constructor.

Parameters

[in]	takeData	The take system context. The caller owns the pointed TakeData.
[in]	overrideTake	The take asking for the override. The caller owns the pointed BaseTake.
[in]	descId	The description ID to be overridden.

Member Data Documentation

_takeData

TakeData* _takeData

Take system context. Cinema 4D owns the pointed TakeData.

_overrideTake

BaseTake* _overrideTake

Take asking for the override.

_descId

const DescID* _descId

Description ID to be overridden.

_parent

BaseList2D* _parent

Parent node if the override must be assigned to it and not to the original node. Especially useful in case of branched structures.

_parentId

DescID _parentId

If _parent is set also a translated parameter ID needs to be set.

_allow

Bool _allow

true if the parameter can be overridden, otherwise false.

_overrideEnabled

Bool _overrideEnabled

true if the global switch allows the override, otherwise false.