c4d.modules.character.CAPoseMorphTag

../../../../_images/association_pose2.png

Inheritance

Members

CAPoseMorphTag.__init__()

Create a new pose morph tag.

Return type:c4d.modules.character.CAPoseMorphTag
Returns:The new pose morph tag.
CAPoseMorphTag.AddMorph()

Add a morph to the morph tag.

Return type:c4d.modules.character.CAMorph
Returns:The new morph.
CAPoseMorphTag.GetMorphBase()

Get the morph base of the morph tag.

Return type:c4d.modules.character.CAMorph
Returns:The morph base.
CAPoseMorphTag.GetMorphIndex(morph)

New in version R17.053.

Retrieves the index for the given morph.

Parameters:morph (c4d.modules.character.CAMorph) – The morph to search for.
Return type:int
Returns:The index for morph.
CAPoseMorphTag.GetMorphCount()
Return type:int
Returns:The morph count.
CAPoseMorphTag.GetMorphID(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(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()

New in version R17.053.

Retrieves the active morph (usually the one selected).

Return type:c4d.modules.character.CAMorph
Returns:The active morph.
CAPoseMorphTag.RemoveMorph(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()

Get the index of the current active morph.

Return type:int
Returns:The index.
CAPoseMorphTag.SetActiveMorphIndex(index)

New in version R17.053.

Set the active morph index.

Parameters:index (int) – The active morph index to set.
Raises:IndexError – If the morph index is out of range : 0<=index<GetMorphCount().
CAPoseMorphTag.GetMode()

Get the mode of the morph tag.

Return type:int
Returns:The mode.
CAPoseMorphTag.InitMorphs()

Initialize the morphs.

CAPoseMorphTag.UpdateMorphs()

Update the morphs.

CAPoseMorphTag.ExitEdit(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()

New in version R19.

Retrieves the PSD color used for feedback.

Return type:c4d.Vector
Returns:The PSD feedback color.
CAPoseMorphTag.SetPSDFeedbackColor(color)

New in version R19.

Sets the PSD color used for feedback.

Parameters:color (c4d.Vector) – The PSD feedback color to set.
Return type:bool
Returns:True if successful, otherwise False.
CAPoseMorphTag.GetPSDFeedbackColorEnabled()

New in version R19.

Checks if PSD color feedback is enabled or disabled.

Return type:bool
Returns:True if PSD color feedback is enabled, otherwise False.
CAPoseMorphTag.SetPSDFeedbackColorEnabled(active)

New in version R19.

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

Parameters:active (bool) – True to enable PSD color feedback, otherwise False.
Return type:bool
Returns:True if successful, otherwise False.
CAPoseMorphTag.GetPSDOrientThreshold()

New in version R19.

Retrieves the PSD orient radian threshold used in automatic weighting.

Return type:float
Returns:The PSD orient threshold (in radian).
CAPoseMorphTag.SetPSDOrientThreshold(radianThreshold)

New in version R19.

Sets the PSD orient radian threshold used in automatic weighting.

Parameters:radianThreshold (float) – The PSD orient threshold to set (in radian).
Return type:bool
Returns:True if successful, otherwise False.
CAPoseMorphTag.GetPSDTwistThreshold()

New in version R19.

Retrieves the PSD twist radian threshold used in automatic weighting.

Return type:float
Returns:The PSD twist threshold (in radian).
CAPoseMorphTag.SetPSDTwistThreshold(radianThreshold)

New in version R19.

Sets the PSD twist radian threshold used in automatic weighting.

Parameters:radianThreshold (float) – The PSD twist threshold to set (in radian).
Return type:bool
Returns:True if successful, otherwise False.
CAPoseMorphTag.GetPSDPositionThreshold()

New in version R19.

Retrieves the PSD position distance threshold used in automatic weighting.

Return type:float
Returns:The PSD position threshold (distance).
CAPoseMorphTag.SetPSDPositionThreshold(distanceThreshold)

New in version R19.

Sets the PSD position distance threshold used in automatic weighting.

Parameters:distanceThreshold (float) – The PSD position threshold to set (distance).
Return type:bool
Returns:True if successful, otherwise False.
CAPoseMorphTag.GetMorphPSDID(morphIndex, psdAttributeID)

New in version R19.

Retrieves the description ID for the morph slider at morphIndex.

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.