MochaImportPlusAPI.js

this.createMochaProject = function( layer, options )

Creates a mocha project for the given AV layer.  To also includes masks of this layer in the project, either don’t set options.silent (in which case the user will be prompted which masks should be send), or set options.maskToLayerMapping.

Parameters

the File object for the created file throws the string “user canceled” when the user clicked cancel in one of the dialogs that may popup (the dialogs asking whether an existing project should be opened or which masks should go on which mocha layer).

Examples

// same as clicking the "send to mocha" button of MochaImport+ with the given layer selected
try {
    var myProjectFile = mochaImportPlus.createMochaProject(layer);
   mochaImportPlus.openProjectInMocha(myProjectFile);
}
catch(error){
    if(error != "user canceled"){
       throw error;  // must be some more serious error
   }
}

// write mocha project for the layer to the specified file and ignore any masks
mochaImportPlus.createMochaProject(layer, {silent:true, projectFile: new File('path/to/my/mochaProject.mocha')});

// write mocha project for the layer to the specified file and
// place the four masks of the layer all on the same mocha layer
// requires the layer to have at least 4 masks
mochaImportPlus.createMochaProject(layer, {silent:true, projectFile: new File('path/to/my/mochaProject.mocha'), maskToLayerMapping:[[1,2,3,4]]});

// write mocha project for the layer to the specified file and
// place the first three masks of the layer all to separate mocha layers
// requires the layer to have at least 3 masks
mochaImportPlus.createMochaProject(layer, {silent:true, projectFile: new File('path/to/my/mochaProject.mocha'), maskToLayerMapping:[[1][2][3]]});

// create mocha project with custom absolute output directory
mochaImportPlus.createMochaProject(layer,
   {  projectFile: new File('path/to/my/mochaProject.mocha'),
    ProjectOutputDirectory : new Folder("path/to/my/output/"),
    UseAbsoluteOutputDirectory : true
   }

// create mocha project with custom relative output directory (relative to footage path)
mochaImportPlus.createMochaProject(layer,
   {  projectFile: new File('path/to/my/mochaProject.mocha'),
    ProjectOutputDirectory : '../relative/path/',
    UseAbsoluteOutputDirectory : false
   }

this.openProjectInMocha = function( projectFile )

Launches mocha and opens the given mocha project file in it.

Parameters

Returns

nothing

Examples

 // creates a mocha project for the given layer and opens it in mocha
var myProjectFile = mochaImportPlus.createMochaProject(layer,{silent:true});
mochaImportPlus.openProjectInMocha(myProjectFile);

this.setMochaVersion = function( id )

Sets the version of mocha that should be used by the function openProjectInMocha.

Parameters

Returns

nothing

Examples

 // use system default program for .mocha files
mochaImportPlus.setMochaVersion(-1);

 // retrieve all versions of mocha available on this system and configure MochaImport+ to use the first one on this list
var myMochaPrograms = mochaImportPlus.getAllInstalledMochaVersions();
mochaImportPlus.setMochaVersion(myMochaPrograms[0].id);
alert("from now on, mochaImportPlus.openProjectInMocha will use the following version of mocha: "+myMochaPrograms[0].name);

this.getAllInstalledMochaVersions = function()

Returns the name, file path and id for all versions of mocha that are installed on the system.

Parameters

none

Returns

an Array of Objects of the form {name: String, file: File, id: number} each representing one version of mocha that is installed on the system.  Name is a human readable name for the variant of the program like “mocha AE CS6” or “mocha Pro” The file is the executable file of the mocha version or is null for mocha versions that are bundled with AE and cannot be launched independently. id is the id as needed by the function setMochaVersion.

Examples

 // retrieve all versions of mocha available on this system and configure MochaImport+ to use the first one on this list
var myMochaPrograms = mochaImportPlus.getAllInstalledMochaVersions();
mochaImportPlus.setMochaVersion(myMochaPrograms[0].id);
alert("from now on, mochaImportPlus.openProjectInMocha will use the following version of mocha: "+myMochaPrograms[0].name);

this.loadFromFile = function( file, options )

loads mocha tracking data from a file

Parameters

Returns

nothing

Examples

// loads tracking data and shows dialog to ask which layer was tracked
// (to figure out where tracking data starts and if fps is correct)
mochaImportPlus.loadFromFile(new File("/path/to/my/file.txt"),{silent:true});

// loads tracking data without prompting for details, tracking data starts at frame 0
mochaImportPlus.loadFromFile(new File("/path/to/my/file.txt"),{silent:true});

// loads tracking data without prompting for details, tracking data starts at frame 20
// framerate of tracking data file is ignored and replaced by 25fps
mochaImportPlus.loadFromFile(new File("/path/to/my/file.txt"),{silent:true, fps:25, frameOffset:20});

this.loadFromClipboard = function( options )

loads mocha tracking data from the clipboard

Parameters

Returns

nothing

Examples

// loads tracking data and shows dialog to ask which layer was tracked
// (to figure out where tracking data starts and if fps is correct)
mochaImportPlus.loadFromClipboard({silent:true});

// loads tracking data without prompting for details, tracking data starts at frame 0
mochaImportPlus.loadFromClipboard({silent:true});

// loads tracking data without prompting for details, tracking data starts at frame 20
// framerate of tracking data file is ignored and replaced by 25fps
mochaImportPlus.loadFromClipboard({silent:true, fps:25, frameOffset:20});

this.cornerPin = function( layer, options )

creates a corner pin effect on the given layer

Parameters

Returns

the PropertyGroup of the created corner pin effect

Examples

// applies the default corner pin effect to the layer and stores it in the
// variable myCornerPinEffect
var myCornerPinEffect = mochaImportPlus.cornerPin(layer, {silent:true});

// applies the default corner pin effect to the layer but
// represents the tracking data with an expression instead of keyframes
mochaImportPlus.cornerPin(layer, {silent:true,useExpressionInsteadOfKeyframes:true});

// applies a bezier warp effect to the layer
mochaImportPlus.cornerPin(layer, {silent:true,cornerPinEffect:'ADBE BEZMESH'});

this.stabilizeLayer = function( layer, options )

applies the stabilize function of MochaImport+ to the given layer.  Depending on whether transform data or corner pin data is loaded, this function uses a different technique to stabilize.  With corner pin data, the corner pin region is “unstretched” like in a stabilized precomp.  For transform data, the movement can either be eliminated completely or only be smoothed.  Usually, you want to do a stabilize with transform data.

Parameters

Returns

nothing

Examples

// applies the default stabilization to the layer
//(works with both transform or corner pin data loaded)
mochaImportPlus.applyStabilize(layer, {silent:true});

// creates the stabilization rig that smoothes the movement
// (works only with transform data loaded)
mochaImportPlus.applyStabilize(layer, {silent:true,smoothMovement:true});

this.stabilizedPrecomp = function( layer, options )

Turns the given layer into a stabilized precomp.

Parameters

Returns

the layer representing the stabilized precomp

Examples

// creates a stabilized precomp and stores both the precomp layer in the main comp
// and the precomp itself in some variables.
// works with both transform data and corner pin data
// if corner pin data is loaded, a dialog is shown to the user to choose all options
var precompLayerInMainComp = mochaImportPlus.stabilizedPrecomp(layer);
var precomp = precompLayerInMainComp.source;

// creates a stabilized precomp with the default options
//(works with both transform or corner pin data loaded)
mochaImportPlus.stabilizedPrecomp(layer, {silent:true});

// creates a stabilized precomp using the Red Giant Warp Plugin and
// with expressions instead of keyframes
//(works only with corner pin data loaded)
mochaImportPlus.stabilizedPrecomp(layer, {silent:true, cornerPinEffect:"rg CornerPin", useExpressionInsteadOfKeyframes:true});

this.createMoveNullLayer = function( comp )

Creates a new null layer and sets its position, scale and rotation to the loaded mocha tracking data.  Requires mocha transform data to be loaded.

Parameters

Returns

the created null layer

Examples

// works only if transform data is loaded
var nullLayer = mochaImportPlus.createMoveNullLayer(comp);

this.moveLayers = function( layerArray )

Creates a new null layer for the tracking data (like createMoveNullLayer) and parents all given layers to it.  As a result, all these layers move with the track.  Requires mocha transform data to be loaded.  All layers in the given array must belong to the same composition.

Parameters

Returns

the created null layer

Examples

// moves the layer with name "my layer" with the tracking data
// works only if transform data is loaded
var nullLayer = mochaImportPlus.moveLayers([comp.layer("my layer")]);

// moves the first three layers of a comp with the tracking data
// works only if transform data is loaded
mochaImportPlus.moveLayers([comp.layer(1),comp.layer(2),comp.layer(3)]);

this.moveProperties = function( propertyArray, options )

Moves the given 2d point properties, masks or shapes with the tracking data.  The current time is taken as the reference frame, i.e. at the current frame the property remains unchanged and at all other points in time the properties are moved relative to the current frame.  This function requires corner pin data (without motion blur) to be loaded.

Parameters

Returns

true if the properties have been moved and false otherwise (false may only occur if the user clicked cancel in the dialog which asks whether expressions or keyframes should be generated).

Examples

// moves all selected masks and 2d point properties of the layer
// and shows a dialog whether they should be moved based on keyframes or expressions
 mochaImportPlus.moveProperties(comp.selectedProperties);

// moves all selected masks and 2d point properties of the layer
// and represents the tracking data with keyframes
 mochaImportPlus.moveProperties(comp.selectedProperties,{silent:true});

// moves all selected masks and 2d point properties of the layer
// and represents the tracking data with expressions
 mochaImportPlus.moveProperties(comp.selectedProperties,{silent:true, useExpressionInsteadOfKeyframes:true});

this.generateAETrackpoints = function( layer )

Generates After Effects trackpoints on the given layer based on the loaded mocha tracking data.  For transform data one trackpoint is created, one trackpoint is created for each of the four corners.

Parameters

Returns

the tracker PropertyGroup containing the generated trackpoints

Examples

// this only works when transform data is loaded
var tracker = mochaImportPlus.generateAETrackpoints(layer)
var myTrackpoint = tracker.property('Mocha Point');
alert("my new trackpoint has "+ myTrackpoint.property("ADBE MTracker Pt Attach Pt").numKeys +" keyframes");

// this only works when cornerpin data is loaded
var tracker = mochaImportPlus.generateAETrackpoints(layer)
var firstCornerPoint = tracker.property('Corner Pin Point 0');
var secondCornerPoint = tracker.property('Corner Pin Point 1');
var thirdCornerPoint = tracker.property('Corner Pin Point 2');
var fourthCornerPoint = tracker.property('Corner Pin Point 3');
alert("my new trackpoint has "+ firstCornerPoint.property("ADBE MTracker Pt Attach Pt").numKeys +" keyframes");

this.addKeyframesToProperties = function( propertyArray, time )

Adds a keyframe for each of the given properties at the specified time.  Use this function to generate keyframes for expression-driven tracking data when you want to avoid that the track jumps to another position.

Parameters