Go to main documentation 🔗
Preparing search index...
The search index is not available
cubing.js — API Reference - v0.53.9-dev
cubing.js — API Reference
puzzle-geometry
PuzzleGeometry
Class PuzzleGeometry
Index
Constructors
constructor
Properties
baseplanerot
cmovesbyslice
cubies
moveplanesets
movesetgeos
movesetorders
notation
Mapper
parsedmovelist
puzzle
Description
shortedge
stickersperface
Methods
allstickers
create
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
Puzzle
Geometry
(
puzzleDescription
,
options
)
:
PuzzleGeometry
Parameters
puzzleDescription
:
ExperimentalPuzzleDescription
options
:
Partial
<
PuzzleGeometryFullOptions
>
Returns
PuzzleGeometry
Properties
baseplanerot
baseplanerot
:
Quat
[]
cmovesbyslice
cmovesbyslice
:
number
[]
[]
[]
= []
cubies
cubies
:
number
[]
[]
moveplanesets
moveplanesets
:
Quat
[]
[]
movesetgeos
movesetgeos
:
MoveSetGeo
[]
movesetorders
movesetorders
:
number
[]
notation
Mapper
notation
Mapper
:
NotationMapper
= ...
parsedmovelist
parsedmovelist
:
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
[]
puzzle
Description
puzzle
Description
:
ExperimentalPuzzleDescription
shortedge
shortedge
:
number
stickersperface
stickersperface
:
number
Methods
allstickers
allstickers
(
)
:
void
Returns
void
create
create
(
puzzleDescription
)
:
void
Parameters
puzzleDescription
:
ExperimentalPuzzleDescription
Returns
void
generatesvg
generatesvg
(
w
?
,
h
?
,
trim
?
,
threed
?
)
:
string
Parameters
w
:
number
= 800
h
:
number
= 500
trim
:
number
= 10
threed
:
boolean
= false
Returns
string
genperms
genperms
(
)
:
void
Returns
void
get3d
get3d
(
options
?
)
:
StickerDat
Parameters
Optional
options
:
{
darkIgnoredOrbits
?:
boolean
;
stickerColors
?:
string
[]
;
}
Optional
dark
Ignored
Orbits
?:
boolean
Optional
sticker
Colors
?:
string
[]
Returns
StickerDat
get
Geo
Normal
get
Geo
Normal
(
geoname
)
:
undefined
|
number
[]
Parameters
geoname
:
string
Returns
undefined
|
number
[]
getKPuzzle
Definition
getKPuzzle
Definition
(
fortwisty
?
,
includemoves
?
)
:
KPuzzleDefinition
Parameters
fortwisty
:
boolean
= true
includemoves
:
boolean
= true
Returns
KPuzzleDefinition
get
Move
From
Bits
get
Move
From
Bits
(
moverange
,
amount
,
inverted
,
axiscmoves
,
setmoves
,
movesetorder
)
:
PGTransform
Parameters
moverange
:
number
[]
amount
:
number
inverted
:
boolean
axiscmoves
:
number
[]
[]
setmoves
:
undefined
|
number
[]
movesetorder
:
number
Returns
PGTransform
get
Moves
As
Perms
get
Moves
As
Perms
(
)
:
Perm
[]
Returns
Perm
[]
get
Orbits
Def
get
Orbits
Def
(
fortwisty
,
includemoves
?
)
:
PGOrbitsDef
Parameters
fortwisty
:
boolean
includemoves
:
boolean
= true
Returns
PGOrbitsDef
get
Scramble
get
Scramble
(
n
?
)
:
KTransformationData
Parameters
n
:
number
= 0
Returns
KTransformationData
getsolved
getsolved
(
)
:
Perm
Returns
Perm
parse
Move
parse
Move
(
move
)
:
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
Parameters
move
:
Move
Returns
[
undefined
|
string
,
number
,
number
,
number
,
boolean
,
number
]
showcanon
showcanon
(
disp
)
:
void
Parameters
disp
:
(
(
s
:
string
)
=>
void
)
(
s
)
:
void
Parameters
s
:
string
Returns
void
Returns
void
text
For
Twizzle
Explorer
text
For
Twizzle
Explorer
(
)
:
string
Returns
string
unswizzle
unswizzle
(
mv
)
:
null
|
Move
Parameters
mv
:
Move
Returns
null
|
Move
writegap
writegap
(
)
:
string
Returns
string
writeksolve
writeksolve
(
name
?
)
:
string
Parameters
name
:
string
= "PuzzleGeometryPuzzle"
Returns
string
writemathematica
writemathematica
(
)
:
string
Returns
string
write
Schreier
Sims
write
Schreier
Sims
(
tw
)
:
void
Parameters
tw
:
(
(
s
:
string
)
=>
void
)
(
s
)
:
void
Parameters
s
:
string
Returns
void
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
baseplanerot
cmovesbyslice
cubies
moveplanesets
movesetgeos
movesetorders
notation
Mapper
parsedmovelist
puzzle
Description
shortedge
stickersperface
Methods
allstickers
create
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.53.9-dev
Loading...