Neatly Positioned Magazines

    bedard-cube

    1.0.0 • Public • Published

    cube

    Build Coverage Dependencies NPM License

    This class models the state of Rubik's cubes. To get started, install the library through Yarn or NPM.

    yarn add bedard-cube
     
    # or 
     
    npm install bedard-cube

    API

    To instantiate a cube, use the Cube constructor and define the size of the cube. The size parameter must be an integer greater than 1.

    // create a new 3x3 cube
    const cube = new Cube(3);

    To perform one or more turns to the cube, use the turn method. To manually convert a turn string to an object, use the parseTurn method.

    // accepts a whitespace or comma seperated list of turns
    cube.turn('F R- L');

    The cube can be scrambled via the scramble function. This function optionally accepts a number of turns to perform. If omitted, the scramble depth will be determined by the size of the cube. Additionally, a scramble may be generated using the generateScramble function. The only difference between these two functions is that generateScramble does not perform the turns.

    cube.scramble();

    To test if the cube is solved, use the isSolved method. This function returns true or false.

    cube.isSolved();

    The cube can be returned to it's original state via the reset method.

    cube.reset();

    To itterate over all of the cube's stickers, use the stickers method.

    cube.stickers(function(sticker) {
        // ...
    });

    State

    To read the current state of the cube, access the state property. This property holds an object with properties for each face, each containing an array of sticker values. The face arrays start from the top left sticker and read sequentially to the bottom right. So for example, a newly instantiated 3x3 cube would have the following state.

    {
        U: [
            0, 0, 0,
            0, 0, 0,
            0, 0, 0,
        ],
        L: [
            1, 1, 1,
            1, 1, 1,
            1, 1, 1,
        },
        F: [
            2, 2, 2,
            2, 2, 2,
            2, 2, 2,
        ],
        R: [
            3, 3, 3,
            3, 3, 3,
            3, 3, 3,
        ],
        B: [
            4, 4, 4,
            4, 4, 4,
            4, 4, 4,
        ],
        D: [
            5, 5, 5,
            5, 5, 5,
            5, 5, 5,
        ],
    }

    To picture how these values would map to an actual cube, imagine unfolding a cube while looking at the F face. Notice that the B face has the same orientation as the L, F, and R faces.

      U
    L F R B
      D
    

    To store additional data with the stickers, toggle the useObjects option. Setting this flag will store the sticker values as { originalIndex, value } objects. Note that the originalIndex key does not change as the cube is turned.

    new Cube(size, { useObjects: true });

    Notation

    The notation system used by this library is a superset of WCA notation. Any algorithm produced by a WCA scrambler should be compatible with this library. There are however a couple of extensions we've made to the WCA syntax. The first of which being optional use of a - to indicate counter-clockwise turns. The second is the ability to annotate "slice turns" with a single move. To do this, simply omit the wide segment of a turn. For example, a 3F in our notation system would be equal to 3Fw 2Fw- in WCA notation.

    License

    MIT

    Copyright (c) 2018-present, Scott Bedard

    Keywords

    Install

    npm i bedard-cube

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    95.7 kB

    Total Files

    8

    Last publish

    Collaborators

    • scottbedard