OMH::TimelineMarker Class Reference

Detailed Description

An object that represents a single Timeline Marker in the scene.

Provided by the OMH::TimelineMarkerList from the project. The TimelineMarker represents a marker in the project's timeline.

The marker exists at a specific frame and spans a given length. It is represented by a colour region in the timeline. Only one marker can exist at a given frame, but multiple markers can span through the frame.

List Available Markers – Create a Marker

from ToonBoom import harmony                                 #Import the Harmony Module
sess = harmony.session()                                     #Get access to the Harmony session, this class.
project = sess.project                                       #Get the currently loaded project.

marker_list = project.timeline_markers                       #The interface for accessing, creating and modifying timeline markers.

scene = project.scene
frame_count = scene.frame_count

# Colourize and name the markers.
for n,marker in enumerate(marker_list):
  perc = float(marker.frame) / float(frame_count) 
  marker.colour = [ 255* perc, 0, 0, 255 * perc ]

Public Member Functions
void	select ()
	Select the timeline marker. More...
void	move_to_frame (int frame, bool ripple=false)
	Moves the timeline marker to a specific frame. More...
void	set_length (int length, bool ripple=false)
	Changes the length of the frame marker. More...
void	set_frame_end (int frameEnd, bool ripple=false)
	Changes the length of the frame marker. More...

Public Attributes
OMC::Colour *	colour
	Get and set the colour of the timeline marker object.
int	frame
	Get and set the frame of the timeline marker object.
int	frame_end
	Get and set the inclusive frame at which this timeline marker object ends.
QString	name
	Get and set the name of the timeline marker object in frames.
QString	note
	Get and set the note of the timeline marker object in frames.
bool	selected
	True if the timeline marker is selected.

Member Function Documentation

move_to_frame()

void OMH::TimelineMarker::move_to_frame	(	int	frame,
		bool	ripple = false
	)

Moves the timeline marker to a specific frame.

Moves the timeline marker to the frame – if ripple is true, all markers after this will be affected by the move.

select()

void OMH::TimelineMarker::select

(

)

Select the timeline marker.

set_frame_end()

void OMH::TimelineMarker::set_frame_end	(	int	frameEnd,
		bool	ripple = false
	)

Changes the length of the frame marker.

Changes the length of the timeline marker– if ripple is true, all markers after this will be affected by the change.

set_length()

void OMH::TimelineMarker::set_length	(	int	length,
		bool	ripple = false
	)

Changes the length of the frame marker.

Changes the length of the timeline marker– if ripple is true, all markers after this will be affected by the change.

Increment each marker while rippling

from ToonBoom import harmony                                 #Import the Harmony Module
sess = harmony.session()                                     #Get access to the Harmony session, this class.
project = sess.project                                       #Get the currently loaded project.

project.history.begin( "Moving Markers" )

marker_list = project.timeline_markers                       #The interface for accessing, creating and modifying timeline markers.

# Colourize and name the markers.
for n,marker in enumerate(marker_list):
  marker.set_length( n, True )

project.history.end()

Inheritance diagram for OMH::TimelineMarker:

Collaboration diagram for OMH::TimelineMarker: