#include <lib_ca.h>

Detailed Description

CAMorphNode class allows to access the actual morph data. For every morph there exist a morph node tree representing the hierarchy of the morphed objects.
Before using any of the access function always check which data exist with GetInfo(). Also make sure the data has been expanded with CAMORPH_MODE_FLAGS::EXPAND in SetMode().
Example of a simple case with one polygon object. In this case just access the first morph node of the morph to be changed.
First exit any editing:

mtag->ExitEdit(doc, true);

doc

const char * doc

Definition: pyerrors.h:226

Get the morph to be changed:

CAMorph* morph = mtag->GetMorph(1);

CAMorph

Definition: lib_ca.h:1429

Now get the morph node. The first will be the object with the morph tag:

CAMorphNode* mnode = morph->GetFirst();

CAMorph::GetFirst

CAMorphNode * GetFirst()

CAMorphNode

Definition: lib_ca.h:1071

Data must be made editable

morph->SetMode(doc, mtag, CAMORPH_MODE_FLAGS::ALL|CAMORPH_MODE_FLAGS::EXPAND,CAMORPH_MODE::ABS);

CAMorph::SetMode

Bool SetMode(BaseDocument *doc, CAPoseMorphTag *tag, CAMORPH_MODE_FLAGS flags, CAMORPH_MODE mode)

CAMORPH_MODE_FLAGS::ALL

@ ALL

Expand or collapse all data.

CAMORPH_MODE_FLAGS::EXPAND

@ EXPAND

Expand data. Needs to be passed before accessing any data.

CAMORPH_MODE::ABS

@ ABS

Absolute morph data.

The point data can now be accessed, but make sure the data exists:

mnode->GetInfo() & CAMORPH_DATA_FLAGS::POINTS

CAMorphNode::GetInfo

CAMORPH_DATA_FLAGS GetInfo()

CAMORPH_DATA_FLAGS::POINTS

@ POINTS

Points morphing.

To access the data use GetPointCount(), SetPointCount(), GetPoint() and SetPoint().
Once finished put the data back to its original form:

morph->SetMode(doc, mtag, CAMORPH_MODE_FLAGS::ALL|CAMORPH_MODE_FLAGS::COLLAPSE,CAMORPH_MODE::AUTO);

CAMORPH_MODE_FLAGS::COLLAPSE

@ COLLAPSE

Collapse data. Needs to be passed to collapse the expanded data, for instance after data access.

CAMORPH_MODE::AUTO

@ AUTO

Auto mode. Used to collapse the data automatically into their correct mode.

Finally the tag must be updated:

mtag->UpdateMorphs();

Private Member Functions
	CAMorphNode ()

	~CAMorphNode ()

Navigation
CAMorphNode *	GetNext ()

CAMorphNode *	GetPrev ()

CAMorphNode *	GetUp ()

CAMorphNode *	GetDown ()

Get Link
BaseList2D *	GetLink (CAPoseMorphTag tag, CAMorph morph, BaseDocument *doc)

Get Info
CAMORPH_DATA_FLAGS	GetInfo ()

Get/Set Positon/Scale/Rotation
Vector	GetP ()

Vector	GetS ()

Vector	GetR ()

void	SetP (const Vector &p)

void	SetS (const Vector &s)

void	SetR (const Vector &r)

Point
Int32	GetPointCount ()

Bool	SetPointCount (Int32 cnt)

Vector	GetPoint (Int32 index)

void	SetPoint (Int32 index, const Vector &pnt)

Tangent
Int32	GetTangentCount ()

Bool	SetTangentCount (Int32 cnt)

Vector	GetTangent (Int32 index)

void	SetTangent (Int32 index, const Vector &v)

Vertex Map
Int32	GetVertexMapTagCount ()

Int32	GetVertexMapCount (Int32 tindex)

Bool	SetVertexMapCount (Int32 tindex, Int32 cnt)

Float	GetVertexMap (Int32 tindex, Int32 index)

void	SetVertexMap (Int32 tindex, Int32 index, Float v)

Parameters
Int32	GetParamCount ()

Bool	SetParamCount (Int32 cnt)

Bool	GetParam (Int32 index, GeData &data, DescID &id)

void	SetParam (Int32 index, const GeData &data, const DescID &id)

UV
Int32	GetUVTagCount ()

Int32	GetUVCount (Int32 tindex)

