DanielBullimore / OOmutiny

OO Javascript frontend
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

0.1.1 Region #17

Closed DanielBullimore closed 4 years ago

DanielBullimore commented 5 years ago

Priority: Unset

Depends:

0.0 Master (OO)-[OO.class.js] => 0.1 Point (OoPoint)-[OoPoint.class.js] => 0.1.1 Region (OoRegion)-[OoPointRegion.class.js] 0.0 Master[OO]-(OO.class.js) => 0.2 Color[OoColor]-(OoColor.class.js)

Overview:

A defined width by height dimension at x,y,z point

UML

OoPointRegion-02-09-2019

Description:

This class inherits OoPoint and draws from the right of its inherited xyz point. The region defined at that point with a given width and height forms a right angle quadrilateral. Although the region size is defined, a z coordinate greater than or less than zero will result in dimensional scaling.

A Point Region may be rendered on the gui and can have a colored border and or filled with color. These colors are defined with an instance of OoColor implemented as properties of this class. Further more a border is drawn within a regions dimensions.

Properties:

numWith - Protected number, width in pixels of region on x axis.
numHeight - Protected number, height in pixels of region on y axis.
booFilled - Protected boolean, switches between rendering with background filled (true) or unfilled(false)
objFillColor - Protected OoColor, color object for background fill color.
booBorder - Protected Boolean, switches between rending bordered region(true) or unbordered region (false)
objBorderColor - Protected OoColor, color object for border color.
numBorderWidth - Protected  number, width of border in pixels.

Methods:

funSetDimension() - Used to define width and height of a region
funGetWidth() - Returns a number representing a regions defined width in pixels
funGetHeight() - Returns a number representing a regions defined height in pixels
funSetBoarder() - Accepts  OoColor object and number parameters to define the color and widht of a regions border
funUnsetBorder() - Removes a regions boarder definitions.
funSetFill() - Accepts an OoColor object parameter as color to fill region with.
funUnsetFill() - Removes a regions fill definition.
funMove() - Accepts OoPoint object and a number as parameters representing a destination and speed in milliseconds at which to move there.
funTeleport() - Accepts OoPoint as location to redraw region on gui
funRender - Derives a visual representation of OoPointRegion from an instance's properties then draws it on the GUI
DanielBullimore commented 5 years ago

OoPointRegion-03-08-2019

changed method color parameters to accept OoColor objects. added movement speed.

DanielBullimore commented 5 years ago

Lol I added the funRender method. Composed the written descriptions for this class's methods. Also changed funMove to accept OoPoint as parameter.

OoPointRegion-02-09-2019

DanielBullimore commented 5 years ago

that about describes my region object fully. closing.

DanielBullimore commented 4 years ago

sanity checking complete