CAPoseMorphTag Class Reference

#include <lib_ca.h>

Inheritance diagram for CAPoseMorphTag:

Detailed Description

Pose morph tag storing the morph data.

Note

Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

See also

CAMorphNode for an example.

Private Member Functions
	CAPoseMorphTag ()
	~CAPoseMorphTag ()

Alloc/Free
static CAPoseMorphTag *	Alloc ()
static void	Free (CAPoseMorphTag *&pTag)

Morph
Int32	GetMorphCount ()
CAMorph *	GetMorph (Int32 index)
DescID	GetMorphID (Int32 index)
Int32	GetActiveMorphIndex ()
CAMorph *	GetActiveMorph ()
CAMorph *	GetMorphBase ()
Int32	GetMorphIndex (CAMorph *morph)
void	SetActiveMorphIndex (Int32 index)
CAMorph *	AddMorph ()
void	RemoveMorph (Int32 index)

Miscellaneous
Int32	GetMode ()
void	InitMorphs ()
void	UpdateMorphs (BaseDocument *doc=nullptr)
Bool	ExitEdit (BaseDocument *doc, Bool noapply)

PSD
Vector	GetPSDFeedbackColor () const
Bool	SetPSDFeedbackColor (const Vector &color)
Bool	SetPSDFeedbackColorEnabled (Bool active)
Bool	GetPSDFeedbackColorEnabled () const
Float	GetPSDOrientThreshold () const
Bool	SetPSDOrientThreshold (Float radianThreshold)
Float	GetPSDTwistThreshold () const
Bool	SetPSDTwistThreshold (Float radianThreshold)
Float	GetPSDPositionThreshold () const
Bool	SetPSDPositionThreshold (Float distanceThreshold)
DescID	GetMorphPSDID (Int32 index, Int32 psdAttributeID)

Additional Inherited Members
Public Member Functions inherited from BaseTag
Bool	Draw (BaseObject *op, BaseDraw *bd, BaseDrawHelp *bh)
BaseTag *	GetNext ()
BaseTag *	GetPred ()
BaseObject *	GetObject ()
BaseTag *	GetOrigin ()
Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)
Bool	GetBit (Int32 mask) const
void	DelBit (Int32 mask)
void	ToggleBit (Int32 mask)
Int32	GetAllBits () const
void	SetAllBits (Int32 bits)
void	SetBitEx (Int32 mask, Int32 flags)
const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
BaseList2D *	GetNext ()
BaseList2D *	GetPred ()
BaseContainer	GetData ()
void	SetData (const BaseContainer &bc, Bool add=true)
const BaseContainer *	GetDataInstance () const
BaseContainer *	GetDataInstance ()
const BaseContainer &	GetDataInstanceRef () const
BaseContainer &	GetDataInstanceRef ()
String	GetName () const
void	SetName (const maxon::String &name)
String	GetBubbleHelp ()
Bool	TransferGoal (BaseList2D *dst, Bool undolink)
Bool	TransferMarker (BaseList2D *dst) const
Bool	Scale (Float scale)
Bool	Edit ()
void	GetIcon (IconData *dat)
GeListHead *	GetNLARoot ()
BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)
String	GetTypeName ()
BaseList2D *	GetMain () const
void	InsertTrackSorted (CTrack *track)
Bool	AddEventNotification (BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool	RemoveEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool	FindEventNotification (BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const
GeListHead *	GetOverrideRoot ()
BaseOverride *	GetFirstOverride ()
GeListHead *	GetShaderRepositoryRoot ()
GeListHead *	GetHiddenShaderRoot ()
maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)
void	RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const
Bool	IsNodeBased () const
void	GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
const GeMarker &	GetMarker () const
void	SetMarker (const GeMarker &m)
Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)
Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const
Int32	GetUniqueIDCount () const
Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
Bool	SetAnimatedParameter (CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)
Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)
BaseShader *	GetFirstShader () const
void	InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
void	ClearKeyframeSelection ()
Bool	FindKeyframeSelection (const DescID &id)
Bool	SetKeyframeSelection (const DescID &id, Bool selection)
Bool	KeyframeSelectionContent ()
LayerObject *	GetLayerObject (BaseDocument *doc)
Bool	SetLayerObject (LayerObject *layer)
const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool	SetLayerData (BaseDocument *doc, const LayerData &data)
GeListHead *	GetCTrackRoot ()
CTrack *	GetFirstCTrack ()
CTrack *	FindCTrack (const DescID &id)
Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()
GeListNode *	GetPred ()
GeListNode *	GetDown ()
GeListNode *	GetUp ()
GeListNode *	GetDownLast ()
void	InsertBefore (GeListNode *bl)
void	InsertAfter (GeListNode *bl)
void	InsertUnder (GeListNode *bl)
void	InsertUnderLast (GeListNode *bl)
void	Remove ()
GeListHead *	GetListHead ()
Int32	GetNodeID (Int32 index=0) const
template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const
template<typename CAST >
CAST *	GetNodeData (Int32 index=0)
void	SetCustomData (GeListNode *node)
GeListNode *	GetCustomData ()
BaseDocument *	GetDocument ()
Int32	GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool	IsDocumentRelated ()
Int32	GetInfo () const
Bool	GetNBit (NBIT bit) const
UInt32	GetNBitMask (Int32 index) const
Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)
Public Member Functions inherited from C4DAtom
Int32	GetType () const
Int32	GetRealType () const
Int32	GetDiskType () const
Bool	IsInstanceOf (Int32 id) const
Int32	GetClassification () const
Bool	Message (Int32 type, void *data=nullptr)
Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn)
Bool	CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool	Read (HyperFile *hf, Int32 id, Int32 level)
Bool	Write (HyperFile *hf)
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf)
Bool	GetDescription (Description *description, DESCFLAGS_DESC flags)
Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescription *	GetDynamicDescription ()
Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
UInt32	GetDirty (DIRTYFLAGS flags) const
void	SetDirty (DIRTYFLAGS flags)
UInt32	GetHDirty (HDIRTYFLAGS mask) const
void	SetHDirty (HDIRTYFLAGS mask)
Static Public Member Functions inherited from BaseTag
static BaseTag *	Alloc (Int32 type)
static void	Free (BaseTag *&bl)
Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)
static void	Free (BaseList2D *&bl)
Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY
static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

