Merge pull request #33 from mattuntergassmair/v0.8

The two main points remaining are
 1. make the camera interface nicer
 2. provide a better default function for rendering
These will be addressed in a future PR, merging this one for now

.gitignore

@@ -1,4 +1,6 @@
 *.jl.cov
 *.jl.mem
 **/.ipynb_checkpoints
-docs/build/
+docs/build/
+
+test/*.svg

Project.toml

@@ -1,13 +1,12 @@
 name = "AutoViz"
 uuid = "82aa6e0c-a491-5edf-8d4b-c16b98e4ea17"
 repo = "https://github.com/sisl/AutoViz.jl.git"
-version = "0.7.7"
+version = "0.8.0"
 
 [deps]
 AutomotiveDrivingModels = "99497e54-f3d6-53d3-a3a9-fa9315a7f1ba"
 Cairo = "159f3aea-2a34-519c-b102-8c37f9878175"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
-LightXML = "9c8b4983-aa76-5018-a973-4c85ecc9e179"
 Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
@@ -18,6 +17,9 @@ Rsvg = "c4c386cf-5103-5370-be45-f3a111cca3b8"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Vec = "44eeaf0b-fee4-471f-9310-ed6585cb3142"
 
+[compat]
+AutomotiveDrivingModels = ">=0.7.10"
+
 [extras]
 Interact = "c601a237-2ae4-5e1e-952c-7a85b0c7eef1"
 NBInclude = "0db19996-df87-5ea3-a455-e3a50d440464"

README.md

@@ -115,3 +115,40 @@ using AutoViz
 set_color_theme(LIGHTTHEME)
 ```
 You can also define your own color theme using a dictionary. Look at the example in `src/colorscheme.jl` to have the correct key names.
+
+
+## Change Log
+
+### v0.8.x
+
+#### Rendering
+ - Clean-up of the rendering interface: there is now only one single rendering function with the signature
+```
+render!(rendermodel::RenderModel, renderables::AbstractVector; canvas_width::Int, canvas_height::Int, surface::CairoSurface))
+```
+All keyword arguments are optional. Objects of type `Renderable` now no longer have to implement the `render!` function (which is a misleading name). Instead one must implement the `add_renderable!` function which adds the rendering instructions to the `RenderModel`.
+ - Implicit conversions of non-renderable objects (such as `obj::Frame{Entity{S,D,I}}`) via implementations of `Base.convert(Renderable, obj)` are now discouraged. Instead, one can overwrite the `add_renderable!` method for such types. This is done for some very common types.
+ - The new `render!` function now only takes objects which are renderable, i.e. which implement the `add_renderable(rm::RenderModel, obj)` function. There is no longer a distinction between drawing roadways, scenes or overlays. They all need to satisfy the same interface, and they are drawn in the order in which they are passed to the `render!` function. This change decreases the number of available render functions from almost ten to one and should make the control flow more clear.
+ - Additional arguments to `render!` such as `camera` and `car_colors` are no longer supported. Camera effects should be applied before calling `render!` (see section below) and rendering attributes such as colors should be passed in as part of a renderable object.
+
+#### Overlays
+ - Changed the interface for rendering overlays to only take an instance of `RenderModel` and the overlay itself. All additional data must be stored as part of the overlay if it is needed during rendering.
+ - Added a `RenderableOverlay` wrapper which makes the legacy overlays work with the new rendering interface (in which overlays do not get any input arguments for rendering)
+
+#### Cameras
+ - Changed the camera interface. The full state of the camera, such as `camera_pos`, `camera_zoom`, `camera_rotation` is stored in `RenderModel` (this has already been the case in previous AutoViz versions). A `Camera` acts upon a `RenderModel` by changing these internal variables. The function `camera_set!` now becomes `update_camera!`.
+ - Many setter functions for the camera have been replaced by the `set_camera!()` function which takes keyword arguments for `x`, `y` and `zoom`.
+ - The implementations of `TargetFollowCamera` (former `CarFollowCamera`) and `SceneFollowCamera` have been reviewed and simplified. Additionally, a `ZoomingCamera` type which gradually changes the zoom level has been introduced and for easy extensibility there is also a `ComposedCamera` type which takes a list of cameras and applies their effects sequentially to the `RenderModel`.
+ - The new `render!` function no longer takes a camera as an input argument, but assumes that the camera settings have already been applied to the `RenderModel` via `update_camera!` prior to calling `render!`. User code should be adapted accordingly.
+
+#### Visualization of Entities
+ - Controlling the appearance of vehicles by setting `set_render_mode(:basic|:fancy)` is no longer encouraged. Instead, we provide new renderable types such as `EntityRectangle`, `FancyCar`, `FancyPedestrian`, `VelocityArrow` in addition to the already implemented `ArrowCar` type which can all be used to conveniently display entities.
+ - A convenience function for rendering scenes directly (i.e. without explicit conversion to a `Renderable` type) is still supported.
+ - TODO: make FancyCar work on my platform
+
+#### 1D Vehicles
+ - Support for 1D vehicles has mostly been discontinued and some of the related functions were removed. However, the new functions should work seamlessly in many cases as long as the 1D vehicles implement basic functions such as `posg`, `width`, `length` from `AutomotiveDrivingModels.jl`
+
+## TODO: adapt tutorials
+## TODO: adapt unit tests
+## TODO: adapt docs

src/AutoViz.jl

@@ -7,7 +7,6 @@ using Parameters
 using StaticArrays
 using AutomotiveDrivingModels
 using Printf
-using LightXML
 using Rsvg
 
 @reexport using Colors
@@ -16,12 +15,9 @@ using Cairo
 import Reel
 Reel.set_output_type("gif")
 
-export
-        DEFAULT_CANVAS_WIDTH,
-        DEFAULT_CANVAS_HEIGHT
-
 const DEFAULT_CANVAS_WIDTH = 1000
 const DEFAULT_CANVAS_HEIGHT = 600
+export DEFAULT_CANVAS_WIDTH, DEFAULT_CANVAS_HEIGHT
 
 global _rendermode = :fancy
 
@@ -30,6 +26,7 @@ function set_render_mode(m::Symbol)
     _rendermode = m
 end
 
+include("colorscheme.jl")
 export
     COLOR_ASPHALT,
     COLOR_LANE_MARKINGS_WHITE,
@@ -41,29 +38,25 @@ export
     LIGHTTHEME,
     set_color_theme
 
-include("colorscheme.jl")
-
-# Cairo drawing utilities
+include("rendermodels.jl")
 export
         RenderModel,
-
-        render,
+        render_to_canvas,
         add_instruction!,
         camera_fit_to_content!,
         camera_move!,
         camera_move_pix!,
         camera_rotate!,
-        camera_setrotation!,
         camera_zoom!,
-        camera_setzoom!,
-        camera_set_pos!,
-        camera_set_x!,
-        camera_set_y!,
-        camera_reset!,
-        camera_set!,
-        clear_setup!,
-        set_background_color!,
+        reset_camera!,
+        reset_instructions!,
+        reset_model!,
+        set_camera!,
+        set_background_color!
 
+# Cairo drawing utilities
+include("render_instructions.jl")
+export
         render_paint,
         render_text,
         render_circle,
@@ -84,40 +77,40 @@ export
         render_fancy_car,
         render_fancy_pedestrian
 
-include("rendermodels.jl")
 include("fancy_render.jl")
 
 # Cameras
+include("cameras.jl")
 export
     Camera,
+    update_camera!,
     StaticCamera,
-    FitToContentCamera,
-    CarFollowCamera,
-    SceneFollowCamera
-
+    TargetFollowCamera,
+    ZoomingCamera,
+    ComposedCamera,
+    SceneFollowCamera,
+    FitToContentCamera
 
-include("cameras.jl")
-
-# main interface
-export  render!,
-        render,
-        get_pastel_car_colors
-
-include("interface.jl")
 
 # renderable interface
-export  Renderable,
-        render,
-        isrenderable,
-        write_to_svg,
-        ArrowCar
-
-
 include("renderable.jl")
-include("arrowcar.jl")
 include("text.jl")
 
+export
+    Renderable,
+    render,
+    render!,
+    add_renderable!,
+    isrenderable,
+    write_to_svg,
+    ArrowCar,
+    EntityRectangle,
+    VelocityArrow,
+    FancyCar
+
+
 # Overlays
+include("overlays.jl")
 export  SceneOverlay,
         TextOverlay,
         Overwash,
@@ -130,20 +123,19 @@ export  SceneOverlay,
         drawtext,
         LineToCenterlineOverlay,
         LineToFrontOverlay,
-        BlinkerOverlay
-
-
-include("overlays.jl")
+        BlinkerOverlay,
+        RenderableOverlay
 
 export PNGFrames,
        SVGFrames
 
 include("reel_drive.jl")
 
 # Convenient implementation for roadway and vehicle rendering
-
 include("roadways.jl")
-include("vehicles.jl")
 
+# old render methods that should be removed in future versions
+include("deprecated.jl")
+export render, render!
 
 end # module