Bool	SetUVCount (Int32 tindex, Int32 cnt)

void	GetUV (Int32 tindex, Int32 index, UVWStruct &uv)

void	SetUV (Int32 tindex, Int32 index, const UVWStruct &uv)

Weight Map
Int32	GetWeightMapTagCount ()

Int32	GetWeightMapJointCount (Int32 tindex)

Int32	GetWeightMapCount (Int32 tindex, Int32 jindex)

Bool	SetWeightMapCount (Int32 tindex, Int32 jindex, Int32 cnt)

Float	GetWeightMap (Int32 tindex, Int32 jindex, Int32 index)

void	SetWeightMap (Int32 tindex, Int32 jindex, Int32 index, Float v)

PSD Reference
CAReferencePSD *	GetPSDReference ()

Constructor & Destructor Documentation

◆ CAMorphNode()

CAMorphNode ( )

private

◆ ~CAMorphNode()

~CAMorphNode ( )

private

Member Function Documentation

◆ GetNext()

CAMorphNode* GetNext ( )

Retrieves the next morph node.

Returns: The next morph node, or nullptr if there is none. Cinema 4D owns the pointed morph node.

◆ GetPrev()

CAMorphNode* GetPrev ( )

Retrieves the previous morph node.

Returns: The previous morph node, or nullptr if there is none. Cinema 4D owns the pointed morph node.

◆ GetUp()

CAMorphNode* GetUp ( )

Retrieves the parent morph node.

Returns: The parent morph node, or nullptr if there is none. Cinema 4D owns the pointed morph node.

◆ GetDown()

CAMorphNode* GetDown ( )

Retrieves the first child morph node.

Returns: The first child morph node, or nullptr if there is none. Cinema 4D owns the pointed morph node.

◆ GetLink()

BaseList2D* GetLink	(	CAPoseMorphTag *	tag,
		CAMorph *	morph,
		BaseDocument *	doc
	)

Retrieves the object linked to the morph node.

Parameters

[in]	tag	The morph tag containing the morph data.
[in]	morph	The morph containing the morph node.
[in]	doc	The document containing the linked object.

Returns: The linked object, or nullptr if there is none. Cinema 4D owns the pointed object.

◆ GetInfo()

CAMORPH_DATA_FLAGS GetInfo ( )

Gets what morph data is stored in the morph node.

Returns: The data flags: CAMORPH_DATA_FLAGS

◆ GetP()

Vector GetP ( )

Retrieves the position of the morph node.

Returns: The position.

◆ GetS()

Vector GetS ( )

Retrieves the scale of the morph node.

Returns: The scale.

◆ GetR()

Vector GetR ( )

Retrieves the HPB rotation of the morph node.

Returns: The HPB rotation.

◆ SetP()

void SetP ( const Vector & p )

Sets the position of the morph node.

Parameters

[in] p The new position.

◆ SetS()

void SetS ( const Vector & s )

Sets the scale of the morph node.

Parameters

[in] s The new scale.

◆ SetR()

void SetR ( const Vector & r )

Sets the HPB rotation.

Parameters

[in] r The new HPB rotation.

◆ GetPointCount()

Int32 GetPointCount ( )

Retrieves the point count of the morph node.

Returns: The point count.

◆ SetPointCount()

Bool SetPointCount ( Int32 cnt )

Sets the point count of the morph node.

Parameters

[in] cnt The new point count.

Returns: true if successful, otherwise false.

◆ GetPoint()

Vector GetPoint ( Int32 index )

Retrieves the point at index.

Parameters

[in] index The point index: 0 <= index < GetPointCount()

Returns: The point at index.

◆ SetPoint()

void SetPoint	(	Int32	index,
		const Vector &	pnt
	)

Sets the point at index.

Parameters

[in]	index	The point index: 0 <= index < GetPointCount()
[in]	pnt	The new point coordinate.

◆ GetTangentCount()

Int32 GetTangentCount ( )

Retrieves the tangent count of the morph node.

Returns: The tangent count.

◆ SetTangentCount()

Bool SetTangentCount ( Int32 cnt )

Sets the tangent count of the morph node.

Parameters

[in] cnt The new tangent count.

Returns: true if successful, otherwise false.

◆ GetTangent()

Vector GetTangent ( Int32 index )

Retrieves the tangent at index.

Parameters

[in] index The tangent index: 0 <= index < GetTangentCount()

