JImage Implementation for J-Objects

src/Javis.jl

@@ -1,7 +1,7 @@
 module Javis
 
 using Animations
-import Cairo: CairoImageSurface, image
+import Cairo: CairoImageSurface, CairoSurfaceBase, image
 using FFMPEG
 using Gtk
 using GtkReactive
@@ -726,6 +726,7 @@ include("shorthands/JEllipse.jl")
 include("shorthands/JStar.jl")
 include("shorthands/JPoly.jl")
 include("shorthands/JShape.jl")
+include("shorthands/JImage.jl")
 
 export render, latex
 export Video, Object, Background, Action, RFrames, GFrames
@@ -740,7 +741,7 @@ export act!
 export anim_translate, anim_rotate, anim_rotate_around, anim_scale
 
 export @Frames, prev_start, prev_end, startof, endof
-export JBox, JCircle, JEllipse, JLine, JPoly, JRect, JStar, @JShape
+export JBox, JCircle, JEllipse, JImage, JLine, JPoly, JRect, JStar, @JShape
 
 # custom override of luxor extensions
 export setline, setopacity, fontsize, get_fontsize, scale, text

src/shorthands/JBox.jl

@@ -117,3 +117,73 @@ JBox(
         color = color,
         action = action,
     ) -> _JBox(pt, width, height, cornerradius, color, action)
+
+"""
+TODO: Add documentation
+"""
+JBox(
+    pt::Point,
+    width::Real,
+    height::Real,
+    color = "",
+    action = :stroke,
+    vertices::Bool = false,
+    image_path::String = "",
+    scale_factor::Symbol = :inset,
+) =
+    (
+        args...;
+        pt = pt,
+        width = width,
+        height = height,
+        color = color,
+        action = action,
+        vertices = vertices,
+        image_path = image_path,
+        scale_factor = scale_factor,
+    ) -> _JBox(pt, width, height, color, action, vertices, image_path, scale_factor)
+
+function _JBox(
+    pt::Point,
+    width::Real,
+    height::Real,
+    color,
+    action::Symbol,
+    vertices::Bool,
+    image_path::String,
+    scale_factor::Symbol,
+)
+    bbox = BoundingBox(box(pt, width, height, :path, vertices = vertices))
+
+    if !isnothing(color)
+        sethue(color)
+        box(pt, width, height, :fill, vertices = vertices)
+    end
+
+    img = readpng(image_path)
+
+    if scale_factor == :inset
+        boxside = max(boxwidth(bbox), boxheight(bbox))
+        imageside = max(img.width, img.height)
+
+        scaling = boxside / imageside
+
+        box(bbox, :clip)
+
+        translate(boxmiddlecenter(bbox))
+        scale(scaling)
+    elseif scale_factor == :clip
+        boxside = min(boxwidth(bbox), boxheight(bbox))
+        imageside = min(img.width, img.height)
+
+        box(bbox, :clip)
+
+        scaling = boxside / imageside
+
+        translate(boxmiddlecenter(bbox))
+        scale(scaling)
+    end
+
+    placeimage(img, pt, centered = true)
+    return Point(pt.x - width / 2, pt.y + height / 2)
+end

src/shorthands/JCircle.jl

@@ -39,3 +39,58 @@ JCircle(p1::Point, p2::Point; kwargs...) =
     JCircle(midpoint(p1, p2), distance(p1, p2) / 2; kwargs...)
 
 JCircle(radius::Real; kwargs...) = JCircle(O, radius; kwargs...)
