Storyboard Pro
Scripting Interface Documentation
FunctionManager Class Reference

With the Function Manager, you can manipulate the camera functions and the layer functions. Note that for all methods you must give the unique id. For the camera, this is the sceneId. For a layer functions, this is the panelId. More...

Public Slots

Func Data
int holdStartFrame (String shotId, String columnName)
 returns the Start value from the Hold Value Editor dialog box, for Bezier and Velo-based Function Editors. More...
 
int holdStopFrame (String shotId, String columnName)
 returns the Stop value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors More...
 
int holdStep (String shotId, String columnName)
 returns the Step value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors More...
 
Functions common to Bezier, Ease and VeloBased
bool setEntry (String shotId, String columnName, int subColumn, double AtFrame, String value)
 sets a value on a column at the given frame More...
 
String getEntry (String shotId, String columnName, int subColumn, double AtFrame)
 gets a value from a column at the given frame More...
 
bool setKeyFrame (String shotId, String columnName, double AtFrame)
 sets a keyframe on a column More...
 
bool clearKeyFrame (String shotId, String columnName, double AtFrame)
 clears a keyframe on a column More...
 
int numberOfPoints (String shotId, String columnName)
 returns the number of keyframes and control points on a curve More...
 
String functionType (String shotId, String columnName)
 returns the type of the function ( Bezier, Ease, VeloBased or 3dPath ) More...
 
double pointX (String shotId, String columnName, int point)
 returns the X value (frame number) of a point on a function curve More...
 
double pointY (String shotId, String columnName, int point)
 returns the Y value of a point on a function curve More...
 
bool pointConstSeg (String shotId, String columnName, int point)
 returns a 1 (one) to indicate that the point is on a ant segment, or a 0 (zero) to indicate that the point is not on a ant segment More...
 
String pointContinuity (String shotId, String columnName, int point)
 returns the continuity of the curve that follows the point. One of the following values will be returned, in upper-case: SMOOTH, CORNER or STRAIGHT More...
 
Bezier Func
double pointHandleLeftX (String shotId, String columnName, int point)
 returns the X value of the left handle of a point on a curve More...
 
double pointHandleLeftY (String shotId, String columnName, int point)
 returns the Y value of the left handle of a point on a curve. More...
 
double pointHandleRightX (String shotId, String columnName, int point)
 returns the X value of the right handle of a point on a curve. More...
 
double pointHandleRightY (String shotId, String columnName, int point)
 returns the Y value of the right handle of a point on a curve More...
 
Ease Func
double pointEaseIn (String shotId, String columnName, int point)
 returns the number of frames in the ease-in More...
 
double angleEaseIn (String shotId, String columnName, int point)
 returns the angle of the ease-in handle More...
 
double pointEaseOut (String shotId, String columnName, int point)
 returns the number of frames in the ease-out More...
 
double angleEaseOut (String shotId, String columnName, int point)
 returns the angle of the ease-out handle More...
 
Catmull (Path3d)
int numberOfPointsPath3d (String shotId, String columnName)
 returns the number of keyframes and control points on the 3D Path More...
 
double pointXPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the X path More...
 
double pointYPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the Y path More...
 
double pointZPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the Z path More...
 
double pointTensionPath3d (String shotId, String columnName, int point)
 returns the tension value for the specified point on the 3D Path More...
 
double pointContinuityPath3d (String shotId, String columnName, int point)
 returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path. More...
 
double pointBiasPath3d (String shotId, String columnName, int point)
 returns the bias value for the specified point on the 3D Path More...
 
double pointLockedAtFrame (String shotId, String columnName, int point)
 returns the frame at which it's locked, or returns 0 if the point is not locked. More...
 
Func Edition
bool setHoldStartFrame (String shotId, String columnName, int start)
 sets the Start value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors More...
 
bool setHoldStopFrame (String shotId, String columnName, int stop)
 sets the Stop value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors More...
 
bool setHoldStep (String shotId, String columnName, int step)
 sets the Hold value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors. More...
 
bool setBezierPoint (String shotId, String columnName, int frame, double y, double handleLeftX, double handleLeftY, double handleRightX, double handleRightY, bool Seg, String continuity)
 sets the values of a point on a Bezier function curve More...
 
bool setVeloBasePoint (String shotId, String columnName, int frame, double y)
 sets the values of a point on an Velobased function curve More...
 
