Storyboard
List of all members
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...

#include <functionManager.h>

Inheritance diagram for FunctionManager:
Inheritance graph
[legend]
Collaboration diagram for FunctionManager:
Collaboration graph
[legend]

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.
 
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
 
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
 
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
 
String getEntry (String shotId, String columnName, int subColumn, double AtFrame)
 gets a value from a column at the given frame
 
bool setKeyFrame (String shotId, String columnName, double AtFrame)
 sets a keyframe on a column
 
bool clearKeyFrame (String shotId, String columnName, double AtFrame)
 clears a keyframe on a column
 
int numberOfPoints (String shotId, String columnName)
 returns the number of keyframes and control points on a curve
 
String functionType (String shotId, String columnName)
 returns the type of the function ( Bezier, Ease, VeloBased or 3dPath )
 
double pointX (String shotId, String columnName, int point)
 returns the X value (frame number) of a point on a function curve
 
double pointY (String shotId, String columnName, int point)
 returns the Y value of a point on a function curve
 
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
 
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
 
Bezier Func
double pointHandleLeftX (String shotId, String columnName, int point)
 returns the X value of the left handle of a point on a curve
 
double pointHandleLeftY (String shotId, String columnName, int point)
 returns the Y value of the left handle of a point on a curve.
 
double pointHandleRightX (String shotId, String columnName, int point)
 returns the X value of the right handle of a point on a curve.
 
double pointHandleRightY (String shotId, String columnName, int point)
 returns the Y value of the right handle of a point on a curve
 
Ease Func
double pointEaseIn (String shotId, String columnName, int point)
 returns the number of frames in the ease-in
 
double angleEaseIn (String shotId, String columnName, int point)
 returns the angle of the ease-in handle
 
double pointEaseOut (String shotId, String columnName, int point)
 returns the number of frames in the ease-out
 
double angleEaseOut (String shotId, String columnName, int point)
 returns the angle of the ease-out handle
 
Catmull (Path3d)
int numberOfPointsPath3d (String shotId, String columnName)
 returns the number of keyframes and control points on the 3D Path
 
double pointXPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the X path
 
double pointYPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the Y path
 
double pointZPath3d (String shotId, String columnName, int point)
 returns the value of the specified point on the Z path
 
double pointTensionPath3d (String shotId, String columnName, int point)
 returns the tension value for the specified point on the 3D Path
 
double pointContinuityPath3d (String shotId, String columnName, int point)
 returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path.
 
double pointBiasPath3d (String shotId, String columnName, int point)
 returns the bias value for the specified point on the 3D Path
 
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.
 
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
 
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
 
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.
 
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
 
bool setVeloBasePoint (String shotId, String columnName, int frame, double y)
 sets the values of a point on an Velobased function curve
 
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
 
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.
 
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
 
bool removePointPath3d (String shotId, String columnName, int point)
 removePointPath3d may be used to remove either a key frame, or a control point
 
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.
 
bool setPath3dPointConstantSegment (String shotId, String columnName, int point, bool ant)
 sets the ant segment flag of point i of path p to b.
 
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.
 

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 )
{
System.println(
"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 )
{
System.println(
"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 )
{
System.println(
"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 )
{
System.println(
"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

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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
x,:x value for the point
y,:Y value for the point
z,:z value for the point
tension,:tension value of the keyframe
continuity,:continuity value of the keyframe
bias,:bias value of the keyframe
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
frame,:Frame number for the point
x,:x value for the point
y,:Y value for the point
z,:z value for the point
tension,:tension value of the keyframe
continuity,:continuity value of the keyframe
bias,:bias value of the keyframe
double FunctionManager::angleEaseIn ( String  shotId,
String  columnName,
int  point 
)
slot

returns the angle of the ease-in handle

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::angleEaseOut ( String  shotId,
String  columnName,
int  point 
)
slot

returns the angle of the ease-out handle

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
bool FunctionManager::clearKeyFrame ( String  shotId,
String  columnName,
double  AtFrame 
)
slot

clears a keyframe on a column

Parameters
columnName,:The name of the column
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
AtFrame,:frame
String FunctionManager::functionType ( String  shotId,
String  columnName 
)
slot

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

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
String FunctionManager::getEntry ( String  shotId,
String  columnName,
int  subColumn,
double  AtFrame 
)
slot

gets a value from a column at the given frame

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
subColumn,:The 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
AtFrame,:frame
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
int FunctionManager::numberOfPoints ( String  shotId,
String  columnName 
)
slot

returns the number of keyframes and control points on a curve

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
int FunctionManager::numberOfPointsPath3d ( String  shotId,
String  columnName 
)
slot

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

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
double FunctionManager::pointBiasPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

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

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointEaseIn ( String  shotId,
String  columnName,
int  point 
)
slot

returns the number of frames in the ease-in

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointEaseOut ( String  shotId,
String  columnName,
int  point 
)
slot

returns the number of frames in the ease-out

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointTensionPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

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

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointX ( String  shotId,
String  columnName,
int  point 
)
slot

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

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointXPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the X path

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointY ( String  shotId,
String  columnName,
int  point 
)
slot

returns the Y value of a point on a function curve

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointYPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the Y path

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
double FunctionManager::pointZPath3d ( String  shotId,
String  columnName,
int  point 
)
slot

returns the value of the specified point on the Z path

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
frame,:Frame number for the point
y,:Y value for the poin
handleLeftX,:X value for the left handle of the point
handleLeftY,:Y value for the left handle
handleRightX,:X value for the right handle
handleRightY,:Y value for the right handle
Seg,:Boolean expression (with a true or false value) to indicate whether the segment is ant or interpolated
continuity,:String 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
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
frame,:Frame number for the point
y,:Y value for the point
easeIn,:The number of frames in the ease-in
angleEaseIn,:The angle of the ease-in handle
easeOut,:The number of frames in the ease-out
angleEaseOut,:The angle of the ease-out handle
Seg,:Boolean expression (with a true or false value) to indicate whether the segment is ant or interpolated
continuity,:String 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
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
subColumn,:The 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
AtFrame,:frame
value: the new value
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
start,:start frame of the hold
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
step,:value of the steps in the hold.
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
stop,:stop frame of the hold
bool FunctionManager::setKeyFrame ( String  shotId,
String  columnName,
double  AtFrame 
)
slot

sets a keyframe on a column

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
AtFrame,:frame
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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
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
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The 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.
x,:x value for the point
y,:Y value for the point
z,:z value for the point
tension,:tension value of the keyframe
continuity,:continuity value of the keyframe
bias,:bias value of the keyframe
bool FunctionManager::setVeloBasePoint ( String  shotId,
String  columnName,
int  frame,
double  y 
)
slot

sets the values of a point on an Velobased function curve

Parameters
shotId,:Unique Id of shot ( for camera function ) or panel ( for layer function )
columnName,:The name of the column
frame,:Frame number for the point
y,:Y value for the point

The documentation for this class was generated from the following file: