MTCharacterDefinitionTag Class Reference

#include <c4d_motiontransfer.h>

Inheritance diagram for MTCharacterDefinitionTag:

Detailed Description

Represents the Character Definition tag.

Private Member Functions

 MTCharacterDefinitionTag ()
 
 ~MTCharacterDefinitionTag ()
 

Alloc/Free

static MTCharacterDefinitionTagAlloc ()
 
static void Free (MTCharacterDefinitionTag *&tag)
 

Commands

maxon::Result< void > ExtractSkeleton (Bool undo)
 
maxon::Result< void > ExtractRestPose (Bool undo)
 
maxon::Result< void > ApplyRestPose (Bool undo)
 
maxon::Result< void > ClearRestPose (Bool undo)
 
maxon::Result< BaseTag * > CreateSolver (Bool undo)
 

Helpers

maxon::Result< MTCharacterBodyPart * > GetRootBodyPart ()
 
maxon::Result< void > SetRootBodyPart (MTCharacterBodyPart &rootBodyPart)
 

Additional Inherited Members

- Public Member Functions inherited from BaseTag
Bool Draw (BaseObject *op, BaseDraw *bd, BaseDrawHelp *bh)
 
BaseTagGetNext (void)
 
BaseTagGetPred (void)
 
BaseObjectGetObject (void)
 
BaseTagGetOrigin ()
 
- Public Member Functions inherited from BaseList2D
const CharGetViewportRenderId (VIEWPORT_RENDER_ID typeId) const
 
BaseList2DGetNext ()
 
BaseList2DGetPred ()
 
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)
 
BaseContainer GetData ()
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance () const
 
BaseContainerGetDataInstance ()
 
const BaseContainerGetDataInstanceRef () const
 
BaseContainerGetDataInstanceRef ()
 
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)
 
GeListHeadGetNLARoot ()
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
String GetTypeName ()
 
BaseList2DGetMain () 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
 
GeListHeadGetOverrideRoot ()
 
BaseOverrideGetFirstOverride ()
 
GeListHeadGetShaderRepositoryRoot ()
 
GeListHeadGetHiddenShaderRoot ()
 
maxon::NimbusForwardRef GetNimbusRef (const maxon::Id &spaceId) const
 
maxon::Result< maxon::NimbusForwardRefPrivateGetOrCreateNimbusRef (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 GeMarkerGetMarker () 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)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot ()
 
CTrackGetFirstCTrack ()
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext ()
 
GeListNodeGetPred ()
 
GeListNodeGetDown ()
 
GeListNodeGetUp ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove ()
 
GeListHeadGetListHead ()
 
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)
 
GeListNodeGetCustomData ()
 
BaseDocumentGetDocument ()
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated ()
 
Int32 GetInfo ()
 
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)
 
C4DAtomGetClone (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)
 
DynamicDescriptionGetDynamicDescription ()
 
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 BaseTagAlloc (Int32 type)
 
static void Free (BaseTag *&bl)
 
- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (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

◆ MTCharacterDefinitionTag()

◆ ~MTCharacterDefinitionTag()

Member Function Documentation

◆ Alloc()

static MTCharacterDefinitionTag* Alloc ( )
static

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

Returns
The allocated MTCharacterDefinition tag, or nullptr if the allocation failed.

◆ Free()

static void Free ( MTCharacterDefinitionTag *&  tag)
static

Destructs MTCharacterDefinition tag allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters
[in,out]tagThe MTCharacterDefinition tag to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ ExtractSkeleton()

maxon::Result<void> ExtractSkeleton ( Bool  undo)

Automatic body part extraction for the skeleton. This should be called only in the main thread.

Parameters
[in]undoAdd Character definition to the undo stack before any changes.
Returns
OK on success

◆ ExtractRestPose()

maxon::Result<void> ExtractRestPose ( Bool  undo)

Gets current skeleton pose and set it as rest pose. This should be called only in the main thread.

Parameters
[in]undoAdd Character definition to the undo stack before any changes.
Returns
OK on success

◆ ApplyRestPose()

maxon::Result<void> ApplyRestPose ( Bool  undo)

Applies the current rest pose. This should be called only in the main thread.

Parameters
[in]undoAdd Character definition to the undo stack before any changes.
Returns
OK on success

◆ ClearRestPose()

maxon::Result<void> ClearRestPose ( Bool  undo)

Clears the current rest pose. This should be called only in the main thread.

Parameters
[in]undoAdd Character definition to the undo stack before any changes.
Returns
OK on success

◆ CreateSolver()

maxon::Result<BaseTag*> CreateSolver ( Bool  undo)

Creates a solver and assign to the object owner. This should be called only in the main thread.

Parameters
[in]undoAdd Character definition to the undo stack before any changes.
Returns
new created MTCharacterMotionTransferTag on success

◆ GetRootBodyPart()

maxon::Result<MTCharacterBodyPart*> GetRootBodyPart ( )

Returns a copy of the body part hierarchy. Memory management is on the client side, use MTCharacterBodyPart::Free() to avoid Leaks

Returns
MTCharacterBodyPart on success

◆ SetRootBodyPart()

maxon::Result<void> SetRootBodyPart ( MTCharacterBodyPart rootBodyPart)

Sets the body part hierarchy. rootBodyPart is not kept, memory management is on the client side, use MTCharacterBodyPart::Free() to avoid Leaks.

Parameters
[in]rootBodyPartMTCharacterBodyPart representing the BodyPart hierarchy.
Returns
OK on success