+
+"""
+TODO: Add Documentation!
+"""
+JCircle(
+    center::Point,
+    radius::Real,
+    color = "black",
+    linewidth = 1,
+    action = :stroke,
+    image_path = "",
+    scale_factor = :inset,
+) =
+    (
+        args...;
+        center = center,
+        radius = radius,
+        color = color,
+        linewidth = linewidth,
+        action = action,
+        image_path = image_path,
+        scale_factor = scale_factor,
+    ) -> _JCircle(center, radius, color, linewidth, action, image_path, scale_factor)
+
+function _JCircle(center, radius, color, linewidth, action, image_path, scale_factor)
+
+    bbox = BoundingBox(circle(center, radius, :path))
+
+    if !isnothing(color)
+        sethue(color)
+	circle(center, radius, :fill)
+    end
+
+    img = readpng(image_path)
+
+    if scale_factor == :inset
+        side = sqrt((radius * 2)^2 / 2)
+        bbox = BoundingBox(box(O, side, side, action = :path))
+        boxside = max(boxwidth(bbox), boxheight(bbox))
+        imageside = max(img.width, img.height)
+        box(O, side, side, action = :clip)
+    elseif scale_factor == :clip
+        bbox = BoundingBox(circle(O, radius, action = :path))
+        boxside = min(boxwidth(bbox), boxheight(bbox))
+        imageside = min(img.width, img.height)
+        circle(O, radius, action = :clip)
+    end
+
+    scalefactor = boxside / imageside
+
+    translate(boxmiddlecenter(bbox))
+    scale(scalefactor)
+    placeimage(img, centered = true)
+    return center
+end

src/shorthands/JEllipse.jl

@@ -95,3 +95,70 @@ JEllipse(
         linewidth = linewidth,
         action = action,
     ) -> _JEllipse(focus1, focus2, pt, color, linewidth, action, stepvalue, reversepath)
+
+
+"""
+TODO: Add documentation
+"""
+JEllipse(
+    cpt::Point,
+    w::Real,
+    h::Real,
+    color = "black",
+    linewidth = 1,
+    action = :stroke,
+    image_path::String = "",
+    scale_factor::Symbol = :inset,
+) =
+    (
+        args...;
+        cpt = cpt,
+        w = w,
+        h = h,
+        color = color,
+        linewidth = linewidth,
+        action = action,
+        image_path = image_path,
+        scale_factor = scale_factor,
+    ) -> _JEllipse(cpt, w, h, color, linewidth, action, image_path, scale_factor)
+
+function _JEllipse(
+    cpt::Point,
+    w::Real,
+    h::Real,
+    color,
+    linewidth,
+    action::Symbol,
+    image_path::String = "",
+    scale_factor = :inset,
+)
+
+    bbox = BoundingBox(ellipse(O, w, h, :path))
+
+    if !isnothing(color)
+        sethue(color)
+	ellipse(O, w, h, :fill)
+    end
+
+    img = readpng(image_path)
+
+    if scale_factor == :inset
+	inset_radius = minimum([w, h]) / 2
+	bbox = BoundingBox(circle(O, inset_radius, :path))
+        boxside = max(boxwidth(bbox), boxheight(bbox))
+        imageside = max(img.width, img.height)
+        circle(O, inset_radius, :clip)
+    elseif scale_factor == :clip
+        boxside = min(boxwidth(bbox), boxheight(bbox))
+        imageside = min(img.width, img.height)
+        ellipse(O, 200, 100, :clip)
+    end
+
+    scalefactor = boxside / imageside
+
+    translate(boxmiddlecenter(bbox))
+    scale(scalefactor)
+    placeimage(img, centered = true)
+    return cpt
+end
+

src/shorthands/JImage.jl