CAPoseMorphTag()

CAPoseMorphTag ( )

private

~CAPoseMorphTag()

~CAPoseMorphTag ( )

private

Member Function Documentation

Alloc()

static CAPoseMorphTag* Alloc ( )

static

Allocates a pose morph tag. Destroy the allocated pose morph tag with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns

The allocated pose morph tag, or nullptr if the allocation failed.

Free()

static void Free ( CAPoseMorphTag *&  pTag )

static

Destructs pose morph tags allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out]

pTag

The pose morph tag to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetMorphCount()

Int32 GetMorphCount

(

)

Retrieves the number of morphs targets as shown in the user interface. The value returned here indicates the maximum morph index, which is one less than this value due to being zero based.

Returns

The number of available morphs.

GetMorph()

CAMorph* GetMorph

(

Int32

index

)

Retrieves the morph at index. The parameter index is zero-based and index 0 will return the base morph, while the morphs starting from index 1 will be the user defined morphs.

Parameters

[in]

index

The morph index: 0 <= index < GetMorphCount()

Returns

The morph. The tag owns the pointed morph.

GetMorphID()

DescID GetMorphID

(

Int32

index

)

Retrieves the description ID for the morph slider at index.

Parameters

[in]

index

The morph index: 0 <= index < GetMorphCount()

Returns

The description ID of the morph slider.

GetActiveMorphIndex()

Int32 GetActiveMorphIndex

(

)

Retrieves the index of the active morph (usually the one selected in the list).

Returns

The index of the active morph.

GetActiveMorph()

CAMorph* GetActiveMorph

(

)

Retrieves the active morph (usually the one selected).

Returns

The active morph. The tag owns the pointed morph.

GetMorphBase()

CAMorph* GetMorphBase

(

)

Retrieves the base morph. Same as calling GetMorph(0).

Returns

The base morph. The tag owns the pointed morph.

GetMorphIndex()

Int32 GetMorphIndex

(

CAMorph *

morph

)

Retrieves the index for the given morph.

Parameters

[in]

morph

The morph.

Returns

The index for the morph.

SetActiveMorphIndex()

void SetActiveMorphIndex

(

Int32

index

)

Sets the active morph index.

Parameters

[in]

index

The active morph index to set: 0 <= index < GetMorphCount()

AddMorph()

CAMorph* AddMorph

(

)

Adds a new morph.

