CAWeightMgr Manual

About

The CAWeightMgr class represents the Weight Manager dialog window and its functionality. It gives access to the displayed tags (of type CAWeightTag) and joints.

Settings

The settings presented by the Weight Manager dialog are stored with the BaseDocument. They can be safely accessed with these functions:

The setting IDs are defined in oweightmgr.h.

// This example changes the settings that are displayed in the Weight Manager dialog.
// enable "Display Weighting"
// enable "Draw All Joints"
// enable "Points"

Update

The CAWeightMgr class accesses an internal cache. This internal cache is automatically updated if the Weight Manger window is opened or the weight tool is active. If this is not the case the internal cache must be updated manually to handle scene changes.

// This example creates and adds a weight tag and a skin object
// to the given polygon object. The joints stored in the given BaseArray
// are linked in the weight tag. The weight manager is updated
// and used to create auto-weights.
// add weight tag and skin object
if (wTag == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
if (sObject == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
CAWeightTag* const weightTag = wTag.Release();
BaseObject* const skinObject = sObject.Release();
polyObject->InsertTag(weightTag);
doc->InsertObject(skinObject, polyObject, nullptr);
// add joints from a BaseArray
const Int jointCount = joints.GetCount();
for (Int i = 0; i < jointCount; ++i)
{
BaseObject* const joint = joints[i];
weightTag->AddJoint(joint);
}
// select tag
doc->SetActiveTag(weightTag, SELECTION_NEW);
// update weight manager
// select all joints
// auto weight

Weight Tags

The Weight Manager dialog displays the joints of multiple (selected) weight tags.

// This example loops through all Weight Tags
// displayed in the Weight Manager window.
// get tag count
const Int32 tagCount = CAWeightMgr::GetTagCount(doc);
if (tagCount == 0)
return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
// loop through all tags
for (Int32 tagIndex = 0; tagIndex < tagCount; ++tagIndex)
{
// print tag name
const CAWeightTag* const tag = CAWeightMgr::GetWeightTag(doc, tagIndex);
if (tag == nullptr)
return maxon::UnexpectedError(MAXON_SOURCE_LOCATION);
ApplicationOutput("Weight Tag: " + tag->GetName());
// print host object name
const BaseObject* const hostObject = CAWeightMgr::GetMeshObject(doc, tagIndex);
if (hostObject == nullptr)
return maxon::UnexpectedError(MAXON_SOURCE_LOCATION);
ApplicationOutput("Host Object: " + hostObject->GetName());
}

Joints

Each CAWeightTag stores weights for joints. These joints are displayed in the Weight Manager dialog.

// This example loops through all joints (influences)
// handled in the weight tag at the given index.
// get count
const Int32 jointCount = CAWeightMgr::GetJointCount(doc, tagIndex);
// loop through all joints
for (Int32 i = 0; i < jointCount; ++i)
{
const BaseObject* const joint = CAWeightMgr::GetJointObject(doc, tagIndex, i);
if (joint == nullptr)
return maxon::UnexpectedError(MAXON_SOURCE_LOCATION);
// print joint name
ApplicationOutput("Joint: " + joint->GetName());
}

Selection

It is possible to select joint objects in the Weight Manager. Several operations only apply to such selected objects.

The selection state of all joint objects can easily be managed with:

// This example loops through all selected objects. If the object
// is a joint it will also be selected in the weight manager.
// get all selected objects
if (objects == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
// deselect all influences
// loop through all objects
for (Int32 i = 0; i < objects->GetCount(); ++i)
{
// get object
C4DAtom* const atom = objects->GetIndex(i);
BaseObject* const joint = static_cast<BaseObject*>(atom);
if (joint == nullptr)
return maxon::UnexpectedError(MAXON_SOURCE_LOCATION);
// check if joint
if (joint->IsInstanceOf(Ojoint))
{
// get id
const UInt64 id = CAWeightMgr::GetJointId(doc, weightTag, joint);
{
// check if selected
if (joint->GetBit(BIT_ACTIVE))
}
}
}

Locked

The Weight Manager can lock a joint object to prevent unintended changes.

The lock state of all joint objects can be managed with:

// This example inverts the lock state of all influences
// in the weight tag with the given index.
// deselect all
// get count
const Int32 jointCount = CAWeightMgr::GetJointCount(doc, tagIndex);
// loop through all joints
for (Int32 i = 0; i < jointCount; ++i)
{
// check if locked
if (CAWeightMgr::IsJointLocked(doc, tagIndex, i) == false)
{
// select unlocked
CAWeightMgr::SelectJoint(doc, tagIndex, i);
}
}
// unlock all
// lock selected

Functions

The weight algorithms are edited with these static functions:

Note
The auto weight algorithm IDs are defined in maxon/autoweight.h, the settings in maxon/autoweight_attributes.h.

Several weight tools of the Weight Manager can be invoked with dedicated functions. These functions add an undo step.

Note
The functions take the selection state of a joint object into account.

Copy and paste functions are:

// This example configures the Weight Manager settings and applies the "Auto Weight" function.
// get modes
const maxon::Id targetMode = maxon::AutoWeightAlgos::BoneglowClass().GetId();
// set mode
GeData geData;
geData.SetInt64(index);
// get settings
maxon::DataDictionary data = CAWeightMgr::GetAutoWeightDictionary(doc, targetMode) iferr_return;
// set settings
data.Set(maxon::ANIMATION::AUTOWEIGHT::BONEGLOW::USEVISIBILITY, true) iferr_return;
data.Set(maxon::ANIMATION::AUTOWEIGHT::BONEGLOW::VISIBILITYRATIO, 0.3_f) iferr_return;
// apply

Further Reading

Oskin
#define Oskin
Skin deformer.
Definition: ge_prepass.h:1062
BaseList2D::GetBit
Bool GetBit(Int32 mask) const
Definition: c4d_baselist.h:2237
BaseDocument::InsertObject
void InsertObject(BaseObject *op, BaseObject *parent, BaseObject *pred, Bool checknames=false)
Int
maxon::Int Int
Definition: ge_sys_math.h:64
CAWeightTag::AddJoint
Int32 AddJoint(BaseObject *op)
BaseObject
Definition: c4d_baseobject.h:224
CAWeightMgr::GetMeshObject
static BaseObject * GetMeshObject(BaseDocument *doc, Int32 tagIdx)
maxon::Int64
int64_t Int64
64 bit signed integer datatype.
Definition: apibase.h:180
CAWeightMgr::GetAutoWeightDictionary
static maxon::Result< maxon::DataDictionary > GetAutoWeightDictionary(BaseDocument *doc, const maxon::Id &autoweightId)
AtomArray::GetCount
Int32 GetCount() const
Definition: c4d_baselist.h:1649
maxon::Id
Definition: apibaseid.h:250
iferr_return
#define iferr_return
Definition: resultbase.h:1465
CAWeightTag
Definition: lib_ca.h:178
MAXON_SOURCE_LOCATION
#define MAXON_SOURCE_LOCATION
Definition: memoryallocationbase.h:67
CAWeightMgr::IsJointLocked
static Bool IsJointLocked(BaseDocument *doc, Int32 tagIdx, Int32 jointIdx)
BaseDocument::SetActiveTag
void SetActiveTag(BaseTag *tag, Int32 mode=0)
CAWeightMgr::SelectAllJoints
static void SelectAllJoints(BaseDocument *doc)
CAWeightMgr::Update
static Bool Update(BaseDocument *doc)
BIT_ACTIVE
#define BIT_ACTIVE
Active.
Definition: ge_prepass.h:865
CAWeightMgr::AutoWeight
static Bool AutoWeight(BaseDocument *doc)
CAWeightMgr::SetAutoWeightDictionary
static maxon::Result< void > SetAutoWeightDictionary(BaseDocument *doc, maxon::DataDictionary dataDictionary, maxon::Id autoweightId)
ID_CA_WEIGHT_MGR_DISPLAY_ALL_WEIGHTS
@ ID_CA_WEIGHT_MGR_DISPLAY_ALL_WEIGHTS
Definition: oweightmgr.h:48
CAWeightMgr::GetJointCount
static Int32 GetJointCount(BaseDocument *doc, Int32 tagIdx)
CAWeightMgr::GetAutoWeightAlgoIndex
static maxon::Result< Int > GetAutoWeightAlgoIndex(BaseDocument *doc, const maxon::Id &id)
CAWeightMgr::UnlockAllJoints
static Bool UnlockAllJoints(BaseDocument *doc)
maxon::LIMIT
Definition: apibasemath.h:53
CAWeightMgr::SetParameter
static Bool SetParameter(BaseDocument *doc, Int32 id, const GeData &newValue)
ID_CA_WEIGHT_MGR_DISPLAY_POINTS
@ ID_CA_WEIGHT_MGR_DISPLAY_POINTS
Definition: oweightmgr.h:50
CAWeightMgr::GetJointId
static UInt64 GetJointId(BaseDocument *doc, const CAWeightTag *tag, const BaseObject *joint)
BaseDocument::GetActiveObjects
void GetActiveObjects(AtomArray &selection, GETACTIVEOBJECTFLAGS flags) const
GeData
Definition: c4d_gedata.h:82
C4DAtom
Definition: c4d_baselist.h:1361
Int32
maxon::Int32 Int32
Definition: ge_sys_math.h:60
ID_CA_WEIGHT_MGR_ENABLE_DISPLAY
@ ID_CA_WEIGHT_MGR_ENABLE_DISPLAY
Definition: oweightmgr.h:51
CAWeightMgr::GetJointObject
static BaseObject * GetJointObject(BaseDocument *doc, Int32 tagIdx, Int32 jointIdx)
ApplicationOutput
#define ApplicationOutput(formatString,...)
Definition: debugdiagnostics.h:210
CAWeightMgr::SelectJoint
static Bool SelectJoint(BaseDocument *doc, Int32 tagIdx, Int32 jointIdx)
CAWeightMgr::UnselectAllJoints
static void UnselectAllJoints(BaseDocument *doc)
AutoAlloc::Release
TYPE * Release()
Definition: ge_autoptr.h:120
AutoAlloc
Definition: ge_autoptr.h:36
GETACTIVEOBJECTFLAGS::CHILDREN
@ CHILDREN
Child objects are added to the selection too, provided they are selected. Otherwise only the topmost ...
GeData::SetInt64
void SetInt64(const Int64 &v)
Definition: c4d_gedata.h:579
C4DAtom::IsInstanceOf
Bool IsInstanceOf(Int32 id) const
Definition: c4d_baselist.h:1403
BaseList2D::GetName
String GetName() const
Definition: c4d_baselist.h:2348
CAWeightMgr::GetWeightTag
static CAWeightTag * GetWeightTag(BaseDocument *doc, Int32 tagIdx)
CAWeightMgr::LockSelectedJoints
static Bool LockSelectedJoints(BaseDocument *doc)
ID_CA_WEIGHT_MGR_AUTOWEIGHT_MODE
@ ID_CA_WEIGHT_MGR_AUTOWEIGHT_MODE
Definition: oweightmgr.h:151
BaseObject::InsertTag
void InsertTag(BaseTag *tp, BaseTag *pred=nullptr)
UInt64
maxon::UInt64 UInt64
Definition: ge_sys_math.h:63
SELECTION_NEW
#define SELECTION_NEW
Starts a new selection.
Definition: c4d_basedocument.h:388
CAWeightMgr::GetTagCount
static Int32 GetTagCount(BaseDocument *doc)
Ojoint
#define Ojoint
Joint.
Definition: ge_prepass.h:1061
AtomArray::GetIndex
C4DAtom * GetIndex(Int32 idx) const
Definition: c4d_baselist.h:1664