##

##
##
##
##
##
##
##

3DEqualizer4 Release 3
Python Interface Command Summary
(c) Science.D.Visions

###################
# definitions...
<vector 2d>
= [<double>,<double>]
<vector 3d>
= [<double>,<double>,<double>]
<matrix 3d>
= [ [<double>,<double>,<double>],[<double>,<doub
le>,<double>],[<double>,<double>,<double>] ]
<tracking curve>
= [<vector 2d>,<vector2d>...]
<survey mode>
= "SURVEY_FREE"|"SURVEY_APPROX"|"SURVEY_EXACT"|"
SURVEY_LINEUP"
<calc mode>
= "CALC_OFF"|"CALC_PASSIVE"|"CALC_ACTIVE"
<curve mode>
= "ROTPOS_CURVES"|"ZOOM_CURVES"|"STEREO_CURVES"|
"DISTORTION_CURVES"
<tracking_mode>
= "TRACKING_PATTERN"|"TRACKING_MARKER"|"TRACKING
_CORNER"
<tracking_direction>
= "TRACKING_FW"|"TRACKING_BW"|"TRACKING_FW_BW"
<para_type>
= "LDP_STRING"|"LDP_DOUBLE"|"LDP_INT"|"LDP_FILE"
|"LDP_TOGGLE"|"LDP_DOUBLE_ADJUST"
<postfilter_mode>
= "POSTFILTER_OFF"|"POSTFILTER_SMOOTHING"|"POSTF
ILTER_SMOOTHING_FOURIER"
<stereo_mode>
= "STEREO_OFF"|"STEREO_PRIMARY"|"STEREO_SECONDAR
Y"
<stereo_orientation>
= "STEREO_LEFT"|"STEREO_RIGHT"
<blur_mode>
= "BLUR_NONE"|"BLUR_3X3"|"BLUR_5X5"
<point_status>
= "POINT_KEYFRAME"|"POINT_KEYFRAME_END"|"POINT_O
BSOLETE"|"POINT_TRACKED"|"POINT_INTERPOLATED"|"POINT_UNDEFINED"
<hom_calc_mode>
= "HOM_TY"|"HOM_STY"|"HOM_RTY"|"HOM_SRTY"|"HOM_S
RTYP"|"HOM_T"|"HOM_ST"|"HOM_RT"|"HOM_SRT"|"HOM_SRTP"|"HOM_HOM"
<stereo_interocular>
= "STEREO_IO_STATIC"|"STEREO_IO_DYNAMIC"
<focal length mode>
= "FOCAL_USE_FROM_LENS"|"FOCAL_STATIC"|"FOCAL_DY
NAMIC"
<focus mode>
= "FOCUS_USE_FROM_LENS"|"FOCUS_STATIC"|"FOCUS_DY
NAMIC"
<matrix_point_status>
= "MATRIX_POINT_RELEASED"|"MATRIX_POINT_USER"|"M
ATRIX_POINT_AUTO"
<widget_attach_mode>
= "ATTACH_WIDGET"|"ATTACH_OPPOSITE_WIDGET"|"ATTA
CH_WINDOW"|"ATTACH_OPPOSITE_WINDOW"|"ATTACH_POSITION"|"ATTACH_NONE"|"ATTACH_AS_I
S"
<ref_pattern_mode>
= "REF_PATTERN_PREVIOUS_FRAME"|"REF_PATTERN_PREV
IOUS_KEYFRAME"|"REF_PATTERN_FIRST_KEYFRAME"|"REF_PATTERN_EXPLICIT_FRAME"
<parameter_type>
= "ADJUST_LENS_FBACK_WIDTH"|"ADJUST_LENS_FBACK_H
EIGHT"|"ADJUST_LENS_FOCAL_LENGTH"|"ADJUST_LENS_FILM_ASPECT"|"ADJUST_LENS_LCO_X"|
"ADJUST_LENS_LCO_Y"|
"ADJUST_LENS_PIXEL_ASPECT"|"ADJUST_LENS_CUSTOM
_FOCUS"|"ADJUST_LENS_DISTORTION_PARAMETER"|"ADJUST_CAMERA_SYNC_TIMESHIFT"|"ADJUS
T_CAMERA_STEREO_VERTICAL_SHIFT"|
"ADJUST_CAMERA_STEREO_DEPTH_SHIFT"|"ADJUST_CAM
ERA_STEREO_INTEROCULAR"|"ADJUST_CAMERA_ROLLING_SHUTTER"
<dynamic_distortion_mode>
= "DISTORTION_STATIC"|"DISTORTION_DYNAMIC_FOCAL_
LENGTH"|"DISTORTION_DYNAMIC_FOCUS_DISTANCE"
<script_call_hint>
= "CALL_COMMAND_LINE"|"CALL_WIDGET_CALLBACK"|"CA

LL_UPDATE_CALLBACK"|"CALL_CREATE_NEW_POINT_CALLBACK"|"CALL_GUI_CONTEXT_MENU"|"CA
LL_GUI_MENU"|"CALL_GUI_BUTTON"|"CALL_STARTUP"
<sync_mode>
= "SYNC_OFF"|"SYNC_PRIMARY"|"SYNC_SECONDARY"
<bf_culling_mode>
= "BF_CULLING_OFF"|"BF_CULLING_REGULAR"|"BF_CULL
ING_INVERTED"
############
# misc...
<3de_install_path>
<3de_version>

get3DEInstallPath()
get3DEVersion()

<vector 2d>
2d>)
<vector 2d>
2d>)

removeDistortion2D(<camera_id>, <frame>, <vector

[m00,m01,m10,m11]
e>, <vector 2d>)

