Public Member Functions
def	__init__
def	boundingRect
def	can_zoom
def	can_zoom_in
def	can_zoom_out
def	emit_play_region
def	end_stamp
def	get_renderers
def	get_viewer_types
def	get_zoom_interval
def	handle_close
def	has_selected_region
def	is_renderer_active
def	load_plugins
def	map_dstamp_to_dx
def	map_dx_to_dstamp
def	map_stamp_to_x
def	map_x_to_stamp
def	map_y_to_topic
def	on_left_down
def	on_middle_down
def	on_mouse_move
def	on_mouse_up
def	on_mousewheel
def	paint
def	play_region
def	reset_timeline
def	reset_zoom
def	set_renderer_active
def	set_renderers_active
def	set_timeline_view
def	start_stamp
def	toggle_renderers
def	translate_timeline
def	translate_timeline_left
def	translate_timeline_right
def	zoom_in
def	zoom_out
def	zoom_timeline
Public Attributes
	index_cache
	index_cache_cv
	invalidated_caches
	plugin_provider
	topics
Properties
	playhead = property(_get_playhead, _set_playhead)
Private Member Functions
def	_draw_bag_ends
def	_draw_history_border
def	_draw_major_divisions
def	_draw_minor_divisions
def	_draw_playhead
def	_draw_selected_region
def	_draw_time_divisions
def	_draw_topic_dividers
def	_draw_topic_histories
def	_draw_topic_history
def	_draw_topic_names
def	_find_regions
def	_get_label
def	_get_playhead
def	_get_stamps
def	_history_right
def	_layout
def	_qfont_width
def	_set_playhead
def	_trimmed_topic_name
def	_update_index_cache
Private Attributes
	_active_message_line_width
	_bag_end_color
	_clicked_pos
	_datatype_colors
	_default_brush
	_default_datatype_color
	_default_msg_combine_px
	_default_pen
	_dragged_pos
	_end_stamp
	_history_background_color
	_history_background_color_alternate
	_history_bottom
	_history_bounds
	_history_left
	_history_top
	_history_width
	_index_cache_thread
	_major_division_pen
	_major_divisions_label_indent
	_major_spacing
	_margin_bottom
	_margin_left
	_margin_right
	_max_zoom
	_max_zoom_speed
	_min_zoom
	_min_zoom_speed
	_minor_division_pen
	_minor_division_tick_pen
	_minor_spacing
	_paused
	_playhead
	_playhead_color
	_playhead_line_width
	_playhead_pointer_size
	_rendered_topics
	_scene_width
	_sec_divisions
	_selected_left
	_selected_region_color
	_selected_region_outline_ends_color
	_selected_region_outline_top_color
	_selected_right
	_selecting_mode
	_selection_handle_width
	_stamp_left
	_stamp_right
	_start_stamp
	_time_font
	_time_font_height
	_time_font_size
	_time_tick_height
	_timeline_renderers
	_topic_font
	_topic_font_height
	_topic_font_size
	_topic_name_max_percent
	_topic_name_sizes
	_topic_name_spacing
	_topic_vertical_padding
	_topics_by_datatype
	_viewer_types
	_zoom_sensitivity

Detailed Description

TimelineFrame Draws the framing elements for the bag messages
(time delimiters, labels, topic names and backgrounds).
Also handles mouse callbacks since they interact closely with the drawn elements

Definition at line 65 of file timeline_frame.py.

Constructor & Destructor Documentation

def rqt_bag.timeline_frame.TimelineFrame.__init__ ( self )

Definition at line 72 of file timeline_frame.py.

Member Function Documentation

def rqt_bag.timeline_frame.TimelineFrame._draw_bag_ends	(	self,
		painter
	)	`[private]`

Draw markers to indicate the area the bag file represents within the current visible area.
:param painter: allows access to paint functions,''QPainter''

Definition at line 469 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_history_border	(	self,
		painter
	)	`[private]`

Draw a simple black rectangle frame around the timeline view area
:param painter: ,''QPainter''

Definition at line 568 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_major_divisions	(	self,
		painter,
		stamps,
		start_stamp,
		division
	)	`[private]`

Draw black hashed vertical grid-lines showing major time divisions.
:param painter: allows access to paint functions,''QPainter''

Definition at line 623 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_minor_divisions	(	self,
		painter,
		stamps,
		start_stamp,
		division
	)	`[private]`

Draw grey hashed vertical grid-lines showing minor time divisions.
:param painter: allows access to paint functions,''QPainter''

Definition at line 646 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_playhead	(	self,
		painter
	)	`[private]`

Draw a line and 2 triangles to denote the current position being viewed
:param painter: ,''QPainter''

Definition at line 544 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_selected_region	(	self,
		painter
	)	`[private]`

Draws a box around the selected region
:param painter: allows access to paint functions,''QPainter''

