OMC::DrawingTimingColumn Class Reference

Detailed Description

Represents and provides the methods for an timing column in a scene.

The Timing column provides the timing for a DrawingAttribute (in Timing mode) or a TimingAttribute.

Public Member Functions
bool	contains (const QVariant &drawing) const
	Identifies if the list contains the drawing.
void	drawing_duplicate (int frameNumber)
	Duplicates the drawing at the specified frame in the specified column. More...
void	drawing_delete (int frameNumber)
	Deletes the drawing at the specified frame in the specified column. More...
void	key_exposure_add (int frameNumber)
	Adds a key drawing exposure at the specified frame in the specified column. More...
void	key_exposure_remove (int frameNumber)
	Removes a key drawing exposure at the specified frame in the specified column. More...
void	fill_empty (int startFrame, int endFrame)
	Fill with previous exposed drawings for the given range of frame. More...
void	lineTestFill (int startFrame, int nbFrames, QString prefix, bool keyFramesOnly)
	Fills the drawings from startFrame to startFrame+nbFrames with drawing duplicates named with a prefix. 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
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

drawing_delete()

void OMC::DrawingTimingColumn::drawing_delete

(

int

frameNumber

)

Deletes the drawing at the specified frame in the specified column.

Parameters

frame

: The frame number.

drawing_duplicate()

void OMC::DrawingTimingColumn::drawing_duplicate

(

int

frameNumber

)

Duplicates the drawing at the specified frame in the specified column.

Parameters

frame

: The frame number.

fill_empty()

void OMC::DrawingTimingColumn::fill_empty	(	int	startFrame,
		int	endFrame
	)

Fill with previous exposed drawings for the given range of frame.

Parameters

startFrame	: The starting frame.
endFrame	: The ending frame, just after the last filled frame.

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.

key_exposure_add()

void OMC::DrawingTimingColumn::key_exposure_add

(

int

frameNumber

)

Adds a key drawing exposure at the specified frame in the specified column.

Parameters

frameNumber

: The frame number.

key_exposure_remove()

void OMC::DrawingTimingColumn::key_exposure_remove

(

int

frameNumber

)

Removes a key drawing exposure at the specified frame in the specified column.

Parameters

frameNumber	: The frame number.
duplicateOnly	: If true, only remove duplicate/redundant key exposures.

lineTestFill()

void OMC::DrawingTimingColumn::lineTestFill	(	int	startFrame,
		int	nbFrames,
		QString	prefix,
		bool	keyFramesOnly
	)

Fills the drawings from startFrame to startFrame+nbFrames with drawing duplicates named with a prefix.

Parameters

startFrame	: The starting frame.
nbFrames	: The desired length.
prefix	: The desired prefix.
keyFramesOnly	: It will perform this operation only on drawings marked as "K" if keyOnly is true.

Returns

Returns true if successful.

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::DrawingTimingColumn:

Collaboration diagram for OMC::DrawingTimingColumn: