The func JavaScript global object. Retrieve and modify values of function curves. More...
Public Slots | |
Func Data | |
int | holdStartFrame (String columnName) |
Returns the Start value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors. More... | |
int | holdStopFrame (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 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 | |
int | numberOfPoints (String columnName) |
Returns the number of keyframes and control points on a curve. More... | |
double | pointX (String columnName, int point) |
Returns the X value (frame number) of a point on a function curve. More... | |
double | pointY (String columnName, int point) |
Returns the Y value of a point on a function curve. More... | |
bool | pointConstSeg (String columnName, int point) |
Returns true to indicate that the point is on a constant segment, or false to indicate that the point is not on a constant segment. More... | |
String | pointContinuity (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 columnName, int point) |
Returns the X value of the left handle of a point on a curve. More... | |
double | pointHandleLeftY (String columnName, int point) |
Returns the Y value of the left handle of a point on a curve. More... | |
double | pointHandleRightX (String columnName, int point) |
Returns the X value of the right handle of a point on a curve. More... | |
double | pointHandleRightY (String columnName, int point) |
Returns the Y value of the right handle of a point on a curve. More... | |
Ease Func | |
double | pointEaseIn (String columnName, int point) |
Returns the number of frames in the ease-in. More... | |
double | angleEaseIn (String columnName, int point) |
Returns the angle of the ease-in handle. More... | |
double | pointEaseOut (String columnName, int point) |
Returns the number of frames in the ease-out. More... | |
double | angleEaseOut (String columnName, int point) |
Returns the angle of the ease-out handle. More... | |
double | tensionEase (String columnName) |
Returns the tension of the ease column. More... | |
Catmull (Path3d) | |
int | numberOfPointsPath3d (String columnName) |
Returns the number of keyframes and control points on the 3D Path. More... | |
double | pointXPath3d (String columnName, int point) |
Returns the value of the specified point on the X path. More... | |
double | pointYPath3d (String columnName, int point) |
Returns the value of the specified point on the Y path. More... | |
double | pointZPath3d (String columnName, int point) |
Returns the value of the specified point on the Z path. More... | |
double | pointTensionPath3d (String columnName, int point) |
Returns the tension value for the specified point on the 3D Path. More... | |
double | pointContinuityPath3d (String columnName, int point) |
Returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path. More... | |
double | pointBiasPath3d (String columnName, int point) |
Returns the bias value for the specified point on the 3D Path. More... | |
double | pointLockedAtFrame (String columnName, int point) |
Returns the frame at which it's locked, or returns 0 if the point is not locked. More... | |
QScriptValue | convertToSeparate (String columnName, String conversionAlgo) |
Converts a 3D Path to a Separate, tuple of three beziers, and select it. More... | |
Func Edition | |
bool | setHoldStartFrame (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 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 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 columnName, int frame, double y, double handleLeftX, double handleLeftY, double handleRightX, double handleRightY, bool constSeg, String continuity) |
Sets the values of a point on a Bezier function curve. More... | |
bool | setEasePoint (String columnName, int frame, double y, double easeIn, double angleEaseIn, double easeOut, double angleEaseOut, bool constSeg, String continuity) |
Sets the values of a point on an Ease function curve. More... | |
bool | setVeloBasedPoint (String columnName, int frame, double y) |
Sets the values of a point on a Velocity-Based function curve. More... | |
bool | addKeyFramePath3d (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 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 columnName, int point) |
Used to remove either a key frame, or a control point. More... | |
bool | setPointPath3d (String columnName, int point, double x, double y, double z, double tension, double continuity, double bias) |
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. More... | |
bool | setPath3dPointConstantSegment (String columnName, int point, bool constant) |
Sets the constant segment flag of point i of path p to b. More... | |
bool | setPath3dPointConstantSegmentForFrame (String columnName, double point, bool constant) |
Sets the constant segment flag of point found at frame f of path p to b. More... | |
The func JavaScript global object. Retrieve and modify values of function curves.
|
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.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
x | : X value for the point. |
y | : Y value for the point. |
z | : Z value for the point. |
tension | : The tension value of the keyframe. |
continuity | : The continuity value of the keyframe. |
bias | : The bias value of the keyframe. |
|
slot |
Adds a keyframe to a 3D Path and sets the X, Y and Z value, as well as the tension, continuity and bias.
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 | : The tension value of the keyframe. |
continuity | : The continuity value of the keyframe. |
bias | : The bias value of the keyframe. |
|
slot |
Returns the angle of the ease-in handle.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the angle of the ease-out handle.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Converts a 3D Path to a Separate, tuple of three beziers, and select it.
The example below converts a 3D Path to a Separate with the chosen algorithm. Then links to the Separate beziers (node.linkAttr).
With conversionAlgo = "TRANSFORM_MATRIX" : returns a identical spline except for the frame rate, i.e. there will be a slight change on frame's positions on the spline. When using "TRANSFORM_MATRIX" the velocity information is not preserved. With conversionAlgo = "BEZIER_FITTER" : Prioritize frame rate and velocity changes over spline's integrity.
columnName | : The name of the column. |
conversionAlgo | : The name of the conversion method used. Either "TRANSFORM_MATRIX" or "BEZIER_FITTER". |
|
slot |
Returns the Start value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
|
slot |
Returns the Step value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
|
slot |
Returns the Stop value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
|
slot |
Returns the number of keyframes and control points on a curve.
columnName | : The name of the column. |
|
slot |
Returns the number of keyframes and control points on the 3D Path.
columnName | : The name of the column. |
|
slot |
Returns the bias value for the specified point on the 3D Path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns true to indicate that the point is on a constant segment, or false to indicate that the point is not on a constant segment.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
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.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the number of frames in the ease-in.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the number of frames in the ease-out.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the X value of the left handle of a point on a curve.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the Y value of the left handle of a point on a curve.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the X value of the right handle of a point on a curve.
columnName | : The name of the column |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the Y value of the right handle of a point on a curve.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the frame at which it's locked, or returns 0 if the point is not locked.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the tension value for the specified point on the 3D Path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the X value (frame number) of a point on a function curve.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the value of the specified point on the X path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the Y value of a point on a function curve.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the value of the specified point on the Y path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Returns the value of the specified point on the Z path.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Used to remove either a key frame, or a control point.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
|
slot |
Sets the values of a point on a Bezier function curve.
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. |
constSeg | : Boolean expression (with a true or false value) to indicate whether the segment is constant 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. |
|
slot |
Sets the values of a point on an Ease function curve.
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. |
constSeg | : Boolean expression (with a true or false value) to indicate whether the segment is constant 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. |
|
slot |
Sets the Start value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
start | : The start frame of the hold. |
|
slot |
Sets the Hold value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
step | : The value of the steps in the hold. |
|
slot |
Sets the Stop value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
columnName | : The name of the column. |
stop | : The stop frame of the hold. |
|
slot |
Sets the constant segment flag of point i of path p to b.
columnName | The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
constant | : bool flag. |
|
slot |
Sets the constant segment flag of point found at frame f of path p to b.
columnName | The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
constant | : bool flag. |
|
slot |
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.
columnName | : The name of the column. |
point | : The number of the point on the curve, from 0 to n-1, where n is the total number of points. |
x | : X value for the point. |
y | : Y value for the point. |
z | : Z value for the point. |
tension | : The tension value of the keyframe. |
continuity | : The continuity value of the keyframe. |
bias | : The bias value of the keyframe. |
|
slot |
Sets the values of a point on a Velocity-Based function curve.
columnName | : The name of the column. |
frame | : Frame number for the point. |
y | : Y value for the point. |
|
slot |
Returns the tension of the ease column.
columnName | : The name of the column. |