bool setEasePoint (String shotId, String columnName, int frame, double y, double easeIn, double angleEaseIn, double easeOut, double angleEaseOut, bool Seg, String continuity)
 sets the values of a point on an Ease function curve More...
 
bool addKeyFramePath3d (String shotId, String columnName, int frame, double x, double y, double z, double tension, double continuity, double bias)
 adds a keyframe to a 3D Path and sets the X, Y and Z value, as well as the tension, continuity and bias. More...
 
bool addCtrlPointAfterPath3d (String shotId, String columnName, int point, double x, double y, double z, double tension, double continuity, double bias)
 adds a keyframe after a point on a 3D Path and sets the X, Y and Z values, as well as the tension, continuity and bias More...
 
bool removePointPath3d (String shotId, String columnName, int point)
 removePointPath3d may be used to remove either a key frame, or a control point More...
 
bool setPointPath3d (String shotId, String columnName, int point, double x, double y, double z, double tension, double continuity, double bias)
 setPointPath3d may be used to set values in either a key frame, or a control point, but cannot change a key frame into a control point or a control point into a key frame. To change a key frame into a control point or a control point into a key frame, you must remove the point and add a new point. More...
 
bool setPath3dPointConstantSegment (String shotId, String columnName, int point, bool ant)
 sets the ant segment flag of point i of path p to b. More...
 
bool setPath3dPointConstantSegmentForFrame (String shotId, String columnName, double point, bool ant)
 sets the ant segment flag of point found at frame f of path p to b. More...
 

Detailed Description

With the Function Manager, you can manipulate the camera functions and the layer functions. Note that for all methods you must give the unique id. For the camera, this is the sceneId. For a layer functions, this is the panelId.