@@ -0,0 +1,137 @@
+# TODO: Add scaling logic for each shape; see https://github.com/JuliaAnimators/Javis.jl/pull/399#issuecomment-1003549900 for details on what to do
+
+function _JImage(pos, img, centering, shapeargs, shape, scaleargs)
+    if !isnothing(shape)
+        bbox = BoundingBox(shape(shapeargs...))
+    end
+
+    if scaleargs == :inset
+        if Symbol(shape) == :box
+            boxside = max(boxwidth(bbox), boxheight(bbox))
+            imageside = max(img.width, img.height)
+
+            scalefactor = boxside / imageside
+
+            box(bbox, :clip)
+
+            translate(boxmiddlecenter(bbox))
+            scale(scalefactor)
+        elseif Symbol(shape) == :star
+            bbox = BoundingBox(circle(shapeargs.center, shapeargs.radius * shapeargs.ratio))
+            boxside = max(boxwidth(bbox), boxheight(bbox))
+            imageside = max(img.width, img.height)
+            circle(shapeargs.center, shapeargs.radius * shapeargs.ratio, action = :clip)
+
+            scalefactor = boxside / imageside
+
+            translate(boxmiddlecenter(bbox))
+            scale(scalefactor)
+        end
+    elseif scaleargs == :clip
+        if Symbol(shape) == :box
+            boxside = min(boxwidth(bbox), boxheight(bbox))
+            imageside = min(img.width, img.height)
+
+            box(bbox, :clip)
+
+            scalefactor = boxside / imageside
+
+            translate(boxmiddlecenter(bbox))
+            scale(scalefactor)
+        elseif Symbol(shape) == :star
+            boxside = min(boxwidth(bbox), boxheight(bbox))
+            imageside = min(img.width, img.height)
+
+            star(
+                shapeargs.center,
+                shapeargs.radius,
+                shapeargs.npoints,
+                shapeargs.ratio,
+                shapeargs.orientation,
+                action = :clip,
+            )
+
+            scalefactor = boxside / imageside
+
+            translate(boxmiddlecenter(bbox))
+            scale(scalefactor)
+        end
+    else
+        scale(scaleargs)
+    end
+
+    placeimage(img, pos, centered = centering)
+    return pos
+end
+
+"""
+    JImage(pos::Point, img::CairoSurfaceBase{UInt32}, centering = true; shapeargs = (), shape = nothing, scaleargs = 1)
+
+Place a given image at a given location as a `Javis` object.
+Images can be cropped to different shapes and scaled to different sizes while being placed.
+
+# Arguments
+- `pos::Point`: Where to place the image inside a shape.
+- `img::CairoSurfaceBase{UInt32}`: Expects a CairoSurfaceBase object via `readpng("your_image.png")`
+- `centering::Bool`: Centers the object at `pos`
+- `shapeargs`: Arguments to be passed to a given shape type
+- `shape`: A Luxor shape function such as `circle`, `box`, etc.
+- `scaleargs`: The arguments used for scaling the image used on the shape
+
+# Return
+
+Returns the position of the image location, `pos`.
+"""
+JImage(
+    pos::Point,
+    img::CairoSurfaceBase{UInt32},
+    centering::Bool = true;
+    shapeargs = (),
+    shape = nothing,
+    scaleargs = :inset,
+) =
+    (
+        args...;
+        pos = pos,
+        img = img,
+        centering = centering,
+        shapeargs = shapeargs,
+        shape = shape,
+        scaleargs = scaleargs,
+    ) -> _JImage(pos, img, centering, shapeargs, shape, scaleargs)
+
+"""
+    JImage(pos::Point, img::String, centering = true; shapeargs = (), shape = nothing, scaleargs = 1)
+
+Place a given image at a given location as a `Javis` object.
+Images can be cropped to different shapes and scaled to different sizes while being placed.
+
+# Arguments
+- `pos::Point`: Where to place the image inside a shape
+- `img::String`: Expects the path to an image
+- `centering::Bool`: Centers the object at `pos`
+- `shapeargs`: Arguments to be passed to a given shape type
+- `shape`: A Luxor shape function such as `circle`, `box`, etc.
+- `scaleargs`: The arguments used for scaling the image used on the shape
+
+# Return
+
+Returns the position of the image location, `pos`.
+"""
+JImage(
+    pos::Point,
+    img::String,
+    centering::Bool = true;
+    shapeargs = (),
+    shape = nothing,
+    scaleargs = :inset,
+) =
+    (
+        args...;
+        pos = pos,
+        img = readpng(img),
+        centering = centering,
+        shapeargs = shapeargs,
+        shape = shape,
+        scaleargs = scaleargs,
+    ) -> _JImage(pos, img, centering, shapeargs, shape, scaleargs)