circular-mirror v1.0.0

circular-mirror

Simulates the reflections of a ray of light inside of a circular mirror.

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

round(num, decimals)

Rounds a number.

Params

• Number num: The input number.
• Number decimals: How many decimals.

Return

• Number The rounded number.

setVariableInterval(callbackFunc, timing)

Sets a variable interval.

Params

• Function callbackFunc: The callback function.
• Number timing: The interval value.

Return

• Object The object containing the variable interval methods.

circle(x, y, r, w, color)

Draws a circle on the canvas.

Params

• Number x: The x value.
• Number y: The y value.
• Number r: The radius value.
• Number w: The line width.
• String color: The color.

Return

line(x1, y1, x2, y2, w, color)

Draws a line on the canvas.

Params

• Number x1: The source x value.
• Number y1: The source y value.
• Number x2: The target x value.
• Number y2: The target y value.
• Number w: The line width.
• String color: The color.

Return

canvasArrow(context, fromx, fromy, tox, toy)

Draws an arrow on the canvas.

Params

• Object context: The canvas context.
• Number fromx: The source x value.
• Number fromy: The source y value.
• Number tox: The target x value.
• Number toy: The target y value.

Return

init()

This function is called to reinit the canvas.

Return

draw()

Starts drawing the things.

Return

handlers()

This function appends the DOM handlers.

Return

getLimit(angle)

This is a hack. This roundes the angle in a format that is supported by the application.

Params

• Number angle: The angle that should be rounded.

Return

• Number A rounded angle that is supported by the application.

badAngle(angle)

Checks if the angle is supported.

Params

• Number angle: The angle that should be checked.

Return

• String An error (string) or null.

showError(message)

Shows an error message.

Params

• String message: The error message.

Return

start(point, callback)

Draws the lines on the canvas.

Params

• Point point: The current point.
• Function callback: The callback function.

Return

M(A:, B:, R:, L:)

THE MOST IMPORTANT FUNCTION. It always returns the next point.

                        ------------

(xM(n - 1), yM(n - 1)) ---> |? ? ?| (xM(n), yM(n)) ---> | M | ---> (xM(n + 1), yM(n + 1)) Radius ---> |? ? ?| Length of segments ---> ------------

Params

• Object A:: first point
• Object B:: second point
• Object R:: radius of big circle
• Object L:: length of segments

firstPoint(m, x1, y1)

The function that returns ONLY the first point.

Params

• Object m:
• Object x1:
• Object y1:

getA()

Function that returns a point giving the angle |------| xA ----> | |===> (xA, yA) angle (deg) ----> | | |------|

check()

Verify if the numbers are correct. If not, return an false value.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:
• —I love books! I will remember you after years if you buy me one. :grin: :book:
• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău