OMC::KeyframeableColumn Class Reference

Detailed Description

The base class for all Keyframeable Columns.

The class is subclassed and specialized for all specific column types.
See the following for more information:
For more information, see the following:

• OMC::KeyframeableColumn : The generic Keyframeable Column interface.
• OMC::BezierColumn : A column providing an interpolated value from a bezier curve defined by control points.
• OMC::EaseColumn : A column providing a value based on interpolated easing points.
• OMC::Path3DColumn : A column providing a 3D Point value based on a path, keypoints and a velocity.
• OMC::QuaternionColumn : A column providing a quaternion rotation value.
• OMC::VeloBasedColumn : A column providing a value based on a curve path and a velocity.

Public Member Functions
void	keyframes_clear (int startFrame=1, int endFrame=-1)
	Removes the keyframe(s) located at the given range. More...
bool	keyframe_exists (QList< int > frame)
	Returns true if the column has a keyframe at the given argument. More...
QVariant	keyframe_create (QList< int > frame)
	Set or add a keyframe at the given frame. More...
void	keyframe_remove (QList< int > frame)
	Remove the keyframe at the given frame, if any.
QList< int >	keyframe_list () const
	Returns the list of frames at which there's a keyframe. More...
QVariant	get_entry (double atFrame, int subColumnIndex=-1) const virtual QVariant getEntry(double atFrame
	Returns the value of a cell in a column. More...
void	set_entry (double atFrame, QVariant value, int subColumnIndex=-1)
	Sets the value of a cell in a column. More...
void	scale (double scale_factor)
	Scales the values in a column by a scaling factor.

Public Attributes
int	hold_start
	The start value of the hold.
int	hold_stop
	The stop value of the hold.
int	hold_step
	The step value of the hold.
int	control_point_size
	The number of control points in the column.
OMC::ControlPointList *	control_points
	Get the controlpoints in the column.
QString	name
	Get/set the name of the column. This is the internal name of the column which is used as a unique identifier.
QString	display_name
	Get/Set the displayable name of the column (like it would appear in the xSheet view).
QString	type
	Get the type of the node.
QString	anonymous
	Get/set the anonymous state of the column.
QList< OMC::Node * >	linked_nodes
	Identifies nodes that are linked to the column.
QList< OMC::Attribute * >	linked_attributes
	Identifies attributes that are linked to the column.

Member Function Documentation

get_entry()

QVariant OMC::Column::get_entry ( double  atFrame, int  subColumnIndex = -1  ) const

inherited

Returns the value of a cell in a column.

Parameters

atFrame	: The frame number at which to retrieve the value from.
subColumnIndex	: The index of the sub-column. Only 3D Path columns support sub-column. They have sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has an index: X = 1 Y = 2 Z = 3 Velocity = 4

Returns

Returns the value of a cell in a column.

keyframe_create()

QVariant OMC::KeyframeableColumn::keyframe_create

(

QList< int >

frame

)

Set or add a keyframe at the given frame.

The value evaluated at the given frame will be the keyframe's value.

Parameters

frame

: The frame number or list of frame numbers to retrieve the value from.

keyframe_exists()

bool OMC::KeyframeableColumn::keyframe_exists

(

QList< int >

frame

)

Returns true if the column has a keyframe at the given argument.

Parameters

frame

: The frame number or list of frame numbers to retrieve the value from.

Returns

Returns true there is a keyframe at the given frame.

keyframe_list()

QList<int> OMC::KeyframeableColumn::keyframe_list

(

)

const

Returns the list of frames at which there's a keyframe.

Returns

Returns the list of frames at which there's a keyframe

keyframes_clear()

void OMC::KeyframeableColumn::keyframes_clear	(	int	startFrame = 1,
		int	endFrame = -1
	)

Removes the keyframe(s) located at the given range.

Parameters

startFrame	: The starting frame number of the range, inclusive.
endFrame	: The ending frame number of the range, inclusive.

set_entry()

void OMC::Column::set_entry ( double  atFrame, QVariant  value, int  subColumnIndex = -1  )

inherited

Sets the value of a cell in a column.

Parameters

atFrame	The frame number at which to set the value to.
value	: the new value
subColumnIndex	: The index of the sub-column. Only 3D Path columns support sub-column. They have sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has an index: X = 1 Y = 2 Z = 3 Velocity = 4

Inheritance diagram for OMC::KeyframeableColumn:

Collaboration diagram for OMC::KeyframeableColumn: