c4d.modules.character.CAPoseMorphTag

class c4d.modules.character.CAPoseMorphTag
../../../../_images/character_association_pose.png

Methods Signatures

CAPoseMorphTag.__init__(self)

Create a new pose morph tag.

CAPoseMorphTag.AddMorph(self)

Add a morph to the morph tag.

CAPoseMorphTag.GetMorphBase(self)

Get the morph base of the morph tag.

CAPoseMorphTag.GetMorphIndex(self, morph)

Retrieves the index for the given morph.

CAPoseMorphTag.GetMorphCount(self)

Returns the Morph count.

CAPoseMorphTag.GetMorphID(self, index)

Return the morph ID.

CAPoseMorphTag.GetMorph(self, index)

Return the morph.

CAPoseMorphTag.GetActiveMorph(self)

Retrieves the active morph (usually the one selected).

CAPoseMorphTag.RemoveMorph(self, index)

Remove a morph by index.

CAPoseMorphTag.GetActiveMorphIndex(self)

Get the index of the current active morph.

CAPoseMorphTag.SetActiveMorphIndex(self, index)

Set the active morph index.

CAPoseMorphTag.GetMode(self)

Get the mode of the morph tag.

CAPoseMorphTag.InitMorphs(self)

Initialize the morphs.

CAPoseMorphTag.UpdateMorphs(self)

Update the morphs.

CAPoseMorphTag.ExitEdit(self, doc, apply)

Must be called before doing anything to a morph tag.

CAPoseMorphTag.GetPSDFeedbackColor(self)

Retrieves the PSD color used for feedback.

CAPoseMorphTag.SetPSDFeedbackColor(self, color)

Sets the PSD color used for feedback.

CAPoseMorphTag.GetPSDFeedbackColorEnabled(self)

Checks if PSD color feedback is enabled or disabled.

CAPoseMorphTag.SetPSDFeedbackColorEnabled(self, active)

Sets the enable/disable state of the PSD color used for feedback.

CAPoseMorphTag.GetPSDOrientThreshold(self)

Retrieves the PSD orient radian threshold used in automatic weighting.

CAPoseMorphTag.SetPSDOrientThreshold(self, radianThreshold)

Sets the PSD orient radian threshold used in automatic weighting.

CAPoseMorphTag.GetPSDTwistThreshold(self)

Retrieves the PSD twist radian threshold used in automatic weighting.

CAPoseMorphTag.SetPSDTwistThreshold(self, radianThreshold)

Sets the PSD twist radian threshold used in automatic weighting.

CAPoseMorphTag.GetPSDPositionThreshold(self)

Retrieves the PSD position distance threshold used in automatic weighting.

CAPoseMorphTag.SetPSDPositionThreshold(self, distanceThreshold)

Sets the PSD position distance threshold used in automatic weighting.

CAPoseMorphTag.GetMorphPSDID(self, morphIndex, ...)

Retrieves the description ID for the morph slider at morphIndex.

Inheritance

Parent Class:

Methods Documentation

CAPoseMorphTag.__init__(self)

Create a new pose morph tag.

Return type

c4d.modules.character.CAPoseMorphTag

Returns

The new pose morph tag.

CAPoseMorphTag.AddMorph(self)

Add a morph to the morph tag.

Return type

c4d.modules.character.CAMorph

Returns

The new morph.

CAPoseMorphTag.GetMorphBase(self)

Get the morph base of the morph tag.

Return type

c4d.modules.character.CAMorph

Returns

The morph base.

CAPoseMorphTag.GetMorphIndex(self, morph)

Retrieves the index for the given morph.

New in version R17.053.

Parameters

morph (c4d.modules.character.CAMorph) – The morph to search for.

Return type

int

Returns

The index for morph.

CAPoseMorphTag.GetMorphCount(self)

Returns the Morph count.

Return type

int

Returns

The morph count.

CAPoseMorphTag.GetMorphID(self, index)

Return the morph ID.

Parameters

index (int) – The index of the morph.

Raises

IndexError – If the morph index is out of range : 0<=index<GetMorphCount().

Return type

c4d.DescID

Returns

The morph ID.

CAPoseMorphTag.GetMorph(self, index)

Return the morph.

Parameters

index (int) – The index of the morph.

Raises

IndexError – If the morph index is out of range : 0<=index<GetMorphCount().

Return type

c4d.modules.character.CAMorph

Returns

The morph.

CAPoseMorphTag.GetActiveMorph(self)

Retrieves the active morph (usually the one selected).

New in version R17.053.

Return type

c4d.modules.character.CAMorph

Returns

The active morph.

CAPoseMorphTag.RemoveMorph(self, index)

Remove a morph by index.

Parameters

index (int) – The index of the morph.

Raises

IndexError – If the morph index is out of range : 0<=index<GetMorphCount().

CAPoseMorphTag.GetActiveMorphIndex(self)

Get the index of the current active morph.

Return type

int

Returns

The index.

CAPoseMorphTag.SetActiveMorphIndex(self, index)

Set the active morph index.

New in version R17.053.

Parameters

index (int) – The active morph index to set.

Raises

IndexError – If the morph index is out of range : 0<=index<GetMorphCount().

CAPoseMorphTag.GetMode(self)

Get the mode of the morph tag.

Return type

int

Returns

The mode.

CAPoseMorphTag.InitMorphs(self)

Initialize the morphs.

CAPoseMorphTag.UpdateMorphs(self)

Update the morphs.

CAPoseMorphTag.ExitEdit(self, doc, apply)
Must be called before doing anything to a morph tag.
If the user is in Edit mode and making changes to the morph, these are not applied until this function is called and, if not called, they are lost.
Set apply to True if any user changes should be stored. This is normally the case.
Parameters
  • doc (c4d.documents.BaseDocument) – The document.

  • apply (bool) – Set to False if any user changes should be stored, otherwise set to True.

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetPSDFeedbackColor(self)

Retrieves the PSD color used for feedback.

New in version R19.

Return type

c4d.Vector

Returns

The PSD feedback color.

CAPoseMorphTag.SetPSDFeedbackColor(self, color)

Sets the PSD color used for feedback.

New in version R19.

Parameters

color (c4d.Vector) – The PSD feedback color to set.

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetPSDFeedbackColorEnabled(self)

Checks if PSD color feedback is enabled or disabled.

New in version R19.

Return type

bool

Returns

True if PSD color feedback is enabled, otherwise False.

CAPoseMorphTag.SetPSDFeedbackColorEnabled(self, active)

Sets the enable/disable state of the PSD color used for feedback.

New in version R19.

Parameters

active (bool) – True to enable PSD color feedback, otherwise False.

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetPSDOrientThreshold(self)

Retrieves the PSD orient radian threshold used in automatic weighting.

New in version R19.

Return type

float

Returns

The PSD orient threshold (in radian).

CAPoseMorphTag.SetPSDOrientThreshold(self, radianThreshold)

Sets the PSD orient radian threshold used in automatic weighting.

New in version R19.

Parameters

radianThreshold (float) – The PSD orient threshold to set (in radian).

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetPSDTwistThreshold(self)

Retrieves the PSD twist radian threshold used in automatic weighting.

New in version R19.

Return type

float

Returns

The PSD twist threshold (in radian).

CAPoseMorphTag.SetPSDTwistThreshold(self, radianThreshold)

Sets the PSD twist radian threshold used in automatic weighting.

New in version R19.

Parameters

radianThreshold (float) – The PSD twist threshold to set (in radian).

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetPSDPositionThreshold(self)

Retrieves the PSD position distance threshold used in automatic weighting.

New in version R19.

Return type

float

Returns

The PSD position threshold (distance).

CAPoseMorphTag.SetPSDPositionThreshold(self, distanceThreshold)

Sets the PSD position distance threshold used in automatic weighting.

New in version R19.

Parameters

distanceThreshold (float) – The PSD position threshold to set (distance).

Return type

bool

Returns

True if successful, otherwise False.

CAPoseMorphTag.GetMorphPSDID(self, morphIndex, psdAttributeID)

Retrieves the description ID for the morph slider at morphIndex.

New in version R19.

Parameters
  • morphIndex (int) – The morph index: 0 <= morphIndex < GetMorphCount().

  • psdAttributeID (int) – The attribute ID defined in tcaposemorph.h: ID_CA_POSE_PSD_ORIENT_INTERP_WEIGHT <= psdAttributeID < ID_CA_POSE_PSD_AUTOWEIGHT_INTERP.

Raises

IndexError – If morphIndex is out of range.

Return type

c4d.DescID

Returns

The description ID of the specified attribute.