RubikHelper API RubikCube

Overview | Details | Examples

Overview

RubikHelper.cube.RubikCube

Prototype Base Class with useful methods to display a Rubik Cube and perform face/slice rotations.

Constructor | Params | Options | Properties | Methods

Constructor

function RubikCube(ID, options)

Params

name	type	notes
ID	String	main container's ID attribute
options	Object	custom option object

Options

name	type	default	notes
pieceSize	Number	30
showAxis	Boolean	false

Properties

name	type	notes
$el	jQuery
_options	Object
_currentCube	Object

Methods

name	returns	notes
axisRotation(move)	String
didRender()	void	does nothing here: needs to be overridden
execute(sequence, duration)	void
getCube()	Object
getPiece(piece)	String	calls getStickersFromPiece on RubikUtils.service.
orientedPiece(target, move)	String
render(pieces)	void	does nothing here: needs to be overridden
rotatedPieces(move)	Object
setCube(cube)	void
setPiece(piece, stickers)	void
updateColors(colors)	void
willRender()	void	does nothing here: needs to be overridden

Details

Params | Options | Properties | Methods

Params detailed

ID

type String

Main container's ID attribute

options

type Object

Custom option object

Options detailed

_options.pieceSize

type Number
default 30

_options.showAxis

type Boolean
default false

Properties detailed

$el

type jQuery

_options

type Object

_currentCube

type Object

Methods detailed

axisRotation

function axisRotation(move)

Returns the axis rotation corresponding to the given move.

• params
  • {String} move
• returns
  • {String}

didRender

function didRender()

Callback after render() calls.

• returns
  • void

execute

function execute(sequence, duration)

• params
  • {Array} sequence
  • {Number} duration
• returns
  • void

getCube

function getCube()

• returns
  • {Object}

getPiece

function getPiece(piece)

Calls RubikUtils.service.getStickersFromPiece to retrieve current stickers on given piece and returns them as string.

• params
  • {String} piece
• returns
  • {String}

orientedPiece

function orientedPiece(target, move)

• params
  • {String} target
  • {String} move
• returns
  • {String}

render

function render(pieces)

• params
  • {Array} pieces
• returns
  • void

rotatedPieces

function rotatedPieces(move)

• params
  • {String} move
• returns
  • {Object}

setCube

function setCube(cube)

• params
  • {Object} cube
• returns
  • void

setPiece

function setPiece(piece, stickers)

• params
  • {String} piece
  • {String} stickers
• returns
  • void

updateColors

function updateColors(colors)

• params
  • {Object} colors
• returns
  • void

willRender

function willRender()

Callback before render() calls.

• returns
  • void