getDistortion2DJacobianMatrix(<camera_id>, <fram

[double,double,...]
_FILTER"|"GAUSS_FILTER")

filter1D([double,double,...], <cutoff>, "FOURIER

<double>
<double>
<double>
<double>
<double>
<double>

acos(<double>)
asin(<double>)
atan2(<double>, <double>)
cos(<double>)
sin(<double>)
sqrt(<double>)

applyDistortion2D(<camera_id>, <frame>, <vector

<matrix 3d>
calcHomography2D([<vector 2d>,<vector 2d>,...],
[<vector 2d>,<vector 2d>,...], [<weight>,<weight>,...], <pivot 2d>, <hom_calc_mo
de>)
<string>

getProjectNotes()
setProjectNotes(<string>)

<double>

getNearClippingPlane()
setNearClippingPlane(<double>)
getFarClippingPlane()
setFarClippingPlane(<double>)

<double>

0|1
checkPointConsistency2D(<pgroup_id>, <point_id>,
<camera_id>, <frame_a>, <frame_b>, <sensitivity>)
[<matrix 3d>,<vector 3d>]
.])

alignPlaneToPoints3D([<vector 3d>,<vector 3d>,..

########################################
# custom gui, requester and widgets...
<int>
<label 0>, <label 1> ,...)
<path>
n>, <default path>)

postQuestionRequester(<window title>, <message>,

postFileRequester(<window title>, <filter_patter
postProgressRequesterAndContinue(<window title>,

<message>, <max_progress>, <label 0>, <label 1> ,...)

<int>
updateProgressRequester(<progress>, <message>)
unpostProgressRequester()
<requester id>

createCustomRequester()
deleteCustomRequester(<requester id>)
<int>
postCustomRequester(<requester id>, <window titl
e>, <width>, <height>, <label 0>, <label 1> ,...)
postCustomRequesterAndContinue(<requester id>, <
window title>, <width>, <height>, <update callback function name>)
unpostCustomRequester(<requester id>)
addFileWidget(<requester id>, <widget name>, <la
bel>, <filter_pattern>, <default path>)
addTextFieldWidget(<requester id>, <widget name>
, <label>, <default string>)
addToggleWidget(<requester id>, <widget name>, <
label>, 0|1)
addOptionMenuWidget(<requester id>, <widget name
>, <label>, <string 1>, <string 2> ,...)
modifyOptionMenuWidget(<requester id>, <widget n
ame>, <label>, <string 1>, <string 2> ,...)
addScaleWidget(<requester id>, <widget name>, <l
abel>, "INT"|"DOUBLE", <min>, <max>, <default value>)
addButtonWidget(<requester id>, <widget name>, <
label>, <width>, <offset>, <right_of_widget>)
addSeparatorWidget(<requester id>, <widget name>
)
addListWidget(<requester id>, <widget name>, <la
bel>, <multi_selection>, <height>)
insertListWidgetItem(<requester id>, <widget nam
e>, <label>, <userdata>)
removeListWidgetItem(<requester id>, <widget nam
e>, <item_index>)
removeAllListWidgetItems(<requester id>, <widget
name>)
<number_of_items>
getListWidgetNoItems(<requester id>, <widget nam
e>)
<label>
getListWidgetItemLabel(<requester id>, <widget n
ame>, <item_index>)
<userdata>
getListWidgetItemUserdata(<requester id>, <widge
t name>, <item_index>)
0|1
getListWidgetItemSelectionFlag(<requester id>, <
widget name>, <item_index>)
setListWidgetItemSelectionFlag(<requester id>, <
widget name>, <item_index>, 0|1)
centerListWidgetFirstSelectedItem(<requester id>
, <widget name>)
addCurveAreaWidget(<requester id>, <widget name>
, <label>, <height>)
setCurveAreaWidgetDimensions(<requester id>, <wi
dget name>, <x_min>, <x_max>, <y_min>, <y_max>)

setCurveAreaWidgetFOV(<requester id>, <widget na

me>, <x1>, <x2>, <y1>, <y2>)
setCurveAreaWidgetCursorPosition(<requester id>,
<widget name>, <x>, <stepping>)
<x>
getCurveAreaWidgetCursorPosition(<requester id>,
<widget name>)
attachCurveAreaWidgetCurve(<requester id>, <widg
et name>, <curve_id>, <red>, <green>, <blue>, <editable>)
detachCurveAreaWidgetCurve(<requester id>, <widg
et name>, <curve_id>)
detachCurveAreaWidgetAllCurves(<requester id>, <
widget name>)
[<curve_id>,<curve_id>,...]
getCurveAreaWidgetCurveList(<requester id>, <wid
get name>)
setCurveAreaWidgetXOffset(<requester id>, <widge
t name>, <x_offset>)
addMenuBarWidget(<requester id>, <widget name>)
addMenuWidget(<requester id>, <widget name>, <la
bel>, <parent widget>, <mutual exclude toggles>)
addMenuButtonWidget(<requester id>, <widget name
>, <label>, <parent widget>)
addMenuToggleWidget(<requester id>, <widget name
>, <label>, <parent widget>, 0|1)
addMenuSeparator(<requester id>, <widget name>,
<parent widget>)
addTextAreaWidget(<requester id>, <widget name>,
<label>, <height>, <editable>)
appendTextAreaWidgetString(<requester id>, <widg
et name>, <string>)
clearTextAreaWidget(<requester id>, <widget name
>)
<string>
name>)

getTextAreaWidgetString(<requester id>, <widget

setTextAreaWidgetCursorPosition(<requester id>,

<widget name>, <position>)

<position>
<widget name>)

getTextAreaWidgetCursorPosition(<requester id>,
setTextAreaWidgetSelection(<requester id>, <widg

et name>, <start>, <end>)

[<start>, <end>]
et name>)

getTextAreaWidgetSelection(<requester id>, <widg

setTextAreaWidgetScrollPosition(<requester id>,

<widget name>, <position>)

<position>
<widget name>)

getTextAreaWidgetScrollPosition(<requester id>,

0|1

removeWidget(<requester id>, <widget name>)

widgetExists(<requester id>, <widget name>)

<value>
0|1
tring>)

getWidgetValue(<requester id>, <widget name>)

setWidgetValue(<requester id>, <widget name>, <s

<function name>
t name>)

getWidgetCallbackFunction(<requester id>, <widge

setWidgetCallbackFunction(<requester id>, <widge

t name>, <function name>)

0|1
ame>)

getWidgetSensitiveFlag(<requester id>, <widget n

setWidgetSensitiveFlag(<requester id>, <widget n

ame>, 0|1)
setWidgetSize(<requester id>, <widget name>, <wi
dth>, <height>)
setWidgetOffsets(<requester id>, <widget name>,
<left offset>, <right offset>, <top offset>, <bottom offset>)
setWidgetLinks(<requester id>, <widget name>, <l
eft link>, <right link>, <top link>, <bottom link>)
setWidgetAttachModes(<requester id>, <widget nam
e>, <left mode>, <right mode>, <top mode>, <bottom mode>)
setWidgetShortcut(<requester id>, <widget name>,
<shortcut opcode>)
setWidgetFGColor(<requester id>, <widget name>,
<r>, <g>, <b>)
setWidgetBGColor(<requester id>, <widget name>,
<r>, <g>, <b>)
setWidgetHLColor(<requester id>, <widget name>,
<r>, <g>, <b>)
restoreWidgetDefaultColors(<requester id>, <widg
et name>)
<label>

getWidgetLabel(<requester id>, <widget name>)

setWidgetLabel(<requester id>, <widget name>, <l

abel>)

##############################################
# interaction with regular user interface...
<pgroup_id>
<camera_id>
<frame>

getCurrentPGroup()
getCurrentCamera()
getCurrentFrame(<camera_id>)

<frame>

setCurrentPGroup(<pgroup_id>)
setCurrentCamera(<camera_id>)
setCurrentFrame(<camera_id>, <frame>)

<object_id>
<object_id>

getContextMenuObject()
getContextMenuParentObject()

<script_call_hint>

getCurrentScriptCallHint()

<curve_id>
<curve_id>

getFirstCurrentCurve()
getNextCurrentCurve(<curve_id>)

<curve mode>

getCurrentCurveMode()
pushCurrentCurvesToUndoStack()
pushPointsToUndoStack()
setCreateNewPointCallbackFunction(<function name

>)

<absolute_path>
0|1
0|1
0|1

getProjectPath()
isProjectUpToDate()
loadProject(<absolute_path>)
saveProject(<absolute_path>)

0|1

calcAllFromScratch()
updateGUI()
clearConsole()

0|1

importBufferCompressionFile(<camera_id>)
calcMatchFrame(<pgroup_id>, <camera_id>, <frame>

)
0|1
saveRenderCacheFrame(<camera_id>, <frame>, <file
name>, "IMAGE_JPEG"|"IMAGE_TIFF"|"IMAGE_PNG", <image_scale>, <overscan>, <x_offs
et>, <y_offset>, <window_width>, <window_height>)
clearRenderCache()
<string>

getClipboardString()
setClipboardString(<string>)

##########################
# 2D tracking engine...
setTrackEngineMode(<tracking_mode>)
setTrackEngineFlags(<enhanced_mode>, <comp_lum_c
hanges>, <allow_rotation>, <allow_scaling>)
setTrackEngineRGBWeights(<red>, <blue>, <green>)
setTrackEngineBlurring(<blur_mode>)
setTrackEnginePattern(<camera_id>, <frame>, <poi
nt_2d>, <search_2d>, <pattern_2d>, <offset_2d>, <rot>)
setTrackEngineRefPattern(<camera_id>, <frame>, <
point_2d>, <pattern_2d>, <offset_2d>, <rot>)
setTrackEngineCustomTransform(<matrix 3d>)
<vector 2d>
runTrackEngineProcedure("TRACK_ENGINE_USE_DEFAUL
T_TRANSFORM"|"TRACK_ENGINE_USE_CUSTOM_TRANSFORM"|"TRACK_ENGINE_CALC_TRANSFORM_FR
OM_SCRATCH")
<double>
<matrix 3d>

getTrackEngineProcedureDeviation()
getTrackEngineProcedureTransform()

<vector 2d>
runMatrixTrackingProcedure(<camera_id>, <frame>,
<start_vector_2d>, <search_area_width>, <search_area_height>)

###########################
# Parameter Adjustment...
0|1
getParameterAdjustFlag(<db_obj id>, <parameter_t
ype>, <lens_distortion_para_name>)

setParameterAdjustFlag(<db_obj id>, <parameter_t

ype>, <lens_distortion_para_name>, 0|1)
removeAllAdjustParameters()

##################
# scene node...
<vector 3d>
<matrix 3d>
<double>

getScenePosition3D()
getSceneRotation3D()
getSceneScale3D()
setScenePosition3D(<vector 3d>)
setSceneRotation3D(<matrix 3d>)
setSceneScale3D(<double>)

####################
# point groups...
<pgroup_id>
"CAMERA"|"OBJECT"|"MOCAP"
<pgroup_id>
<pgroup_id>
[<pgroup_id>,<pgroup_id>,...]
<number_of_pgroups>
<pgroup_id>
0|1
0|1
<name>
<double>
ame>)

createPGroup("CAMERA"|"OBJECT"|"MOCAP")
deletePGroup(<pgroup_id>)
getPGroupType(<pgroup_id>)
getFirstPGroup()
getNextPGroup(<pgroup_id>)
getPGroupList(<selected_only>)
getNoPGroups()
getIndexPGroup(<index>)
getPGroupSelectionFlag(<pgroup_id>)
setPGroupSelectionFlag(<pgroup_id>, 0|1)
getPGroupEnabledFlag(<pgroup_id>)
setPGroupEnabledFlag(<pgroup_id>, 0|1)
getPGroupName(<pgroup_id>)
setPGroupName(<pgroup_id>, <name>)
getPGroupDeviation(<pgroup_id>, <camera_id>, <fr
setPGroupDeviation(<pgroup_id>, <camera_id>, <fr

ame>, <double>)
<double>
d>)

getPGroupAverageDeviation(<pgroup_id>, <camera_i
setPGroupAverageDeviation(<pgroup_id>, <camera_i

d>, <double>)
<vector 3d>
rame>)
<matrix 3d>
rame>)
<double>

getPGroupPosition3D(<pgroup_id>, <camera_id>, <f

getPGroupRotation3D(<pgroup_id>, <camera_id>, <f
getPGroupScale3D(<pgroup_id>)
setPGroupScale3D(<pgroup_id>, <double>)
setPGroupPosition3D(<pgroup_id>, <camera_id>, <f

rame>, <vector 3d>)

setPGroupRotation3D(<pgroup_id>, <camera_id>, <f
rame>, <matrix 3d>)
<postfilter_mode>

filterPGroup(<pgroup_id>, <camera_id>)
getPGroupPostfilterMode(<pgroup_id>)
setPGroupPostfilterMode(<pgroup_id>, <postfilter

_mode>)
0|1
d>, <frame>)
<vector 3d>

getPGroupLineup3DPoseFlag(<pgroup_id>, <camera_i
getPGroupLineup3DPosePosition(<pgroup_id>, <came

ra_id>, <frame>)
<matrix 3d>
ra_id>, <frame>)

getPGroupLineup3DPoseRotation(<pgroup_id>, <came

###############
# cameras...
<camera_id>
"SEQUENCE"|"REF_FRAME"
<camera_id>
<camera_id>
[<camera_id>,<camera_id>,...]
<number_of_cameras>
<camera_id>
0|1
0|1
<double>
le>)
<name>
<number_of_frames>
<path>
[<start>,<end>,<step>]
>, <step>)
<double>
<lens_id>
0|1
# obsolete

createCamera("SEQUENCE"|"REF_FRAME")
deleteCamera(<camera_id>)
getCameraType(<camera_id>)
getFirstCamera()
getNextCamera(<camera_id>)
getCameraList(<selected_only>)
getNoCameras()
getIndexCamera(<index>)
getCameraSelectionFlag(<camera_id>)
setCameraSelectionFlag(<camera_id>, 0|1)
getCameraEnabledFlag(<camera_id>)
setCameraEnabledFlag(<camera_id>, 0|1)
getCameraFocalLength(<camera_id>, <frame>)
setCameraFocalLength(<camera_id>, <frame>, <doub
getCameraName(<camera_id>)
setCameraName(<camera_id>, <name>)
getCameraNoFrames(<camera_id>)
getCameraPath(<camera_id>)
setCameraPath(<camera_id>, <path>)
getCameraSequenceAttr(<camera_id>)
setCameraSequenceAttr(<camera_id>, <start>, <end
getCameraFPS(<camera_id>)
setCameraFPS(<camera_id>, <double>)
getCameraLens(<camera_id>)
setCameraLens(<camera_id>, <lens_id>)
getCameraZoomingFlag(<camera_id>)
setCameraZoomingFlag(<camera_id>, 0|1)

# obsolete
<curve_id>
<image_width>
<image_height>
)
[<xa>,<xb>,<ya>,<yb>]
)
<time_shift>
<curve_id>
[<x0>,<x1>,<y0>,<y1>]
>, <y0>, <y1>)
<vector 2d>
vector 2d>)
0|1
<y>)