Returns: The tangent at index.

◆ SetTangent()

void SetTangent	(	Int32	index,
		const Vector &	v
	)

Sets the tangent at index.

Parameters

[in]	index	The tangent index: 0 <= index < GetPointCount()
[in]	v	The new tangent coordinate.

◆ GetVertexMapTagCount()

Int32 GetVertexMapTagCount ( )

Retrieves the number of vertex map tags of the morph node.

Returns: The number of vertex map tags.

◆ GetVertexMapCount()

Int32 GetVertexMapCount ( Int32 tindex )

Retrieves the size of the vertex map at tindex.

Parameters

[in] tindex The vertex map tag index: 0 <= tindex < GetVertexMapTagCount()

Returns: The size of the vertex map at tindex.

◆ SetVertexMapCount()

Bool SetVertexMapCount	(	Int32	tindex,
		Int32	cnt
	)

Sets the size of the vertex map at tindex.

Parameters

[in]	tindex	The vertex map tag index: 0 <= tindex < GetVertexMapTagCount()
[in]	cnt	The new size of the vertex map at tindex.

Returns: true if successful, otherwise false.

◆ GetVertexMap()

Float GetVertexMap	(	Int32	tindex,
		Int32	index
	)

Retrieves the vertex map value at index of the tindex vertex map.

Parameters

[in]	tindex	The vertex map tag index: 0 <= tindex < GetVertexMapTagCount()
[in]	index	The vertex map index. 0 <= index < GetVertexMapCount()

Returns: The vertex map value.

◆ SetVertexMap()

void SetVertexMap	(	Int32	tindex,
		Int32	index,
		Float	v
	)

Sets the vertex map value at index of the tindex vertex map.

Parameters

[in]	tindex	The vertex map tag index: 0 <= tindex < GetVertexMapTagCount()
[in]	index	The vertex map index. 0 <= index < GetVertexMapCount()
[in]	v	The new vertex map value.

◆ GetParamCount()

Int32 GetParamCount ( )

Retrieves the number of parameters for the morph node.

Returns: The number of parameters.

◆ SetParamCount()

Bool SetParamCount ( Int32 cnt )

Sets the number of parameters for the morph node.

Parameters

[in] cnt The new number of parameters.

Returns: true if successful, otherwise false.

◆ GetParam()

Bool GetParam	(	Int32	index,
		GeData &	data,
		DescID &	id
	)

Retrieves the parameter at index for the morph node.

Parameters

[in]	index	The parameter index: 0 <= index < GetParamCount()
[out]	data	Assigned the parameter value.
[out]	id	Assigned the description ID of the parameter.

Returns: true if successful, otherwise false.

◆ SetParam()

void SetParam	(	Int32	index,
		const GeData &	data,
		const DescID &	id
	)

Sets the parameter at index for the morph node.

Parameters

[in]	index	The parameter index: 0 <= index < GetParamCount()
[in]	data	The new parameter value.
[in]	id	The new parameter description ID.

◆ GetUVTagCount()

Int32 GetUVTagCount ( )

Retrieves the number of UV tags.

Returns: The number of UV tags.

◆ GetUVCount()

Int32 GetUVCount ( Int32 tindex )

Retrieves the UV coordinates count of the UV tag at tindex.

Parameters

[in] tindex The UV tag index: 0 <= tindex < GetUVTagCount()

Returns: The UV coordinates count.

◆ SetUVCount()

Bool SetUVCount	(	Int32	tindex,
		Int32	cnt
	)

Sets the UV coordinates count of the UV tag at tindex.

Parameters

[in]	tindex	The UV tag index: 0 <= tindex < GetUVTagCount()
[in]	cnt	The new UV coordinates count.

Returns: true if successful, otherwise false.

◆ GetUV()

void GetUV	(	Int32	tindex,
		Int32	index,
		UVWStruct &	uv
	)

Retrieves the UV coordinate index of the tindex UV tag.

Parameters

[in]	tindex	The UV tag index: 0 <= tindex < GetUVTagCount()
[in]	index	The UV coordinates index: 0 <= index < GetUVCount()
[out]	uv	Assigned the UV coordinates.

◆ SetUV()

void SetUV	(	Int32	tindex,
		Int32	index,
		const UVWStruct &	uv
	)

Sets the UV coordinate index of the tindex UV tag.

Parameters

[in]	tindex	The UV tag index: 0 <= tindex < GetUVTagCount()
[in]	index	The UV coordinates index: 0 <= index < GetUVCount()
[in]	uv	The new UV coordinates.

◆ GetWeightMapTagCount()

Int32 GetWeightMapTagCount ( )

Retrieves the number of weight map tags.

Returns: The number of weight map tags.

◆ GetWeightMapJointCount()

Int32 GetWeightMapJointCount ( Int32 tindex )

Retrieves the joint count of the weight tag at tindex.

Parameters

[in] tindex The weight tag index: 0 <= tindex < GetWeightMapTagCount()

Returns: The joint count of the specified weight tag.

◆ GetWeightMapCount()

Int32 GetWeightMapCount	(	Int32	tindex,
		Int32	jindex
	)

Retrieves the weights count of the joint at jindex of tindex weight tag.

Parameters

[in]	tindex	The weight tag index: 0 <= tindex < GetWeightMapTagCount()
[in]	jindex	The joint index: 0 <= jindex < GetWeightMapJointCount()

Returns: The weight count of the specified joint.

◆ SetWeightMapCount()

Bool SetWeightMapCount	(	Int32	tindex,
		Int32	jindex,
		Int32	cnt
	)

Sets the weights count of the joint at jindex of tindex weight tag.

Parameters

[in]	tindex	The weight tag index: 0 <= tindex < GetWeightMapTagCount()
[in]	jindex	The joint index: 0 <= jindex < GetWeightMapJointCount()
[in]	cnt	The new weight count.

Returns: true if successful, otherwise false.

◆ GetWeightMap()

Float GetWeightMap	(	Int32	tindex,
		Int32	jindex,
		Int32	index
	)

Retrieves the weight at index of jindex joint and tindex Weight tag.

Parameters

[in]	tindex	The weight tag index: 0 <= tindex < GetWeightMapTagCount()
[in]	jindex	The joint index: 0 <= jindex < GetWeightMapJointCount()
[in]	index	The weight index: 0 <= index < GetWeightMapCount()

Returns: The weight.

◆ SetWeightMap()

void SetWeightMap	(	Int32	tindex,
		Int32	jindex,
		Int32	index,
		Float	v
	)

Sets the weight at index of jindex joint and tindex Weight tag.

Parameters

[in]	tindex	The weight tag index: 0 <= tindex < GetWeightMapTagCount()
[in]	jindex	The joint index: 0 <= jindex < GetWeightMapJointCount()
[in]	index	The weight index: 0 <= index < GetWeightMapCount()
[in]	v	The new weight.

◆ GetPSDReference()

CAReferencePSD* GetPSDReference ( )

Retrieves the PSD data for a point pose holding the reference pose and providing multiple functions dedicated to PSD behavior.

Since: R19

Returns: The PSD referential for the morph node. The CAMorphNode owns the pointed CAReferencePSD.

Detailed Description

Private Member Functions

Navigation

Get Link

Get Info

Get/Set Positon/Scale/Rotation

Point

Tangent

Vertex Map

Parameters

UV

Weight Map

PSD Reference

Constructor & Destructor Documentation

◆ CAMorphNode()

◆ ~CAMorphNode()

Member Function Documentation

◆ GetNext()

◆ GetPrev()

◆ GetUp()

◆ GetDown()

◆ GetLink()

◆ GetInfo()

◆ GetP()

◆ GetS()

◆ GetR()

◆ SetP()

◆ SetS()

◆ SetR()

◆ GetPointCount()

◆ SetPointCount()

◆ GetPoint()

◆ SetPoint()

◆ GetTangentCount()

◆ SetTangentCount()

◆ GetTangent()

◆ SetTangent()

◆ GetVertexMapTagCount()

◆ GetVertexMapCount()

◆ SetVertexMapCount()

◆ GetVertexMap()

◆ SetVertexMap()

◆ GetParamCount()

◆ SetParamCount()

◆ GetParam()

◆ SetParam()

◆ GetUVTagCount()

◆ GetUVCount()

◆ SetUVCount()

◆ GetUV()

◆ SetUV()

◆ GetWeightMapTagCount()

◆ GetWeightMapJointCount()

◆ GetWeightMapCount()

◆ SetWeightMapCount()

◆ GetWeightMap()

◆ SetWeightMap()

◆ GetPSDReference()