function cameraManip()
{
var cm = new MotionManager();
var sb = new StoryboardManager();
var fm = new FunctionManager();
// Camera of first scene in project
var sceneId = sb.sceneInProject(0);
System.println( "3dPath is " + cm.linkedCameraFunction( sceneId, "position.attr3dpath" ) );
System.println( "scale x is " + cm.linkedCameraFunction( sceneId, "scale.x" ) );
System.println( "scale y is " + cm.linkedCameraFunction( sceneId, "scale.y" ) );
System.println( "scale z is " + cm.linkedCameraFunction( sceneId, "scale.z" ) );
System.println( "rotation is " + cm.linkedCameraFunction( sceneId, "rotation.anglez" ) );
System.println( "skew is " + cm.linkedCameraFunction( sceneId, "skew" ) );
var path3d = cm.linkedCameraFunction( sceneId, "position.attr3dpath" );
var nbPoints = fm.numberOfPointsPath3d( sceneId, path3d )
System.println( " number of points on the path " + nbPoints );
// 3d path points
for ( var i = 0; i < nbPoints; ++i )
{
"locked At " + fm.pointLockedAtFrame( sceneId, path3d, i)
+ ": pointx : " + fm.pointXPath3d( sceneId, path3d, i)
+ " pointy : " + fm.pointYPath3d( sceneId, path3d, i)
+ " pointz : " + fm.pointZPath3d( sceneId, path3d, i)
+ " tension : " + fm.pointTensionPath3d( sceneId, path3d, i)
+ " continuity : " + fm.pointContinuityPath3d( sceneId, path3d, i)
+ " bias : " + fm.pointBiasPath3d( sceneId, path3d, i)
);
}
// Change the Y value of the path
fm.setPointPath3d( sceneId, path3d, 1, 3.859611992560042, 4.0, -1.2445449829101562, 0.0,0.0,0.0);
// Add a key frame at the 2 frame in the shot
fm.addKeyFramePath3d( sceneId, path3d, 3, 3.859611992560042, 4.0, -1.2445449829101562, 0.0,0.0,0.0);
// Skew function on camera, which is a bezier
var foc= cm.linkedCameraFunction( sceneId, "skew" );
System.println( "skew is " + cm.linkedCameraFunction( sceneId, "skew" ) );
nbPoints = fm.numberOfPoints( sceneId, foc )
for ( var i = 0; i < nbPoints; ++i )
{
"locked At " + fm.pointLockedAtFrame( sceneId, foc, i)
+ ": pointx : " + fm.pointX( sceneId, foc, i)
+ " pointy : " + fm.pointY( sceneId, foc, i)
+ " handle left x : " + fm.pointHandleLeftX( sceneId, foc, i)
+ " handle left y : " + fm.pointHandleLeftY( sceneId, foc, i)
+ " handle right x : " + fm.pointHandleRightX( sceneId, foc, i)
+ " handle right y : " + fm.pointHandleRightY( sceneId, foc, i)
+ " seg : " + fm.pointConstSeg( sceneId, foc, i)
+ " continuity : " + fm.pointContinuity( sceneId, foc, i)
);
}
// Scale on camera is a Velobase TV
var foc= cm.linkedCameraFunction( sceneId, "scale.x" );
// System.println( "scale is " + cm.linkedCameraFunction( sceneId, "scale.x" ) );
nbPoints = fm.numberOfPoints( sceneId, foc )
System.println( " nb points on the scale " + nbPoints );
for ( var i = 0; i < nbPoints; ++i )
{
"locked At " + fm.pointLockedAtFrame( sceneId, foc, i)
+ ": pointx : " + fm.pointX( sceneId, foc, i)
+ " pointy : " + fm.pointY( sceneId, foc, i)
);
}
}
function layerManip()
{
var cm = new MotionManager();
var sb = new StoryboardManager();
var fm = new FunctionManager();
// 11th panel in project
var panelId = sb.panelInProject(11);
System.println( "3dPath is " + cm.linkedLayerFunction( panelId, 0,"offset.attr3dpath" ) );
System.println( "scale x is " + cm.linkedLayerFunction( panelId, 0,"scale.x" ) );
System.println( "scale y is " + cm.linkedLayerFunction( panelId, 0,"scale.y" ) );
System.println( "scale z is " + cm.linkedLayerFunction( panelId,0, "scale.z" ) );
System.println( "rotation is " + cm.linkedLayerFunction( panelId,0, "rotation.anglez" ) );
System.println( "skew is " + cm.linkedLayerFunction( panelId, 0,"skew" ) );
// First layer of the panel, the offset tv
var path3d = cm.linkedLayerFunction( panelId,0, "offset.attr3dpath" );
var nbPoints = fm.numberOfPointsPath3d( panelId, path3d )
System.println( " number of points on the path " + nbPoints );
// 3d path
for ( var i = 0; i < nbPoints; ++i )
{
"locked At " + fm.pointLockedAtFrame( panelId, path3d, i)
+ ": pointx : " + fm.pointXPath3d( panelId, path3d, i)
+ " pointy : " + fm.pointYPath3d( panelId, path3d, i)
+ " pointz : " + fm.pointZPath3d( panelId, path3d, i)
+ " tension : " + fm.pointTensionPath3d( panelId, path3d, i)
+ " continuity : " + fm.pointContinuityPath3d( panelId, path3d, i)
+ " bias : " + fm.pointBiasPath3d( panelId, path3d, i)
);
}
// Change the Y value of the path on the second keyframe
fm.setPointPath3d( panelId, path3d, 1, 2.96, 2.0, 0.0, 0.0,0.0,0.0);
// Add a key frame at the 10 frame in the panel, knowing that the panel is always 20 frames long
// fm.addKeyFramePath3d( panelId, path3d, 9, 2.96, 6.0, 0.0, 0.0,0.0,0.0 );
fm.removePointPath3d( panelId, path3d, 9 );
}

Member Function Documentation

◆ addCtrlPointAfterPath3d

bool FunctionManager::addCtrlPointAfterPath3d ( String  shotId,
String  columnName,
int  point,
double  x,
double  y,
double  z,
double  tension,
double  continuity,
double  bias 
)
slot

adds a keyframe after a point on a 3D Path and sets the X, Y and Z values, as well as the tension, continuity and bias

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.
xx value for the point
yY value for the point
zz value for the point
tensiontension value of the keyframe
continuitycontinuity value of the keyframe
biasbias value of the keyframe

◆ addKeyFramePath3d

bool FunctionManager::addKeyFramePath3d ( String  shotId,
String  columnName,
int  frame,
double  x,
double  y,
double  z,
double  tension,
double  continuity,
double  bias 
)
slot

adds a keyframe to a 3D Path and sets the X, Y and Z value, as well as the tension, continuity and bias.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
frameFrame number for the point
xx value for the point
yY value for the point
zz value for the point
tensiontension value of the keyframe
continuitycontinuity value of the keyframe
biasbias value of the keyframe

◆ angleEaseIn

double FunctionManager::angleEaseIn ( String  shotId,
String  columnName,
int  point 
)
slot

returns the angle of the ease-in handle

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ angleEaseOut

double FunctionManager::angleEaseOut ( String  shotId,
String  columnName,
int  point 
)
slot

returns the angle of the ease-out handle

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ clearKeyFrame

bool FunctionManager::clearKeyFrame ( String  shotId,
String  columnName,
double  AtFrame 
)
slot

clears a keyframe on a column

Parameters
columnNameThe name of the column
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
AtFrameframe

◆ functionType

String FunctionManager::functionType ( String  shotId,
String  columnName 
)
slot

returns the type of the function ( Bezier, Ease, VeloBased or 3dPath )

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ getEntry

String FunctionManager::getEntry ( String  shotId,
String  columnName,
int  subColumn,
double  AtFrame 
)
slot

gets a value from a column at the given frame

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
subColumnThe number value of the sub-column. This only exists in the case of 3D Path columns, which include a group of sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has a number: X=1 Y=2 Z=3 Velocity = 4
AtFrameframe

◆ holdStartFrame

int FunctionManager::holdStartFrame ( String  shotId,
String  columnName 
)
slot

returns the Start value from the Hold Value Editor dialog box, for Bezier and Velo-based Function Editors.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ holdStep

int FunctionManager::holdStep ( String  shotId,
String  columnName 
)
slot

returns the Step value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ holdStopFrame

int FunctionManager::holdStopFrame ( String  shotId,
String  columnName 
)
slot

returns the Stop value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ numberOfPoints

int FunctionManager::numberOfPoints ( String  shotId,
String  columnName 
)
slot

returns the number of keyframes and control points on a curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ numberOfPointsPath3d

int FunctionManager::numberOfPointsPath3d ( String  shotId,
String  columnName 
)
slot

returns the number of keyframes and control points on the 3D Path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column

◆ pointBiasPath3d

double FunctionManager::pointBiasPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the bias value for the specified point on the 3D Path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointConstSeg

bool FunctionManager::pointConstSeg ( String  shotId,
String  columnName,
int  point 
)
slot

returns a 1 (one) to indicate that the point is on a ant segment, or a 0 (zero) to indicate that the point is not on a ant segment

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointContinuity

String FunctionManager::pointContinuity ( String  shotId,
String  columnName,
int  point 
)
slot

returns the continuity of the curve that follows the point. One of the following values will be returned, in upper-case: SMOOTH, CORNER or STRAIGHT

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointContinuityPath3d

double FunctionManager::pointContinuityPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointEaseIn

double FunctionManager::pointEaseIn ( String  shotId,
String  columnName,
int  point 
)
slot

returns the number of frames in the ease-in

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointEaseOut

double FunctionManager::pointEaseOut ( String  shotId,
String  columnName,
int  point 
)
slot

returns the number of frames in the ease-out

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointHandleLeftX

double FunctionManager::pointHandleLeftX ( String  shotId,
String  columnName,
int  point 
)
slot

returns the X value of the left handle of a point on a curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointHandleLeftY

double FunctionManager::pointHandleLeftY ( String  shotId,
String  columnName,
int  point 
)
slot

returns the Y value of the left handle of a point on a curve.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointHandleRightX

double FunctionManager::pointHandleRightX ( String  shotId,
String  columnName,
int  point 
)
slot

returns the X value of the right handle of a point on a curve.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointHandleRightY

double FunctionManager::pointHandleRightY ( String  shotId,
String  columnName,
int  point 
)
slot

returns the Y value of the right handle of a point on a curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointLockedAtFrame

double FunctionManager::pointLockedAtFrame ( String  shotId,
String  columnName,
int  point 
)
slot

returns the frame at which it's locked, or returns 0 if the point is not locked.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointTensionPath3d

double FunctionManager::pointTensionPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the tension value for the specified point on the 3D Path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointX

double FunctionManager::pointX ( String  shotId,
String  columnName,
int  point 
)
slot

returns the X value (frame number) of a point on a function curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointXPath3d

double FunctionManager::pointXPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the X path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointY

double FunctionManager::pointY ( String  shotId,
String  columnName,
int  point 
)
slot

returns the Y value of a point on a function curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointYPath3d

double FunctionManager::pointYPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the Y path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ pointZPath3d

double FunctionManager::pointZPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the Z path

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ removePointPath3d