Definition at line 505 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_time_divisions	(	self,
		painter
	)	`[private]`

Draw vertical grid-lines showing major and minor time divisions.
:param painter: allows access to paint functions,''QPainter''

Definition at line 596 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_topic_dividers	(	self,
		painter
	)	`[private]`

Draws horizontal lines between each topic to visually separate the messages
:param painter: allows access to paint functions,''QPainter''

Definition at line 481 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_topic_histories	(	self,
		painter
	)	`[private]`

Draw all topic messages
:param painter: allows access to paint functions,''QPainter''

Definition at line 378 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_topic_history	(	self,
		painter,
		topic
	)	`[private]`

Draw boxes corrisponding to message regions on the timeline.
:param painter: allows access to paint functions,''QPainter''
:param topic: the topic for which message boxes should be drawn, ''str''

Definition at line 386 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._draw_topic_names	(	self,
		painter
	)	`[private]`

Calculate positions of existing topic names and draw them on the left, one for each row
:param painter: ,''QPainter''

Definition at line 582 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._find_regions	(	self,
		stamps,
		max_interval
	)	`[private]`

Group timestamps into regions connected by timestamps less than max_interval secs apart
:param start_stamp: a list of stamps, ''list''
:param stamp_step: seconds between each division, ''int''

Definition at line 799 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._get_label	(	self,
		division,
		elapsed
	)	`[private]`

:param division: number of seconds in a division, ''int''
:param elapsed: seconds from the beginning, ''int''
:returns: relevent time elapsed string, ''str''

Definition at line 835 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._get_playhead ( self ) [private]

Definition at line 192 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._get_stamps	(	self,
		start_stamp,
		stamp_step
	)	`[private]`

Generate visible stamps every stamp_step
:param start_stamp: beginning of timeline stamp, ''int''
:param stamp_step: seconds between each division, ''int''

Definition at line 820 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._history_right ( self ) [private]

Definition at line 241 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._layout ( self ) [private]

Recalculates the layout of the of the timeline to take into account any changes that have occured

Definition at line 329 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._qfont_width	(	self,
		name
	)	`[private]`

Definition at line 289 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._set_playhead	(	self,
		playhead
	)	`[private]`

Sets the playhead to the new position, notifies the threads and updates the scene so it will redraw
:signal: emits status_bar_changed_signal if the playhead is successfully set
:param playhead: Time to set the playhead to, ''rospy.Time()''

Definition at line 195 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._trimmed_topic_name	(	self,
		topic_name
	)	`[private]`

This function trims the topic name down to a reasonable percentage of the viewable scene area

Definition at line 292 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame._update_index_cache	(	self,
		topic
	)	`[private]`

Updates the cache of message timestamps for the given topic.
:return: number of messages added to the index cache

Definition at line 762 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.boundingRect ( self )

Definition at line 269 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.can_zoom	(	self,
		desired_zoom
	)

Definition at line 968 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.can_zoom_in ( self )

Definition at line 962 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.can_zoom_out ( self )

Definition at line 965 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.emit_play_region ( self )

Definition at line 255 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.end_stamp ( self )

Definition at line 265 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.get_renderers ( self )

:returns: a list of the currently loaded renderers for the plugins

Definition at line 720 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.get_viewer_types	(	self,
		datatype
	)

Definition at line 672 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.get_zoom_interval	(	self,
		zoom,
		center = `None`
	)

@rtype: tuple
@requires: left & right zoom interval sizes.

Definition at line 994 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.handle_close ( self )

Definition at line 665 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.has_selected_region ( self )

Definition at line 245 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.is_renderer_active	(	self,
		topic
	)

Definition at line 733 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.load_plugins ( self )

Definition at line 675 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.map_dstamp_to_dx	(	self,
		dstamp
	)

Definition at line 907 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.map_dx_to_dstamp	(	self,
		dx
	)

converts a distance in pixel space to a distance in stamp space
:param dx: distance in pixel space to be converted, ''int''
:returns: distance in stamp space, ''float''

Definition at line 883 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.map_stamp_to_x	(	self,
		stamp,
		clamp_to_visible = `True`
	)

converts a timestamp to the x value where that stamp exists in the timeline
:param stamp: timestamp to be converted, ''int''
:param clamp_to_visible: disallow values that are greater than the current timeline bounds,''bool''
:returns: # of pixels from the left boarder, ''int''

Definition at line 891 of file timeline_frame.py.

def rqt_bag.timeline_frame.TimelineFrame.map_x_to_stamp	(	self,
		x,
		clamp_to_visible = `True`
	)

converts a pixel x value to a stamp
:param x: pixel value to be converted, ''int''
:param clamp_to_visible: disallow values that are greater than the current timeline bounds,''bool''
:returns: timestamp, ''int''

Definition at line 866 of file timeline_frame.py.