IDs and information for Tphconstraintmask

Tphconstraintmask

Attributes

• ENGLISH NAME : MaskConstraint
• NAME : Tphconstraintmask
• INCLUDE : Tbase
• PATH : motiontracker/description/tphconstraintmask.res
• PLUGIN : motiontracker
• MAXON online help (may not exist): TPHCONSTRAINTMASK

Elements

ID	UI Name	Type	Parameters	Cycle
PH_SCENE_CAL_MASK_ADDSUB_MODE	Tracking	LONG	ANIM	PH_SCENE_CAL_MASK_ADDSUB_MODE_SUB ExcludeFromMask PH_SCENE_CAL_MASK_ADDSUB_MODE_ADD IncludeInMask
PH_SCENE_CAL_MASK_FIRST_FRAME	ActiveFrom	LONG	ANIM
PH_SCENE_CAL_MASK_LAST_FRAME	ActiveTo	LONG	ANIM
PH_SCENE_CAL_MASK_FORCE_UPDATE	Update2DTrackingResult	BUTTON
PH_SCENE_CAL_MASK_DISPLAY_MASK	DisplayMask	BOOL	ANIM
PH_SCENE_CAL_MASK_DISPLAY_COLOUR	MaskColor	COLOR

Example Code

The following code does not use the correct values when setting the data. You should check directly in C4D for the correct values that you should use in place of the ones that are shown. This code is just to show you how to access the values for getting and setting the parameters.

Python

import c4d
from c4d import gui
def main():
    obj = c4d.BaseObject(c4d.Osphere)
    tag = obj.MakeTag(c4d.Tphconstraintmask)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.PH_SCENE_CAL_MASK_ADDSUB_MODE] = c4d.PH_SCENE_CAL_MASK_ADDSUB_MODE_SUB
    tag[c4d.PH_SCENE_CAL_MASK_FIRST_FRAME] = 1
    tag[c4d.PH_SCENE_CAL_MASK_LAST_FRAME] = 1
    tag[c4d.PH_SCENE_CAL_MASK_DISPLAY_MASK] = True
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetInt32(c4d.PH_SCENE_CAL_MASK_ADDSUB_MODE,c4d.PH_SCENE_CAL_MASK_ADDSUB_MODE_SUB)
    bc.SetInt32(c4d.PH_SCENE_CAL_MASK_FIRST_FRAME,1)
    bc.SetInt32(c4d.PH_SCENE_CAL_MASK_LAST_FRAME,1)
    bc.SetBool(c4d.PH_SCENE_CAL_MASK_DISPLAY_MASK,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../motiontracker/description/tphconstraintmask.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osphere);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDOTYPE_NEW,pObject);
    pDoc->EndUndo();
    pDoc->StartUndo();
    BaseTag *pTag = pObject->MakeTag(Tphconstraintmask);
    pDoc->AddUndo(UNDOTYPE_NEW,pTag);
    pDoc->EndUndo();
    pObject->Message(MSG_UPDATE);
    
    //You can set parameters two different ways. 

    //First way              
    //Some objects do not store all their data in the container. You need to use GetParameter()/SetParameter() instead. 

    DESCFLAGS_SET flags = DESCFLAGS_SET_PARAM_SET;
    pTag->SetParameter(DescID(PH_SCENE_CAL_MASK_ADDSUB_MODE),GeData(PH_SCENE_CAL_MASK_ADDSUB_MODE_SUB),flags);
    pTag->SetParameter(DescID(PH_SCENE_CAL_MASK_FIRST_FRAME),GeData(1),flags);
    pTag->SetParameter(DescID(PH_SCENE_CAL_MASK_LAST_FRAME),GeData(1),flags);
    pTag->SetParameter(DescID(PH_SCENE_CAL_MASK_DISPLAY_MASK),GeData(true),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetInt32(PH_SCENE_CAL_MASK_ADDSUB_MODE,PH_SCENE_CAL_MASK_ADDSUB_MODE_SUB);
    bc->SetInt32(PH_SCENE_CAL_MASK_FIRST_FRAME,1);
    bc->SetInt32(PH_SCENE_CAL_MASK_LAST_FRAME,1);
    bc->SetBool(PH_SCENE_CAL_MASK_DISPLAY_MASK,true);
    pTag->Message(MSG_UPDATE);                                                      
}
             

Buttons

This node has buttons. Buttons can manually be executed by calling the following code

Python

c4d.CallButton(tag,c4d.PH_SCENE_CAL_MASK_FORCE_UPDATE)

C++

DescriptionCommand dc;
dc.id = DescID(PH_SCENE_CAL_MASK_FORCE_UPDATE);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);