IDs and information for Tphconstraintplanar

Tphconstraintplanar

Attributes

• ENGLISH NAME : PlanarConstraint
• NAME : Tphconstraintplanar
• INCLUDE : Tbase
• PATH : motiontracker/description/tphconstraintplanar.res
• PLUGIN : motiontracker
• MAXON online help (may not exist): TPHCONSTRAINTPLANAR

Elements

ID	UI Name	Type	Parameters	Cycle
PH_SCENE_CAL_PLANAR_MODE	Mode	LONG	ANIM	PH_SCENE_CAL_PLANAR_MODE_CAMTRACK CameraTrackdefinesPlane PH_SCENE_CAL_PLANAR_MODE_SELECT FeaturesDefinePlane
PH_SCENE_CAL_PLANAR_AXIS	Axis	LONG	ANIM	PH_SCENE_CAL_PLANAR_AXIS_NONE None PH_SCENE_CAL_PLANAR_AXIS_X X PH_SCENE_CAL_PLANAR_AXIS_Y Y PH_SCENE_CAL_PLANAR_AXIS_Z Z
PH_SCENE_CAL_PLANAR_FLIP_AXIS	ReverseAxis	BOOL	ANIM
PH_SCENE_CAL_PLANAR_TARGET_SET	Selection	IN_EXCLUDE	NUM_FLAGS 0 INIT_STATE 0
PH_SCENE_CAL_PLANAR_CREATE_SCENE_PLANE	CreatePlane	BUTTON
PH_SCENE_CAL_PLANAR_FORCE_EXPORT	UpdateCalibration	BUTTON

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.Tphconstraintplanar)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.PH_SCENE_CAL_PLANAR_MODE] = c4d.PH_SCENE_CAL_PLANAR_MODE_CAMTRACK
    tag[c4d.PH_SCENE_CAL_PLANAR_AXIS] = c4d.PH_SCENE_CAL_PLANAR_AXIS_NONE
    tag[c4d.PH_SCENE_CAL_PLANAR_FLIP_AXIS] = True
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetInt32(c4d.PH_SCENE_CAL_PLANAR_MODE,c4d.PH_SCENE_CAL_PLANAR_MODE_CAMTRACK)
    bc.SetInt32(c4d.PH_SCENE_CAL_PLANAR_AXIS,c4d.PH_SCENE_CAL_PLANAR_AXIS_NONE)
    bc.SetBool(c4d.PH_SCENE_CAL_PLANAR_FLIP_AXIS,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../motiontracker/description/tphconstraintplanar.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(Tphconstraintplanar);
    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_PLANAR_MODE),GeData(PH_SCENE_CAL_PLANAR_MODE_CAMTRACK),flags);
    pTag->SetParameter(DescID(PH_SCENE_CAL_PLANAR_AXIS),GeData(PH_SCENE_CAL_PLANAR_AXIS_NONE),flags);
    pTag->SetParameter(DescID(PH_SCENE_CAL_PLANAR_FLIP_AXIS),GeData(true),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetInt32(PH_SCENE_CAL_PLANAR_MODE,PH_SCENE_CAL_PLANAR_MODE_CAMTRACK);
    bc->SetInt32(PH_SCENE_CAL_PLANAR_AXIS,PH_SCENE_CAL_PLANAR_AXIS_NONE);
    bc->SetBool(PH_SCENE_CAL_PLANAR_FLIP_AXIS,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_PLANAR_CREATE_SCENE_PLANE)
c4d.CallButton(tag,c4d.PH_SCENE_CAL_PLANAR_FORCE_EXPORT)

C++

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


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