timeline_renderer.py
Go to the documentation of this file.
1 # Software License Agreement (BSD License)
2 #
3 # Copyright (c) 2012, Willow Garage, Inc.
4 # All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # * Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # * Redistributions in binary form must reproduce the above
13 # copyright notice, this list of conditions and the following
14 # disclaimer in the documentation and/or other materials provided
15 # with the distribution.
16 # * Neither the name of Willow Garage, Inc. nor the names of its
17 # contributors may be used to endorse or promote products derived
18 # from this software without specific prior written permission.
19 #
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 # POSSIBILITY OF SUCH DAMAGE.
32 
33 from python_qt_binding.QtCore import QObject
34 
35 
36 class TimelineRenderer(QObject):
37 
38  """
39  A custom renderer for interval of time of a topic on the timeline.
40 
41  @param msg_combine_px: don't draw discrete messages if they're less than this many pixels separated [default: 1.5]
42  @type msg_combine_px: float
43  """
44 
45  def __init__(self, timeline, msg_combine_px=1.5):
46  super(TimelineRenderer, self).__init__()
47  self.timeline = timeline
48  self.msg_combine_px = msg_combine_px
49 
50  def get_segment_height(self, topic):
51  """
52  Get the height of the topic segment on the timeline.
53 
54  @param topic: topic name to draw
55  @type topic: str
56  @return: height in pixels of the topic segment. If none, the timeline default is used.
57  @rtype: int or None
58  """
59  return None
60 
61  def draw_timeline_segment(self, painter, topic, stamp_start, stamp_end, x, y, width, height):
62  """
63  Draw the timeline segment.
64 
65  @param painter: QPainter context to render into
66  @param topic: topic name
67  @param stamp_start: start of the interval on the timeline
68  @param stamp_end: start of the interval on the timeline
69  @param x: x coordinate of the timeline interval
70  @param y: y coordinate of the timeline interval
71  @param width: width in pixels of the timeline interval
72  @param height: height in pixels of the timeline interval
73  @return: whether the interval was renderered
74  @rtype: bool
75  """
76  return False
77 
78  def close(self):
79  """
80  Close the renderer, releasing any resources.
81  """
82  pass
def __init__(self, timeline, msg_combine_px=1.5)
def draw_timeline_segment(self, painter, topic, stamp_start, stamp_end, x, y, width, height)


rqt_bag
Author(s): Dirk Thomas , Aaron Blasdel , Austin Hendrix , Tim Field
autogenerated on Fri Mar 3 2023 03:45:54