func Class Reference

With the Function Curve functions, you can retrieve and modify values in the function curves. More...

#include <funcinterface.h>

Inheritance diagram for func:

Collaboration diagram for func:

Public Slots
Func Data
int	holdStartFrame (QString columnName) const
	returns the Start value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
int	holdStopFrame (QString columnName) const
	returns the Stop value from the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors
int	holdStep (QString columnName) const
	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
int	numberOfPoints (QString columnName) const
	returns the number of keyframes and control points on a curve
double	pointX (QString columnName, int point) const
	returns the X value (frame number) of a point on a function curve
double	pointY (QString columnName, int point) const
	returns the Y value of a point on a function curve
bool	pointConstSeg (QString columnName, int point) const
	returns a 1 (one) to indicate that the point is on a constant segment, or a 0 (zero) to indicate that the point is not on a constant segment
QString	pointContinuity (QString columnName, int point) const
	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 (QString columnName, int point) const
	returns the X value of the left handle of a point on a curve
double	pointHandleLeftY (QString columnName, int point) const
	returns the Y value of the left handle of a point on a curve.
double	pointHandleRightX (QString columnName, int point) const
	returns the X value of the right handle of a point on a curve.
double	pointHandleRightY (QString columnName, int point) const
	returns the Y value of the right handle of a point on a curve
Ease Func
double	pointEaseIn (QString columnName, int point) const
	returns the number of frames in the ease-in
double	angleEaseIn (QString columnName, int point) const
	returns the angle of the ease-in handle
double	pointEaseOut (QString columnName, int point) const
	returns the number of frames in the ease-out
double	angleEaseOut (QString columnName, int point) const
	returns the angle of the ease-out handle
Catmull (Path3d)
int	numberOfPointsPath3d (QString columnName) const
	returns the number of keyframes and control points on the 3D Path
double	pointXPath3d (QString columnName, int point) const
	returns the value of the specified point on the X path
double	pointYPath3d (QString columnName, int point) const
	returns the value of the specified point on the Y path
double	pointZPath3d (QString columnName, int point) const
	returns the value of the specified point on the Z path
double	pointTensionPath3d (QString columnName, int point) const
	returns the tension value for the specified point on the 3D Path
double	pointContinuityPath3d (QString columnName, int point) const
	returns the continuity value (STRAIGHT, SMOOTH or CORNER) for the specified point on the 3D Path.
double	pointBiasPath3d (QString columnName, int point) const
	returns the bias value for the specified point on the 3D Path
double	pointLockedAtFrame (QString columnName, int point) const
	returns the frame at which it's locked, or returns 0 if the point is not locked.
Func Edition
bool	setHoldStartFrame (QString columnName, int start)
	sets the Start value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors
bool	setHoldStopFrame (QString columnName, int stop)
	sets the Stop value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors
bool	setHoldStep (QString columnName, int step)
	sets the Hold value in the Hold Value Editor dialog box, for Bezier, Ease and Velo-based Function Editors.
bool	setBezierPoint (QString columnName, int frame, double y, double handleLeftX, double handleLeftY, double handleRightX, double handleRightY, bool constSeg, QString continuity)
	sets the values of a point on a Bezier function curve
bool	setEasePoint (QString columnName, int frame, double y, double easeIn, double angleEaseIn, double easeOut, double angleEaseOut, bool constSeg, QString continuity)
	sets the values of a point on an Ease function curve
bool	setVeloBasedPoint (QString columnName, int frame, double y)
	sets the values of a point on a Velocity-Based function curve
