cubing.js — API Reference - v0.56.1-dev
Go to main documentation 🔗
Preparing search index...
puzzle-geometry
PuzzleGeometry
Class PuzzleGeometry
Index
Constructors
constructor
Properties
base
Plane
Rotations
cmoves
By
Slice
cubies
move
Plane
Sets?
movesetgeos?
movesetorders?
notation
Mapper
parsed
Move
List?
puzzle
Description
shortest
Edge
stickers
Per
Face
Methods
allstickers
generatesvg
genperms
get3d
get
Geo
Normal
getKPuzzle
Definition
get
Move
From
Bits
get
Moves
As
Perms
get
Orbits
Def
get
Scramble
getsolved
parse
Move
showcanon
text
For
Twizzle
Explorer
unswizzle
writegap
writeksolve
writemathematica
write
Schreier
Sims
Constructors
constructor
new
PuzzleGeometry
(
puzzleDescription
:
ExperimentalPuzzleDescription
,
options
:
Partial
,
)
:
PuzzleGeometry
Parameters
puzzleDescription
:
ExperimentalPuzzleDescription
options
:
Partial
Returns
PuzzleGeometry
Properties
base
Plane
Rotations
basePlaneRotations
:
Quat
[]
cmoves
By
Slice
cmovesBySlice
:
number
[]
[]
[]
= []
cubies
cubies
:
number
[]
[]
Optional
move
Plane
Sets
movePlaneSets
?:
Quat
[]
[]
Optional
movesetgeos
movesetgeos
?:
MoveSetGeo
[]
Optional
movesetorders
movesetorders
?:
number
[]
notation
Mapper
notationMapper
:
NotationMapper
= ...
Optional
parsed
Move
List
parsedMoveList
?:
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
[]
puzzle
Description
puzzleDescription
:
ExperimentalPuzzleDescription
shortest
Edge
shortestEdge
:
number
stickers
Per
Face
stickersPerFace
:
number
Methods
allstickers
allstickers
()
:
void
Returns
void
generatesvg
generatesvg
(
w
?:
number
,
h
?:
number
,
trim
?:
number
,
threed
?:
boolean
)
:
string
Parameters
w
:
number
= 800
h
:
number
= 500
trim
:
number
= 10
threed
:
boolean
= false
Returns
string
genperms
genperms
()
:
void
Returns
void
get3d
get3d
(
options
?:
{
darkIgnoredOrbits
?:
boolean
;
stickerColors
?:
string
[]
}
,
)
:
StickerDat
Parameters
Optional
options
:
{
darkIgnoredOrbits
?:
boolean
;
stickerColors
?:
string
[]
}
Returns
StickerDat
get
Geo
Normal
getGeoNormal
(
geoname
:
string
)
:
undefined
|
number
[]
Parameters
geoname
:
string
Returns
undefined
|
number
[]
getKPuzzle
Definition
getKPuzzleDefinition
(
fortwisty
?:
boolean
,
includemoves
?:
boolean
,
)
:
KPuzzleDefinition
Parameters
fortwisty
:
boolean
= true
includemoves
:
boolean
= true
Returns
KPuzzleDefinition
get
Move
From
Bits
getMoveFromBits
(
moverange
:
number
[]
,
amount
:
number
,
inverted
:
boolean
,
axiscmoves
:
number
[]
[]
,
setmoves
:
undefined
|
number
[]
,
movesetorder
:
number
,
)
:
PGTransform
Parameters
moverange
:
number
[]
amount
:
number
inverted
:
boolean
axiscmoves
:
number
[]
[]
setmoves
:
undefined
|
number
[]
movesetorder
:
number
Returns
PGTransform
get
Moves
As
Perms
getMovesAsPerms
()
:
Perm
[]
Returns
Perm
[]
get
Orbits
Def
getOrbitsDef
(
fortwisty
:
boolean
,
includemoves
?:
boolean
)
:
PGOrbitsDef
Parameters
fortwisty
:
boolean
includemoves
:
boolean
= true
Returns
PGOrbitsDef
get
Scramble
getScramble
(
n
?:
number
)
:
KTransformationData
Parameters
n
:
number
= 0
Returns
KTransformationData
getsolved
getsolved
()
:
Perm
Returns
Perm
parse
Move
parseMove
(
move
:
Move
,
)
:
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
Parameters
move
:
Move
Returns
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
showcanon
showcanon
(
disp
:
(
s
:
string
)
=>
void
)
:
void
Parameters
disp
:
(
s
:
string
)
=>
void
Returns
void
text
For
Twizzle
Explorer
textForTwizzleExplorer
()
:
string
Returns
string
unswizzle
unswizzle
(
mv
:
Move
)
:
null
|
Move
Parameters
mv
:
Move
Returns
null
|
Move
writegap
writegap
()
:
string
Returns
string
writeksolve
writeksolve
(
name
?:
string
)
:
string
Parameters
name
:
string
= "PuzzleGeometryPuzzle"
Returns
string
writemathematica
writemathematica
()
:
string
Returns
string
write
Schreier
Sims
writeSchreierSims
(
tw
:
(
s
:
string
)
=>
void
)
:
void
Parameters
tw
:
(
s
:
string
)
=>
void
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
Plane
Rotations
cmoves
By
Slice
cubies
move
Plane
Sets
movesetgeos
movesetorders
notation
Mapper
parsed
Move
List
puzzle
Description
shortest
Edge
stickers
Per
Face
Methods
allstickers
generatesvg
genperms
get3d
get
Geo
Normal
getKPuzzle
Definition
get
Move
From
Bits
get
Moves
As
Perms
get
Orbits
Def
get
Scramble
getsolved
parse
Move
showcanon
text
For
Twizzle
Explorer
unswizzle
writegap
writeksolve
writemathematica
write
Schreier
Sims
Go to main documentation 🔗
cubing.js — API Reference - v0.56.1-dev
Loading...