getCameraZoomCurve(<camera_id>)
getCameraImageWidth(<camera_id>)
setCameraImageWidth(<camera_id>, <image_width>)
getCameraImageHeight(<camera_id>)
setCameraImageHeight(<camera_id>, <image_height>
getCameraFOV(<camera_id>)
setCameraFOV(<camera_id>, <xa>, <xb>, <ya>, <yb>
getCameraTimeshift(<camera_id>)
getCameraStereoInterocularCurve(<camera_id>)
getCameraMatrixDimensions(<camera_id>)
setCameraMatrixDimensions(<camera_id>, <x0>, <x1
getCameraMatrixPointPos(<camera_id>, <x>, <y>)
setCameraMatrixPointPos(<camera_id>, <x>, <y>, <
getCameraMatrixPointValidFlag(<camera_id>, <x>,
setCameraMatrixPointValidFlag(<camera_id>, <x>,

<y>, 0|1)

<matrix_point_status>
)

getCameraMatrixPointStatus(<camera_id>, <x>, <y>

setCameraMatrixPointStatus(<camera_id>, <x>, <y>

, <matrix_point_status>)
<stereo_mode>
<stereo_orientation>
orientation>)
<stereo_interocular>
interocular>)
<proxy_footage>

getCameraStereoMode(<camera_id>)
setCameraStereoMode(<camera_id>, <stereo_mode>)
getCameraStereoOrientation(<camera_id>)
setCameraStereoOrientation(<camera_id>, <stereo_
getCameraStereoInterocular(<camera_id>)
setCameraStereoInterocular(<camera_id>, <stereo_
getCameraProxyFootage(<camera_id>)
setCameraProxyFootage(<camera_id>, <proxy_footag

e>)
setCameraPlaybackRange(<camera_id>, <start>, <en
d>)
[<start>, <end>]
<end>)
[<start>, <end>]
0|1)
0|1
<focal length mode>
gth mode>)
<focus mode>
<double>
<curve_id>
<double>
ouble>)
<double>
<double>)
<double>
uble>)
0|1
0|1)
<double>
ouble>)
<frame_offset>
)
<sync_mode>

