Packages

c

reftree.render

Renderer

case class Renderer(renderingOptions: RenderingOptions = RenderingOptions(), animationOptions: AnimationOptions = AnimationOptions(), directory: Path = Paths.get("."), format: String = "png") extends Product with Serializable

This class provides functionality for rendering diagrams and animations

It can be used in two ways:

  • conventionally, via the render methods;
  • with special syntax sugar, allowing render calls on the diagrams/animations themselves.

Usage examples:

import reftree.diagram.Diagram
import java.nio.file.Paths

val renderer = Renderer(
  renderingOptions = RenderingOptions(density = 75),
  directory = Paths.get("images", "usage")
)

// With custom output format
val renderer = Renderer(
  renderingOptions = RenderingOptions(density = 75),
  directory = Paths.get("images", "usage"),
  format = "ps" // Or any other format that compatible with dot -T
)

// Conventional usage
renderer
  .tweakRendering(_.withVerticalSpacing(2))
  .render("list", Diagram(List(1)))

// Sweet sugar, recommended
import renderer._
Diagram(List(1))
  .render("list", _.withVerticalSpacing(2))
Self Type
Renderer
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Renderer
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Renderer(renderingOptions: RenderingOptions = RenderingOptions(), animationOptions: AnimationOptions = AnimationOptions(), directory: Path = Paths.get("."), format: String = "png")

Type Members

  1. implicit class AnimationRenderSyntax extends AnyRef

    Syntactic sugar for animations

  2. implicit class DiagramRenderSyntax extends AnyRef

    Syntactic sugar for diagrams

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val animationOptions: AnimationOptions
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. val directory: Path
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val format: String
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def render(name: String, animation: Animation): Unit

    Render an animation to a GIF file with the given name (do not include the extension)

  17. def render(name: String, diagram: Diagram): Unit

    Render a diagram to a file with the given name (do not include the extension)

  18. val renderingOptions: RenderingOptions
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def tweakAnimation(tweak: (AnimationOptions) ⇒ AnimationOptions): Renderer

    Tweak the animation options with the provided funciton

  21. def tweakRendering(tweak: (RenderingOptions) ⇒ RenderingOptions): Renderer

    Tweak the rendering options with the provided funciton

  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped