Difference between revisions of "Render Part B Assignment"
(13 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | '''Fall 2023 ALERT: there is an error in scene.rb''' | ||
+ | |||
+ | '''The require_relative at the top of the file is missing a ../''' | ||
+ | |||
+ | '''Change the require_relative from:''' | ||
+ | |||
+ | <s>require_relative '../../../core/ruby/render/core/render'</s> | ||
+ | |||
+ | '''to:''' | ||
+ | |||
+ | <syntaxhighlight lang="ruby"> | ||
+ | require_relative '../../../../core/ruby/render/core/render' | ||
+ | </syntaxhighlight> | ||
+ | |||
In this assignment we will evolve our code from [[Render_Part_A_Assignment|Render (Part A)]] to leverage class hierarchies. | In this assignment we will evolve our code from [[Render_Part_A_Assignment|Render (Part A)]] to leverage class hierarchies. | ||
Line 5: | Line 19: | ||
Continue editing files in the drawings/core directory. | Continue editing files in the drawings/core directory. | ||
− | In this | + | In this exercise, we will have parameters for which explicitly passed arguments are not required (for convenience and backwards compatibility). We will [https://github.com/rubocop-hq/ruby-style-guide#keyword-arguments-vs-optional-arguments prefer keyword arguments over optional arguments]. |
=Code To Use= | =Code To Use= | ||
Line 13: | Line 27: | ||
: [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#apply_translation-instance_method apply_translation] | : [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#apply_translation-instance_method apply_translation] | ||
: [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#color=-instance_method color=] | : [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#color=-instance_method color=] | ||
+ | : [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#clear-instance_method clear] | ||
=Code to Implement= | =Code to Implement= | ||
==Transform== | ==Transform== | ||
− | {{RubyToImplement|transform|drawings|Transform|Object|initialize(x,y)<br/>x()<br/>x=()<br/>y()<br/>y=()<br/>render()}} | + | {{RubyToImplement|transform|drawings|Transform|Object|initialize(x,y)<br/>x()<br/>x=()<br/>y()<br/>y=()<br/>render(g)}} |
Add accesors for x and y. | Add accesors for x and y. | ||
Line 27: | Line 42: | ||
==Image== | ==Image== | ||
− | {{RubyToEvolve|image|drawings|Image|Transform|initialize(path, x: 0, y: 0)|untransformed_render()|render()}} | + | {{RubyToEvolve|image|drawings|Image|Transform|initialize(path, x: 0, y: 0)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#Image|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#Image|from Part A]] | ||
Line 33: | Line 48: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0 and y: 0 and invoke your superclass with these parameters. | Add keyword parameters for x: 0 and y: 0 and invoke your superclass with these parameters. | ||
Line 39: | Line 56: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==ColorTransform== | ==ColorTransform== | ||
− | {{RubyToImplement|color_transform|drawings|ColorTransform|Transform|initialize(x,y,color)<br/>color()<br/>color=()<br/>render()}} | + | {{RubyToImplement|color_transform|drawings|ColorTransform|Transform|initialize(x,y,color)<br/>color()<br/>color=()<br/>render(g)}} |
Add an accessor for color. | Add an accessor for color. | ||
Line 48: | Line 65: | ||
ColorTransform's constructor should take x, y, and color parameters. x and y should be passed to the superclass and color should be stored in an instance variable. | ColorTransform's constructor should take x, y, and color parameters. x and y should be passed to the superclass and color should be stored in an instance variable. | ||
− | NOTE: Override render. Be sure to [https://www. | + | NOTE: Override render. Be sure to [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#color=-instance_method change the color] (unless it is nil) on the graphics instance before invoking your superclass. |
NOTE: invoke the [https://ruby-doc.org/core-2.5.3/Object.html#method-i-nil-3F nil?] method to check for nil. | NOTE: invoke the [https://ruby-doc.org/core-2.5.3/Object.html#method-i-nil-3F nil?] method to check for nil. | ||
==Text== | ==Text== | ||
− | {{RubyToEvolve|text|drawings|Text|ColorTransform|initialize(text, font, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|text|drawings|Text|ColorTransform|initialize(text, font, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#Text|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#Text|from Part A]] | ||
Line 59: | Line 76: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 65: | Line 84: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==Ellipse== | ==Ellipse== | ||
− | {{RubyToEvolve|ellipse|drawings|Ellipse|ColorTransform|initialize(x_radius, y_radius, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|ellipse|drawings|Ellipse|ColorTransform|initialize(x_radius, y_radius, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#Ellipse|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#Ellipse|from Part A]] | ||
Line 74: | Line 93: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 80: | Line 101: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==EquilateralTriangle== | ==EquilateralTriangle== | ||
− | {{RubyToEvolve|equilateral_triangle|drawings|EquilateralTriangle|ColorTransform|initialize(half_side_length, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|equilateral_triangle|drawings|EquilateralTriangle|ColorTransform|initialize(half_side_length, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#EquilateralTriangle|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#EquilateralTriangle|from Part A]] | ||
Line 89: | Line 110: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 95: | Line 118: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==BezierCurve== | ==BezierCurve== | ||
− | {{RubyToEvolve|bezier_curve|drawings|BezierCurve|ColorTransform|initialize(control_points, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|bezier_curve|drawings|BezierCurve|ColorTransform|initialize(control_points, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#B.C3.A9zier_Curve|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#B.C3.A9zier_Curve|from Part A]] | ||
Line 104: | Line 127: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 110: | Line 135: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==CircularSegment== | ==CircularSegment== | ||
− | {{RubyToEvolve|circular_segment|drawings|CircularSegment|ColorTransform|initialize(x_radius, y_radius, theta_a, theta_z, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|circular_segment|drawings|CircularSegment|ColorTransform|initialize(x_radius, y_radius, theta_a, theta_z, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#CircularSegment|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#CircularSegment|from Part A]] | ||
Line 119: | Line 144: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 125: | Line 152: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==Rectangle== | ==Rectangle== | ||
− | {{RubyToEvolve|rectangle|drawings|Rectangle|ColorTransform|initialize(half_width, half_height, x: 0, y: 0, color: nil)|untransformed_render()|render()}} | + | {{RubyToEvolve|rectangle|drawings|Rectangle|ColorTransform|initialize(half_width, half_height, x: 0, y: 0, color: nil)|untransformed_render(g)|render(g)}} |
You will evolve your code from [[Render_Part_A_Assignment#Rectangle|from Part A]] | You will evolve your code from [[Render_Part_A_Assignment#Rectangle|from Part A]] | ||
Line 134: | Line 161: | ||
be sure to add the following line above your class: | be sure to add the following line above your class: | ||
− | + | <syntaxhighlight lang="ruby"> | |
+ | require_relative 'color_transform' | ||
+ | </syntaxhighlight> | ||
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass. | ||
Line 140: | Line 169: | ||
NOTE: Be sure to not override render. Implement the untransformed_render method instead. | NOTE: Be sure to not override render. Implement the untransformed_render method instead. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
==CompositeTransform== | ==CompositeTransform== | ||
− | {{RubyToImplement|composite_transform|drawings|CompositeTransform|Transform|initialize(x: 0, y: 0)<br/>components<br/>push_component(component)<br/>untransformed_render()}} | + | {{RubyToImplement|composite_transform|drawings|CompositeTransform|Transform|initialize(x: 0, y: 0)<br/>components<br/>push_component(component)<br/>untransformed_render(g)}} |
Instances of CompositeTransform will act like a group of objects. When it moves all of its child components will move with it. When it is drawn, each of its child components will be drawn. | Instances of CompositeTransform will act like a group of objects. When it moves all of its child components will move with it. When it is drawn, each of its child components will be drawn. | ||
Line 153: | Line 182: | ||
The untransformed_render method should render each pushed component. | The untransformed_render method should render each pushed component. | ||
− | NOTE: untransformed_render() must be private. | + | NOTE: untransformed_render(g) must be private. |
NOTE: sometimes when constructing objects we need to initialize instance variables that are not necessarily passed in as arguments. this is one of those times. | NOTE: sometimes when constructing objects we need to initialize instance variables that are not necessarily passed in as arguments. this is one of those times. | ||
==Scene== | ==Scene== | ||
− | {{RubyToImplement|scene|drawings|Scene|Object|initialize(background_color: Color::BLACK)<br/>background_color()<br/>background_color=()<br/>components()<br/>push_component(component)<br/>render()}} | + | '''Fall 2023 ALERT: there is an error in scene.rb''' |
+ | |||
+ | '''The require_relative at the top of the file is missing a ../''' | ||
+ | |||
+ | '''Change the require_relative from:''' | ||
+ | |||
+ | <s>require_relative '../../../core/ruby/render/core/render'</s> | ||
+ | |||
+ | '''to:''' | ||
+ | |||
+ | <syntaxhighlight lang="ruby"> | ||
+ | require_relative '../../../../core/ruby/render/core/render' | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | {{RubyToImplement|scene|drawings|Scene|Object|initialize(background_color: Color::BLACK)<br/>background_color()<br/>background_color=()<br/>components()<br/>push_component(component)<br/>render(g)}} | ||
Add an accessor for background_color and a reader for components. | Add an accessor for background_color and a reader for components. | ||
Line 166: | Line 209: | ||
Add a push_component method which accepts a component which will later be rendered. | Add a push_component method which accepts a component which will later be rendered. | ||
− | The render method should [https://www. | + | The render method should [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse425s/current/doc/Graphics.html#clear-instance_method clear] the color buffer once before proceeding to render each pushed component. |
− | |||
− | |||
− | |||
=Testing Your Solution= | =Testing Your Solution= |
Latest revision as of 04:22, 1 December 2023
Fall 2023 ALERT: there is an error in scene.rb
The require_relative at the top of the file is missing a ../
Change the require_relative from:
require_relative '../../../core/ruby/render/core/render'
to:
require_relative '../../../../core/ruby/render/core/render'
In this assignment we will evolve our code from Render (Part A) to leverage class hierarchies.
Continue editing files in the drawings/core directory.
In this exercise, we will have parameters for which explicitly passed arguments are not required (for convenience and backwards compatibility). We will prefer keyword arguments over optional arguments.
Contents
Code To Use
Code to Implement
Transform
file: | src/main/ruby/drawings/transform.rb | ![]() |
class: | Transform | |
superclass: | Object | |
methods: | initialize(x,y) x() x=() y() y=() render(g) |
Add accesors for x and y.
Transform's constructor should take x and y parameters and store them in instance variables.
It should define a render method which preserves the current affine transformation, translates by x and y, passes the untransformed_render message to itself (a.k.a. invokes a method on itself), and restores the model view transformation.
All subclasses must implement a private untransformed_render method.
Image
file: | src/main/ruby/drawings/image.rb | ![]() |
class: | Image | |
superclass: | Transform | |
methods to evolve: | initialize(path, x: 0, y: 0) | |
methods to add: | untransformed_render(g) | |
methods to remove: | render(g) |
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'transform'
Add keyword parameters for x: 0 and y: 0 and invoke your superclass with these parameters.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
ColorTransform
file: | src/main/ruby/drawings/color_transform.rb | ![]() |
class: | ColorTransform | |
superclass: | Transform | |
methods: | initialize(x,y,color) color() color=() render(g) |
Add an accessor for color.
ColorTransform's constructor should take x, y, and color parameters. x and y should be passed to the superclass and color should be stored in an instance variable.
NOTE: Override render. Be sure to change the color (unless it is nil) on the graphics instance before invoking your superclass.
NOTE: invoke the nil? method to check for nil.
Text
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
Ellipse
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
EquilateralTriangle
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
BezierCurve
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
CircularSegment
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
Rectangle
You will evolve your code from from Part A
be sure to add the following line above your class:
require_relative 'color_transform'
Add keyword parameters for x: 0, y: 0, and color: nil to the constructor and pass them to the superclass.
NOTE: Be sure to not override render. Implement the untransformed_render method instead.
NOTE: untransformed_render(g) must be private.
CompositeTransform
file: | src/main/ruby/drawings/composite_transform.rb | ![]() |
class: | CompositeTransform | |
superclass: | Transform | |
methods: | initialize(x: 0, y: 0) components push_component(component) untransformed_render(g) |
Instances of CompositeTransform will act like a group of objects. When it moves all of its child components will move with it. When it is drawn, each of its child components will be drawn.
Add a reader for components.
Add a push_component method which accepts a component which will later be rendered.
The untransformed_render method should render each pushed component.
NOTE: untransformed_render(g) must be private.
NOTE: sometimes when constructing objects we need to initialize instance variables that are not necessarily passed in as arguments. this is one of those times.
Scene
Fall 2023 ALERT: there is an error in scene.rb
The require_relative at the top of the file is missing a ../
Change the require_relative from:
require_relative '../../../core/ruby/render/core/render'
to:
require_relative '../../../../core/ruby/render/core/render'
Add an accessor for background_color and a reader for components.
Scene's constructor should take a keyword parameter background_color: Color.new(0,0,0) and store it in an instance variable.
Add a push_component method which accepts a component which will later be rendered.
The render method should clear the color buffer once before proceeding to render each pushed component.
Testing Your Solution
Unit Test
file: | src/test/ruby/drawings/core/relatively_fast/part_b/*.rb | ![]() |
note: ensure that you have removed all printing to receive credit for any assignment.
file: | src/test/ruby/drawings/core/relatively_slow/part_b/*.rb | ![]() |
note: ensure that you have removed all printing to receive credit for any assignment.
Backwards Compatibility
file: | src/test/ruby/drawings/core/relatively_fast/part_a/*.rb | ![]() |
note: ensure that you have removed all printing to receive credit for any assignment.
Visual Comparison
file to run: | src/test/ruby/drawings/core/snapshots/part_b_components_snapshots_web_page_generator.rb | ![]() |
file to run: | src/test/ruby/drawings/core/snapshots/part_b_composites_snapshots_web_page_generator.rb | ![]() |