timeline_renderer.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Willow Garage, Inc.
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 from python_qt_binding.QtCore import QObject
00034 
00035 
00036 class TimelineRenderer(QObject):
00037     """
00038     A custom renderer for interval of time of a topic on the timeline.
00039 
00040     @param msg_combine_px: don't draw discrete messages if they're less than this many pixels separated [default: 1.5]
00041     @type  msg_combine_px: float
00042     """
00043     def __init__(self, timeline, msg_combine_px=1.5):
00044         self.timeline = timeline
00045         self.msg_combine_px = msg_combine_px
00046 
00047     def get_segment_height(self, topic):
00048         """
00049         Get the height of the topic segment on the timeline.
00050 
00051         @param topic: topic name to draw
00052         @type  topic: str
00053         @return: height in pixels of the topic segment. If none, the timeline default is used.
00054         @rtype:  int or None
00055         """
00056         return None
00057 
00058     def draw_timeline_segment(self, painter, topic, stamp_start, stamp_end, x, y, width, height):
00059         """
00060         Draw the timeline segment.
00061 
00062         @param painter: QPainter context to render into
00063         @param topic: topic name
00064         @param stamp_start: start of the interval on the timeline
00065         @param stamp_end: start of the interval on the timeline
00066         @param x: x coordinate of the timeline interval
00067         @param y: y coordinate of the timeline interval
00068         @param width: width in pixels of the timeline interval
00069         @param height: height in pixels of the timeline interval
00070         @return: whether the interval was renderered
00071         @rtype:  bool
00072         """
00073         return False
00074 
00075     def close(self):
00076         """
00077         Close the renderer, releasing any resources.
00078         """
00079         pass


rqt_bag
Author(s): Aaron Blasdel
autogenerated on Fri Jan 3 2014 11:55:06