bool FunctionManager::removePointPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

removePointPath3d may be used to remove either a key frame, or a control point

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.

◆ setBezierPoint

bool FunctionManager::setBezierPoint ( String  shotId,
String  columnName,
int  frame,
double  y,
double  handleLeftX,
double  handleLeftY,
double  handleRightX,
double  handleRightY,
bool  Seg,
String  continuity 
)
slot

sets the values of a point on a Bezier function curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
frameFrame number for the point
yY value for the poin
handleLeftXX value for the left handle of the point
handleLeftYY value for the left handle
handleRightXX value for the right handle
handleRightYY value for the right handle
SegBoolean expression (with a true or false value) to indicate whether the segment is ant or interpolated
continuityString value for the continuity of the point. The string must be in all upper-case. The following are the acceptable values: STRAIGHT, SMOOTH and CORNER

◆ setEasePoint

bool FunctionManager::setEasePoint ( String  shotId,
String  columnName,
int  frame,
double  y,
double  easeIn,
double  angleEaseIn,
double  easeOut,
double  angleEaseOut,
bool  Seg,
String  continuity 
)
slot

sets the values of a point on an Ease function curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
frameFrame number for the point
yY value for the point
easeInThe number of frames in the ease-in
angleEaseInThe angle of the ease-in handle
easeOutThe number of frames in the ease-out
angleEaseOutThe angle of the ease-out handle
SegBoolean expression (with a true or false value) to indicate whether the segment is ant or interpolated
continuityString value for the continuity of the point. The string must be in all upper-case. The following are the acceptable values: STRAIGHT, SMOOTH and CORNER

◆ setEntry

bool FunctionManager::setEntry ( String  shotId,
String  columnName,
int  subColumn,
double  AtFrame,
String  value 
)
slot

sets a value on a column at the given frame

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
subColumnThe number value of the sub-column. This only exists in the case of 3D Path columns, which include a group of sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has a number: X=1 Y=2 Z=3 Velocity = 4
AtFrameframe
value: the new value

◆ setHoldStartFrame

bool FunctionManager::setHoldStartFrame ( String  shotId,
String  columnName,
int  start 
)
slot

sets the Start value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
startstart frame of the hold

◆ setHoldStep

bool FunctionManager::setHoldStep ( String  shotId,
String  columnName,
int  step 
)
slot

sets the Hold value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
stepvalue of the steps in the hold.

◆ setHoldStopFrame

bool FunctionManager::setHoldStopFrame ( String  shotId,
String  columnName,
int  stop 
)
slot

sets the Stop value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
stopstop frame of the hold

◆ setKeyFrame

bool FunctionManager::setKeyFrame ( String  shotId,
String  columnName,
double  AtFrame 
)
slot

sets a keyframe on a column

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
AtFrameframe

◆ setPath3dPointConstantSegment

bool FunctionManager::setPath3dPointConstantSegment ( String  shotId,
String  columnName,
int  point,
bool  ant 
)
slot

sets the ant segment flag of point i of path p to b.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.
ant: bool flag

◆ setPath3dPointConstantSegmentForFrame

bool FunctionManager::setPath3dPointConstantSegmentForFrame ( String  shotId,
String  columnName,
double  point,
bool  ant 
)
slot

sets the ant segment flag of point found at frame f of path p to b.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.
ant: bool flag

◆ setPointPath3d

bool FunctionManager::setPointPath3d ( String  shotId,
String  columnName,
int  point,
double  x,
double  y,
double  z,
double  tension,
double  continuity,
double  bias 
)
slot

setPointPath3d may be used to set values in either a key frame, or a control point, but cannot change a key frame into a control point or a control point into a key frame. To change a key frame into a control point or a control point into a key frame, you must remove the point and add a new point.

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
point: The number of the point on the curve, from 0 to n, where n is the total number of points. The last point on the curve is n-1.
xx value for the point
yY value for the point
zz value for the point
tensiontension value of the keyframe
continuitycontinuity value of the keyframe
biasbias value of the keyframe

◆ setVeloBasePoint

bool FunctionManager::setVeloBasePoint ( String  shotId,
String  columnName,
int  frame,
double  y 
)
slot

sets the values of a point on an Velobased function curve

Parameters
shotIdUnique Id of shot ( for camera function ) or panel ( for layer function )
columnNameThe name of the column
frameFrame number for the point
yY value for the point