Returns

The newly added morph, or nullptr if it failed. The tag owns the pointed morph.

RemoveMorph()

void RemoveMorph

(

Int32

index

)

Removes the morph at index.

Parameters

[in]

index

The index of the morph to remove: 0 <= index < GetMorphCount()

GetMode()

Int32 GetMode

(

)

Retrieves the Edit/Animate mode (same as ID_CA_POSE_MODE in description/tcaposemorph.h)

Returns

The Edit/Animate mode. See ID_CA_POSE_MODE in description/tcaposemorph.h.

InitMorphs()

void InitMorphs

(

)

Initializes the morph tag.

Warning

Must be called after creating a morph tag and before adding anything to the tag.

UpdateMorphs()

void UpdateMorphs

(

BaseDocument *

doc = nullptr

)

Updates the tag's list and internal data.

Warning

Must be called after making changes to the tag is finished.

Parameters

[in]

doc

An optional document for the update of the morphs. The caller owns the pointed document.

ExitEdit()

Bool ExitEdit	(	BaseDocument *	doc,
		Bool	noapply
	)

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

[in]	doc	The document. The caller owns the pointed document.
[in]	noapply	Set to false if any user changes should be stored, otherwise set to true.

Returns

true if successful, otherwise false.

GetPSDFeedbackColor()

Vector GetPSDFeedbackColor

(

)

const

Retrieves the PSD color used for feedback.

Since

R19

Returns

The PSD feedback color.

SetPSDFeedbackColor()

Bool SetPSDFeedbackColor

(

const Vector &

color

)

Sets the PSD color used for feedback.

Since

R19

Parameters

[in]

color

The PSD feedback color to set.

Returns

true if successful, otherwise false.

SetPSDFeedbackColorEnabled()

Bool SetPSDFeedbackColorEnabled

(

Bool

active

)

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

Since

R19

Parameters

[in]

active

true to enable PSD color feedback, otherwise false.

Returns

true if successful, otherwise false.

GetPSDFeedbackColorEnabled()

Bool GetPSDFeedbackColorEnabled

(

)

const

Checks if PSD color feedback is enabled or disabled.

Since

R19

Returns

true if PSD color feedback is enabled, otherwise false.

GetPSDOrientThreshold()

Float GetPSDOrientThreshold

(

)

const

Retrieves the PSD orient radian threshold used in automatic weighting.

Since

R19

Returns

The PSD orient threshold (in radian).

SetPSDOrientThreshold()

Bool SetPSDOrientThreshold

(

Float

radianThreshold

)

Sets the PSD orient radian threshold used in automatic weighting.

Since

R19

Parameters

[in]

radianThreshold

The PSD orient threshold to set (in radian).

Returns

true if successful, otherwise false.

GetPSDTwistThreshold()

Float GetPSDTwistThreshold

(

)

const

Retrieves the PSD twist radian threshold used in automatic weighting.

Since

R19

Returns

The PSD twist threshold (in radian).

SetPSDTwistThreshold()

Bool SetPSDTwistThreshold

(

Float

radianThreshold

)

Sets the PSD twist radian threshold used in automatic weighting.

Since

R19

Parameters

[in]

radianThreshold

The PSD twist threshold to set (in radian).

Returns

true if successful, otherwise false.

GetPSDPositionThreshold()

Float GetPSDPositionThreshold

(

)

const

Retrieves the PSD position distance threshold used in automatic weighting.

Since

R19

Returns

The PSD position threshold (distance).

SetPSDPositionThreshold()

Bool SetPSDPositionThreshold

(

Float

distanceThreshold

)

Sets the PSD position distance threshold used in automatic weighting.

Since

R19

Parameters

[in]

distanceThreshold

The PSD position threshold to set (distance).

Returns

true if successful, otherwise false.

GetMorphPSDID()

DescID GetMorphPSDID	(	Int32	index,
		Int32	psdAttributeID
	)

Retrieves the description ID for the morph slider at index.

Since

R19

Parameters

[in]	index	The morph index: 0 <= index < GetMorphCount().
[in]	psdAttributeID	The attribute ID defined in tcaposemorph.h: ID_CA_POSE_PSD_ORIENT_INTERP_WEIGHT <= psdAttributeID < ID_CA_POSE_PSD_AUTOWEIGHT_INTERP.

Returns

The description ID of the specified attribute.