bool	addKeyFramePath3d (QString 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 (QString 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 (QString columnName, int point)
	removePointPath3d may be used to remove either a key frame, or a control point
bool	setPointPath3d (QString 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 (QString columnName, int point, bool constant)
	sets the constant segment flag of point i of path p to b.
bool	setPath3dPointConstantSegmentForFrame (QString columnName, double point, bool constant)
	sets the constant segment flag of point found at frame f of path p to b.

Detailed Description

With the Function Curve functions, you can retrieve and modify values in the function curves.

function addSetFunctions()
{
  //creates the function columns if needed
  if ( !column.add("3DPATH_FUNC", "3DPATH") )
     System.println( "Error creating 3dpath column" );

  if ( !column.add("BEZIER_FUNC", "BEZIER") )
    System.println( "Error creating bezier column" );

  if ( !column.add("EASE_FUNC", "EASE") )
    System.println( "Error creating ease column" );

  // adds 2 keyframes on a 3DPATH at frame 6 and 12
  // with values x=2, y=2, z=1, tension=3, continuity=-1, bias=1
  func.addKeyFrame3DPath( "3DPATH_FUNC", 6, 2, 2, 1, 3, -1, 1 );
  func.addKeyFrame3DPath( "3DPATH_FUNC", 12, 2, 2, 1, 3, -1, 1);

  // removes a keyframe on 3DPATH at frame 12
  func.removePoint3DPath( "3DPATH_FUNC", 12 );

  // prints the number of points on a 3DPath column
  var pathPoints = func.numberOfPoints3DPath("3DPATH_FUNC");
  System.println( "3DPATH_FUNC column has " + pathPoints + "points" );

  // adds a keyframe on a BEZIER at frame 10 with values y=5,
  // handle_leftx=9, handle_lefty=5, handle_rightx=12,
  // handle_righty=-0.5, constant seg=false, continuity=smooth
  if ( ! func.setBezierPoint( "BEZIER_FUNC", 10, 5, 9, 5, 12, - 0.5, false, "SMOOTH" ) )
    System.println( "Error creating point on bezier" );

  // sets the step value for a function column starting at frame 1 upto frame 15 hold 2
  func.setHoldStartFrame("BEZIER_FUNC", 1);
  func.setHoldStopFrame("BEZIER_FUNC", 15);
  func.setHoldStep("BEZIER_FUNC", 2);

  // prints the number of points on a function column
  var bezPoints = func.numberOfPoints("BEZIER_FUNC");
  System.println( "BEZIER_FUNC column has " + bezPoints + " points" );

  // adds a keyframe on an EASE at frame 10 with values y=5,
  // ease_inx=0, ease_iny=0, ease_outx=0, ease_outy=180
  // constant seg=true, continuity=straight
  if ( ! func.setEasePoint( "EASE_FUNC", 10, 6, 0, 0, 0, 180, true, "STRAIGHT" ) )
  System.println( "Error creating point on ease" );

Member Function Documentation

bool func::addCtrlPointAfterPath3d ( QString  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

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 func::addKeyFramePath3d ( QString  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

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 func::angleEaseIn ( QString  columnName, int  point  ) const

slot

returns the angle of the ease-in handle

Parameters

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 func::angleEaseOut ( QString  columnName, int  point  ) const

slot

returns the angle of the ease-out handle

Parameters

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.

int func::holdStartFrame ( QString  columnName ) const

slot

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

Parameters

columnName,:

The name of the column

int func::holdStep ( QString  columnName ) const

slot

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

Parameters

columnName,:

The name of the column

int func::holdStopFrame ( QString  columnName ) const

slot

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

Parameters

columnName,:

The name of the column

int func::numberOfPoints ( QString  columnName ) const

slot

returns the number of keyframes and control points on a curve

Parameters

columnName,:

The name of the column

int func::numberOfPointsPath3d ( QString  columnName ) const

slot

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

Parameters

columnName,:

The name of the column

double func::pointBiasPath3d ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointConstSeg ( QString  columnName, int  point  ) const

slot

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

Parameters

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.

QString func::pointContinuity ( QString  columnName, int  point  ) const

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

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 func::pointContinuityPath3d ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointEaseIn ( QString  columnName, int  point  ) const

slot

returns the number of frames in the ease-in

Parameters

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 func::pointEaseOut ( QString  columnName, int  point  ) const

slot

returns the number of frames in the ease-out

Parameters

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 func::pointHandleLeftX ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointHandleLeftY ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointHandleRightX ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointHandleRightY ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointLockedAtFrame ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointTensionPath3d ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointX ( QString  columnName, int  point  ) const

slot

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

Parameters

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 func::pointXPath3d ( QString  columnName, int  point  ) const

slot

returns the value of the specified point on the X path

Parameters

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 func::pointY ( QString  columnName, int  point  ) const

slot

returns the Y value of a point on a function curve

Parameters

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 func::pointYPath3d ( QString  columnName, int  point  ) const

slot

returns the value of the specified point on the Y path

Parameters

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 func::pointZPath3d ( QString  columnName, int  point  ) const

slot

returns the value of the specified point on the Z path

Parameters

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 func::removePointPath3d ( QString  columnName, int  point  )

slot

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

Parameters

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 func::setBezierPoint ( QString  columnName, int  frame, double  y, double  handleLeftX, double  handleLeftY, double  handleRightX, double  handleRightY, bool  constSeg, QString  continuity  )

slot

sets the values of a point on a Bezier function curve

Parameters

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

bool func::setEasePoint ( QString  columnName, int  frame, double  y, double  easeIn, double  angleEaseIn, double  easeOut, double  angleEaseOut, bool  constSeg, QString  continuity  )

slot

sets the values of a point on an Ease function curve

Parameters

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

bool func::setHoldStartFrame ( QString  columnName, int  start  )

slot

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

Parameters

columnName,:	The name of the column
start,:	start frame of the hold

bool func::setHoldStep ( QString  columnName, int  step  )

slot

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

Parameters

columnName,:	The name of the column
step,:	value of the steps in the hold.

bool func::setHoldStopFrame ( QString  columnName, int  stop  )

slot

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

Parameters

columnName,:	The name of the column
stop,:	stop frame of the hold

bool func::setPath3dPointConstantSegment ( QString  columnName, int  point, bool  constant  )

slot

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

Parameters

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.
constant	: bool flag

bool func::setPath3dPointConstantSegmentForFrame ( QString  columnName, double  point, bool  constant  )

slot

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

Parameters

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.
constant	: bool flag

bool func::setPointPath3d ( QString  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

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 func::setVeloBasedPoint ( QString  columnName, int  frame, double  y  )

slot

sets the values of a point on a Velocity-Based function curve

Parameters

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:

• dox_files/funcinterface.h