getCameraPlaybackRange(<camera_id>)
setCameraCalculationRange(<camera_id>, <start>,
getCameraCalculationRange(<camera_id>)
setCameraFrameRangeCalculationFlag(<camera_id>,
getCameraFrameRangeCalculationFlag(<camera_id>)
getCameraFocalLengthMode(<camera_id>)
setCameraFocalLengthMode(<camera_id>, <focal len
getCameraFocusMode(<camera_id>)
setCameraFocusMode(<camera_id>, <focus mode>)
getCameraFocus(<camera_id>, <frame>)
setCameraFocus(<camera_id>, <frame>, <double>)
getCameraFocusCurve(<camera_id>)
getCameraStereoStaticInterocular(<camera_id>)
setCameraStereoStaticInterocular(<camera_id>, <d
getCameraStereoStaticVerticalShift(<camera_id>)
setCameraStereoStaticVerticalShift(<camera_id>,
getCameraStereoStaticDepthShift(<camera_id>)
setCameraStereoStaticDepthShift(<camera_id>, <do
getCameraRollingShutterEnabledFlag(<camera_id>)
setCameraRollingShutterEnabledFlag(<camera_id>,
getCameraRollingShutterTimeShift(<camera_id>)
setCameraRollingShutterTimeShift(<camera_id>, <d
getCameraFrameOffset(<camera_id>)
setCameraFrameOffset(<camera_id>, <frame_offset>
getCameraSyncMode(<camera_id>)
setCameraSyncMode(<camera_id>, <sync_mode>)

##############
# points...
<point_id>

createPoint(<pgroup_id>)
deletePoint(<pgroup_id>, <point_id>)

<point_id>
<point_id>
<point_id>
rder>)
<point_id>
rder>)
[<point_id>,<point_id>,...]
<number_of_points>
<point_id>
<point_id>
<name>
0|1
|1)
<vector 3d>
)

getFirstPoint(<pgroup_id>)
getLastPoint(<pgroup_id>)
getNextPoint(<pgroup_id>, <point_id>, <use_gui_o
getPrevPoint(<pgroup_id>, <point_id>, <use_gui_o
getPointList(<pgroup_id>, <selected_only>)
getNoPoints(<pgroup_id>)
getIndexPoint(<pgroup_id>, <index>)
findPointByName(<pgroup_id>, <name>)
getPointName(<pgroup_id>, <point_id>)
setPointName(<pgroup_id>, <point_id>, <name>)
getPointSelectionFlag(<pgroup_id>, <point_id>)
setPointSelectionFlag(<pgroup_id>, <point_id>, 0
getPointSurveyPosition3D(<pgroup_id>, <point_id>
setPointSurveyPosition3D(<pgroup_id>, <point_id>

, <vector 3d>)
<vector 3d>
<vector 3d>)
<vector 3d>
t_id>, <camera_id>, <frame>)

getPointCalcPosition3D(<pgroup_id>, <point_id>)
setPointCalcPosition3D(<pgroup_id>, <point_id>,
getPointMoCapSurveyPosition3D(<pgroup_id>, <poin

setPointMoCapSurveyPosition3D(<pgroup_id>, <poin
t_id>, <camera_id>, <frame>, <vector 3d>)
<vector 3d>
getPointMoCapCalcPosition3D(<pgroup_id>, <point_
id>, <camera_id>, <frame>)
setPointMoCapCalcPosition3D(<pgroup_id>, <point_
id>, <camera_id>, <frame>, <vector 3d>)
<survey mode>
getPointSurveyMode(<pgroup_id>, <point_id>)
setPointSurveyMode(<pgroup_id>, <point_id>, <sur
vey mode>)
<calc mode>
getPointCalcMode(<pgroup_id>, <point_id>)
setPointCalcMode(<pgroup_id>, <point_id>, <calc
mode>)
<double>
getPointWeight(<pgroup_id>, <point_id>)
setPointWeight(<pgroup_id>, <point_id>, <double>
)
<vector 2d>
getPointPosition2D(<pgroup_id>, <point_id>, <cam
era_id>, <frame>)
setPointPosition2D(<pgroup_id>, <point_id>, <cam
era_id>, <frame>, <vector 2d>)
<tracking curve>
getPointPosition2DBlock(<pgroup_id>, <point_id>,
<camera_id>, <start frame>, <end frame>)
setPointPosition2DBlock(<pgroup_id>, <point_id>,
<camera_id>, <start frame>, <tracking curve>)
0|1
isPointPos2DValid(<pgroup_id>, <point_id>, <came
ra_id>, <frame>)
deletePointCurve2D(<pgroup_id>, <point_id>, <cam
era_id>)
0|1
isPointCalculated3D(<pgroup_id>, <point_id>)
setPointCalculated3D(<pgroup_id>, <point_id>, 0|
1)
<double>
getPointDeviation(<pgroup_id>, <point_id>, <came
ra_id>, <frame>)
setPointDeviation(<pgroup_id>, <point_id>, <came
ra_id>, <frame>, <double>)
<color_index>
getPointColor2D(<pgroup_id>, <point_id>)
setPointColor2D(<pgroup_id>, <point_id>, <color_

index>)
<color_index>

getPointColor3D(<pgroup_id>, <point_id>)
setPointColor3D(<pgroup_id>, <point_id>, <color_

index>)
<vector 3d>
calcPointPosition3D(<pgroup_id>, <point_id>, <ca
mera_id>)
<vector 2d>
calcPointBackProjection2D(<pgroup_id>, <point_id
>, <camera_id>, <frame>, <with_distortion>)
<tracking_mode>
getPointTrackingMode(<pgroup_id>, <point_id>)
setPointTrackingMode(<pgroup_id>, <point_id>, <t
racking_mode>)
<tracking_direction>
getPointTrackingDirection(<pgroup_id>, <point_id
>)
setPointTrackingDirection(<pgroup_id>, <point_id
>, <tracking_direction>)
shiftPointPositions2D(<pgroup_id>, <point_id>, <
camera_id>, <shift>)
setPointTrackingBoxes2D(<pgroup_id>, <point_id>,
<camera_id>, <frame>, <search>, <pattern>, <offset>, <rot>)
[<s>,<p>,<o>,<r>]
getPointTrackingBoxes2D(<pgroup_id>, <point_id>,
<camera_id>, <frame>)
setPointStatus2D(<pgroup_id>, <point_id>, <camer
a_id>, <frame>, "POINT_KEYFRAME"|"POINT_KEYFRAME_END"|"POINT_OBSOLETE"|"POINT_TR
ACKED"|"POINT_INTERPOLATED")
<point_status>
getPointStatus2D(<pgroup_id>, <point_id>, <camer
a_id>, <frame>)
setPointTrackingTransform(<pgroup_id>, <point_id
>, <camera_id>, <frame>, <forward_pass>, <matrix 3d>)
<matrix 3d>
getPointTrackingTransform(<pgroup_id>, <point_id
>, <camera_id>, <frame>, <forward_pass>)
0|1
getPointAutoTrackingFlag(<pgroup_id>, <point_id>
)
0|1
getPointInfiniteDistantFlag(<pgroup_id>, <point_
id>)
setPointInfiniteDistantFlag(<pgroup_id>, <point_
id>, 0|1)
<set_id>
getPointSet(<pgroup_id>, <point_id>)
setPointSet(<pgroup_id>, <point_id>, <set_id>)
0|1
getPointHideFlag(<pgroup_id>, <point_id>)
setPointHideFlag(<pgroup_id>, <point_id>, 0|1)
0|1
getPointLockFlag(<pgroup_id>, <point_id>, <camer
a_id>)
setPointLockFlag(<pgroup_id>, <point_id>, <camer
a_id>, 0|1)
0|1
getPointEnhancedTrackingFlag(<pgroup_id>, <point
_id>)
setPointEnhancedTrackingFlag(<pgroup_id>, <point
_id>, 0|1)
0|1
getPointLuminanceChangesFlag(<pgroup_id>, <point
_id>)
setPointLuminanceChangesFlag(<group_id>, <point_
id>, 0|1)
0|1
getPointRotatePatternFlag(<pgroup_id>, <point_id
>)
setPointRotatePatternFlag(<pgroup_id>, <point_id
>, 0|1)
0|1
getPointScalePatternFlag(<pgroup_id>, <point_id>
)
setPointScalePatternFlag(<pgroup_id>, <point_id>
, 0|1)

0|1
int_id>)

getPointCreateAutoKeyframesFlag(<pgroup_id>, <po
setPointCreateAutoKeyframesFlag(<pgroup_id>, <po

int_id>, 0|1)
0|1
<point_id>)

getPointStopLowQualityTrackingFlag(<pgroup_id>,
setPointStopLowQualityTrackingFlag(<pgroup_id>,

<point_id>, 0|1)
0|1
0|1)
0|1
id>)

getPointSplineBoxesFlag(<pgroup_id>, <point_id>)
setPointSplineBoxesFlag(<pgroup_id>, <point_id>,
getPointValidOutsideFOVFlag(<pgroup_id>, <point_
setPointValidOutsideFOVFlag(<pgroup_id>, <point_

id>, 0|1)
<blur_mode>
mode>)
<double>
int_id>)

getPointBlurring(<pgroup_id>, <point_id>)
setPointBlurring(<pgroup_id>, <point_id>, <blur_
getPointAutoKeyframeSensitivity(<pgroup_id>, <po
setPointAutoKeyframeSensitivity(<pgroup_id>, <po

int_id>, <double>)
<ref_pattern_mode>
_id>)

getPointReferencePatternMode(<pgroup_id>, <point
setPointReferencePatternMode(<pgroup_id>, <point

_id>, <ref_pattern_mode>)
<frame>
>, <point_id>)

getPointReferencePatternExplicitFrame(<pgroup_id
setPointReferencePatternExplicitFrame(<pgroup_id

>, <point_id>, <frame>)

[<red>, <green>, <blue>]

getPointRGBWeights(<pgroup_id>, <point_id>)
setPointRGBWeights(<pgroup_id>, <point_id>, <red

>, <green>, <blue>)

splinePointPositions2D(<pgroup_id>, <point_id>,
<camera_id>)
0|1
, <camera_id>)

getPointTimelineHideFlag(<pgroup_id>, <point_id>
setPointTimelineHideFlag(<pgroup_id>, <point_id>

, <camera_id>, 0|1)

##############
# sets...
<set_id>
[<set_id>,<set_id>,...]
<name>
0|1
[<point_id>,<point_id>,...]

createSet(<pgroup_id>)
deleteSet(<pgroup_id>, <set_id>)
getSetList(<pgroup_id>, <selected_only>)
getSetName(<pgroup_id>, <set_id>)
setSetName(<pgroup_id>, <set_id>, <name>)
getSetSelectionFlag(<pgroup_id>, <set_id>)
setSetSelectionFlag(<pgroup_id>, <set_id>, 0|1)
getSetPointList(<pgroup_id>, <set_id>)

##############
# lenses & lens distortion models...
<lens_id>

createLens()

<lens_id>
<lens_id>
[<lens_id>,<lens_id>,...]
<number_of_lenses>
<lens_id>
0|1
<name>
<value>
<value>
<value>
<value>
<value>
<value>
<value>
<value>
<value>
<value>
<dyn_distortion_mode>

deleteLens(<lens_id>)
getFirstLens()
getNextLens(<lens_id>)
getLensList(<selected_only>)
getNoLenses()
getIndexLens(<index>)
getLensSelectionFlag(<lens_id>)
setLensSelectionFlag(<lens_id>, 0|1)
getLensName(<lens_id>)
setLensName(<lens_id>, <name>)
getLensFBackWidth(<lens_id>)
setLensFBackWidth(<lens_id>, <value>)
getLensFBackHeight(<lens_id>)
setLensFBackHeight(<lens_id>, <value>)
getLensFocalLength(<lens_id>)
setLensFocalLength(<lens_id>, <value>)
getLensFilmAspect(<lens_id>)
setLensFilmAspect(<lens_id>, <value>)
getLensLensCenterX(<lens_id>)
setLensLensCenterX(<lens_id>, <value>)
getLensLensCenterY(<lens_id>)
setLensLensCenterY(<lens_id>, <value>)
getLensPixelAspect(<lens_id>)
setLensPixelAspect(<lens_id>, <value>)
getLensHorizAngle(<lens_id>)
getLensVertiAngle(<lens_id>)
getLensFocus(<lens_id>)
setLensFocus(<lens_id>, <value>)
getLensDynamicDistortionMode(<lens_id>)
setLensDynamicDistortionMode(<lens_id>, <dyn_dis

tortion_mode>)
0|1
# obsolete

getLensDynamicDistortionFlag(<lens_id>)
setLensDynamicDistortionFlag(<lens_id>, 0|1)

# obsolete
<value>
cus>)
cus>, <value>)
<value>
or_focus>)
or_focus>, <value>)
<value>
cus>)
cus>, <value>)
<value>
cus>)
cus>, <value>)
<value>
h_or_focus>)
h_or_focus>, <value>)
<curve_id>
# obsolete

getLensDistortion(<lens_id>, <focal_length_or_fo
# obsolete
setLensDistortion(<lens_id>, <focal_length_or_fo
# obsolete
getLensAnamorphSqueeze(<lens_id>, <focal_length_
# obsolete
setLensAnamorphSqueeze(<lens_id>, <focal_length_
# obsolete
getLensCurvatureX(<lens_id>, <focal_length_or_fo
# obsolete
setLensCurvatureX(<lens_id>, <focal_length_or_fo
# obsolete
getLensCurvatureY(<lens_id>, <focal_length_or_fo
# obsolete
setLensCurvatureY(<lens_id>, <focal_length_or_fo
# obsolete
getLensQuarticDistortion(<lens_id>, <focal_lengt
# obsolete
setLensQuarticDistortion(<lens_id>, <focal_lengt
# obsolete
getLensDistortionCurve(<lens_id>)

<curve_id>
# obsolete
<curve_id>
# obsolete
<curve_id>
# obsolete
<curve_id>
# obsolete

getLensAnamorphSqueezeCurve(<lens_id>)
getLensCurvatureXCurve(<lens_id>)
getLensCurvatureYCurve(<lens_id>)
getLensQuarticDistortionCurve(<lens_id>)

<model>

getLensLDModel(<lens_id>)
setLensLDModel(<lens_id>, <model>)
<double>
getLensLDAdjustableParameter(<lens_id>, <para_na
me>, <focal_length_or_focus_distance>)
setLensLDAdjustableParameter(<lens_id>, <para_na
me>, <focal_length_or_focus_distance>, <double>)
<curve_id>
getLensLDAdjustableParameterCurve(<lens_id>, <pa
ra_name>)
<value>
getLensLDRegularParameter(<lens_id>, <para_name>
)
setLensLDRegularParameter(<lens_id>, <para_name>
, <string>)
<number_of_parameters>
<para_name>
<para_type>
<value>
[<a>, <b>]

getLDModelNoParameters(<model>)
getLDModelParameterName(<model>, <index>)
getLDModelParameterType(<model>, <para_name>)
getLDModelParameterDefault(<model>, <para_name>)
getLDModelParameterRange(<model>, <para_name>)

##############
# curves...
<curve_id>
<key_id>
<double>
<key_id>
<key_id>
<key_id>
[<key_id>,<key_id>,...]
<number_of_curve_keys>
0|1
<vector 2d>
r 2d>)
<vector 2d>
r 2d>)
<vector 2d>
r 2d>)
"LINEAR"|"BROKEN"|"SMOOTH"
BROKEN"|"SMOOTH")
0|1

createCurve()
deleteCurve(<curve_id>)
createCurveKey(<curve_id>, <vector 2d>)
deleteCurveKey(<curve_id>, <key_id>)
deleteAllCurveKeys(<curve_id>)
evaluateCurve(<curve_id>, <x>)
getFirstCurveKey(<curve_id>)
getNextCurveKey(<curve_id>, <key_id>)
getPrevCurveKey(<curve_id>, <key_id>)
getCurveKeyList(<curve_id>, <selected_only>)
getNoCurveKeys(<curve_id>)
getCurveKeySelectionFlag(<curve_id>, <key_id>)
getCurveKeyPosition(<curve_id>, <key_id>)
setCurveKeyPosition(<curve_id>, <key_id>, <vecto
getCurveKeyTangent1(<curve_id>, <key_id>)
setCurveKeyTangent1(<curve_id>, <key_id>, <vecto
getCurveKeyTangent2(<curve_id>, <key_id>)
setCurveKeyTangent2(<curve_id>, <key_id>, <vecto
getCurveKeyMode(<curve_id>, <key_id>)
setCurveKeyMode(<curve_id>, <key_id>, "LINEAR"|"
getCurveKeyFixedXFlag(<curve_id>, <key_id>)
setCurveKeyFixedXFlag(<curve_id>, <key_id>, 0|1)

###########
# geo...
<geo_id>
<geo_id>
<geo_id>
[<geo_id>,<geo_id>,...]
0|1
<name>
[<vector 3d>,<vector 3d>,...]
d>, <frame>)

createGeo(<pgroup_id>)
deleteGeo(<pgroup_id>, <geo_id>)
getFirstGeo(<pgroup_id>)
getNextGeo(<pgroup_id>, <geo_id>)
getGeoList(<pgroup_id>, <selected_only>)
getGeoSelectionFlag(<pgroup_id>, <geo_id>)
setGeoSelectionFlag(<pgroup_id>, <geo_id>, 0|1)
getGeoName(<pgroup_id>, <geo_id>)
setGeoName(<pgroup_id>, <geo_id>, <name>)
getGeoPointList(<pgroup_id>, <geo_id>, <camera_i
addGeoPoint(<pgroup_id>, <geo_id>, <point_id>, <

offset 3d>)
[<r>, <g>, <b>]

getGeoColor(<pgroup_id>, <geo_id>)
setGeoColor(<pgroup_id>, <geo_id>, <r>, <g>, <b>

################
# 3d models...

<model_id>
rtices>)
0|1
to_obj>)
<model_id>
<model_id>
[<model_id>,<model_id>,...]
0|1
0|1)
<name>
0|1
1)
0|1
0|1)
<path_to_obj>
<vector 3d>
amera_id>, <frame>)

create3DModel(<pgroup_id>, <initial_number_of_ve
delete3DModel(<pgroup_id>, <model_id>)
importOBJ3DModel(<pgroup_id>, <model_id>, <path_
getFirst3DModel(<pgroup_id>)
getNext3DModel(<pgroup_id>, <model_id>)
get3DModelList(<pgroup_id>, <selected_only>)
get3DModelSelectionFlag(<pgroup_id>, <model_id>)
set3DModelSelectionFlag(<pgroup_id>, <model_id>,
get3DModelName(<pgroup_id>, <model_id>)
set3DModelName(<pgroup_id>, <model_id>, <name>)
get3DModelSurveyFlag(<pgroup_id>, <model_id>)
set3DModelSurveyFlag(<pgroup_id>, <model_id>, 0|
get3DModelReferenceFlag(<pgroup_id>, <model_id>)
set3DModelReferenceFlag(<pgroup_id>, <model_id>,
get3DModelFilepath(<pgroup_id>, <model_id>)
get3DModelPosition3D(<pgroup_id>, <model_id>, <c
set3DModelPosition3D(<pgroup_id>, <model_id>, <v

ector 3d>)
<matrix 3d>
>)

get3DModelRotationScale3D(<pgroup_id>, <model_id

set3DModelRotationScale3D(<pgroup_id>, <model_id
>, <matrix 3d>)
<number_of_vertices>
get3DModelNoVertices(<pgroup_id>, <model_id>)
<vector 3d>
get3DModelVertex(<pgroup_id>, <model_id>, <verte
x_index>, <camera_id>, <frame>)

set3DModelVertex(<pgroup_id>, <model_id>, <verte

x_index>, <vector 3d>)
<number_of_lines>
[<index0>,<index1>,...]
id>, <line_index>)
<number_of_faces>
[<index0>,<index1>,...]
id>, <face_index>)

get3DModelNoLines(<pgroup_id>, <model_id>)
get3DModelLineVertexIndices(<pgroup_id>, <model_
get3DModelNoFaces(<pgroup_id>, <model_id>)
get3DModelFaceVertexIndices(<pgroup_id>, <model_
removeAll3DModelGeometryData(<pgroup_id>, <model

_id>)
<vertex_index>
r 3d>)

add3DModelVertex(<pgroup_id>, <model_id>, <vecto

add3DModelLine(<pgroup_id>, <model_id>, [<index0

>,<index1>,...])
add3DModelFace(<pgroup_id>, <model_id>, [<index0
>,<index1>,...])
remove3DModelLine(<pgroup_id>, <model_id>, <line
_index>)
remove3DModelFace(<pgroup_id>, <model_id>, <face
_index>)
set3DModelSnappingPoint(<pgroup_id>, <model_id>,
<point_id>)
<point_id>
0|1
|1)
[<r>,<g>,<b>,<a>]
>, <b>, <a>)
[<points>,<lines>,<polygons>]
)

get3DModelSnappingPoint(<pgroup_id>, <model_id>)
get3DModelVisibleFlag(<pgroup_id>, <model_id>)
set3DModelVisibleFlag(<pgroup_id>, <model_id>, 0
get3DModelColor(<pgroup_id>, <model_id>)
set3DModelColor(<pgroup_id>, <model_id>, <r>, <g
get3DModelRenderingFlags(<pgroup_id>, <model_id>

set3DModelRenderingFlags(<pgroup_id>, <model_id>
, <show_points>, <show_lines>, <show_polygons>)
0|1
get3DModelHiddenLinesFlag(<pgroup_id>, <model_id
>)
set3DModelHiddenLinesFlag(<pgroup_id>, <model_id
>, 0|1)
<bf_culling_mode>
get3DModelBackfaceCullingMode(<pgroup_id>, <mode
l_id>)
set3DModelBackfaceCullingMode(<pgroup_id>, <mode
l_id>, <bf_culling_mode>)
[<r>,<g>,<b>,<a>]
get3DModelVertexColor(<pgroup_id>, <model_id>, <
vertex_index>)
set3DModelVertexColor(<pgroup_id>, <model_id>, <
vertex_index>, <r>, <g>, <b>, <a>)
0|1
get3DModelPerVertexColorsFlag(<pgroup_id>, <mode
l_id>)
set3DModelPerVertexColorsFlag(<pgroup_id>, <mode
l_id>, 0|1)
<proxy_geometry>
get3DModelProxyGeometry(<pgroup_id>, <model_id>)
set3DModelProxyGeometry(<pgroup_id>, <model_id>,
<proxy_geometry>)
0|1
get3DModelMapFootageFlag(<pgroup_id>, <model_id>
)
set3DModelMapFootageFlag(<pgroup_id>, <model_id>
, 0|1)
0|1
get3DModelPointLinksFlag(<pgroup_id>, <model_id>
)
set3DModelPointLinksFlag(<pgroup_id>, <model_id>
, 0|1)

<point_id>
rtex_index>)

get3DModelPointLink(<pgroup_id>, <model_id>, <ve

set3DModelPointLink(<pgroup_id>, <model_id>, <ve

rtex_index>, <point_id>)