3DCoat Python API
The 3DCoat Python API documentation.
|
Public Member Functions | |
symm | enable (_enable=bool) |
Enable the symmetry. | |
bool | enabled () |
Enable the symmetry. | |
symm | disable () |
disable the symmetry | |
symm | xyz (x=bool, y=bool, z=bool) |
Enable the XYZ-mirror symmetry. | |
bool | is_xyz () |
check if the XYZ symmetry enabled | |
bool | x () |
check x symmetry state | |
bool | y () |
check y symmetry state | |
bool | z () |
check z symmetry state | |
symm | axial (n=int, extraMirror=bool, stepSymmetry=bool) |
Enable the axial symmetry. | |
bool | is_axial () |
Check if the axial symmetry enabled | |
int | axialOrder () |
returns the axial symmetry order if axial or axial mirror symmetry enabled | |
bool | extraMirror () |
returns the state of extra mirror, this is valid only tor the axial symmetry | |
bool | stepSymmetry () |
returns the state of step symmetry | |
symm | axialMirror (n=int, extraMirror=bool, stepSymmetry=bool) |
Enable the axial mirror symmetry. | |
bool | isAxialMirror () |
Check if the axial mirror symmetry enabled. | |
symm | translation (numX=int, stepX=float, numY=int, stepY=float, numZ=int, stepZ=float) |
Enable the translation symmetry. | |
bool | is_translation () |
Check if the translation symmetry enabled. | |
int | numX () |
returns the reference to the number of the x repeats if the translational symmetry used | |
float | stepX () |
returns the reference to the x-step if the translational symmetry used | |
int | numY () |
returns the reference to the number of the y repeats if the translational symmetry used | |
float | stepY () |
returns the reference to the y-step if the translational symmetry used | |
int | numZ () |
returns the reference to the number of the z repeats if the translational symmetry used | |
float | stepZ () |
returns the reference to the z-step if the translational symmetry used | |
symm | toGlobalSpace () |
set the symmetry to be in global space | |
symm | toLocalSpace () |
set the symmetry to be in local space | |
symm | toGeneral () |
set the symmetry to general case | |
symm | set_start (pos=vec3) |
set the central point for the symmetry | |
vec3 | start () |
get the start point reference | |
symm | set_end (pos=vec3) |
set the end point for the symmetry axis, calling this function enables the general case of the symmetry | |
vec3 | end () |
the end point reference | |
symm | showSymmetryPlane (show=bool) |
Show or hide the symmetry planes. | |
symm | setCustomSymetryTransforms (symmetryTransforms=Any) |
enable the custom symmetry, provide the symmetry transfoms | |
bool | isCustomSymmetry () |
Check if the custom symmetry used. | |
list | getCurrentTransforms () |
Returns all transforms using the current symmetry state. | |
list | getCurrentPlanes () |
Returns all symmetry planes using the current symmetry state. | |
symm coat.symm.axial | ( | n = int , |
|
extraMirror = bool , |
|||
stepSymmetry = bool |
|||
) |
Enable the axial symmetry.
n | the order of the axial symmetry |
extraMirror | add the extra mirror orthogonal to the axis |
stepSymmetry | enable the step symmetry |
symm coat.symm.axialMirror | ( | n = int , |
|
extraMirror = bool , |
|||
stepSymmetry = bool |
|||
) |
Enable the axial mirror symmetry.
n | the order of the symmetry |
extraMirror | dd the extra mirror orthogonal to the axis |
stepSymmetry | enable the step symmetry |
int coat.symm.axialOrder | ( | ) |
returns the axial symmetry order if axial or axial mirror symmetry enabled
symm coat.symm.disable | ( | ) |
disable the symmetry
symm coat.symm.enable | ( | _enable = bool | ) |
Enable the symmetry.
_enable | true to enable, false to disable |
bool coat.symm.enabled | ( | ) |
Enable the symmetry.
_enable | true to enable, false to disable |
vec3 coat.symm.end | ( | ) |
the end point reference
bool coat.symm.extraMirror | ( | ) |
returns the state of extra mirror, this is valid only tor the axial symmetry
list coat.symm.getCurrentPlanes | ( | ) |
Returns all symmetry planes using the current symmetry state.
list coat.symm.getCurrentTransforms | ( | ) |
Returns all transforms using the current symmetry state.
bool coat.symm.is_axial | ( | ) |
Check if the axial symmetry enabled
bool coat.symm.is_translation | ( | ) |
Check if the translation symmetry enabled.
bool coat.symm.is_xyz | ( | ) |
check if the XYZ symmetry enabled
bool coat.symm.isAxialMirror | ( | ) |
Check if the axial mirror symmetry enabled.
bool coat.symm.isCustomSymmetry | ( | ) |
Check if the custom symmetry used.
int coat.symm.numX | ( | ) |
returns the reference to the number of the x repeats if the translational symmetry used
int coat.symm.numY | ( | ) |
returns the reference to the number of the y repeats if the translational symmetry used
int coat.symm.numZ | ( | ) |
returns the reference to the number of the z repeats if the translational symmetry used
set the end point for the symmetry axis, calling this function enables the general case of the symmetry
pos | the position |
set the central point for the symmetry
pos | the position (in local or global space, see the localSpace() or globalSpace()) |
symm coat.symm.setCustomSymetryTransforms | ( | symmetryTransforms = Any | ) |
enable the custom symmetry, provide the symmetry transfoms
symmetryTransforms | the list of additional transforms (list of coat.mat4) that will be applied to the any user action |
symm coat.symm.showSymmetryPlane | ( | show = bool | ) |
Show or hide the symmetry planes.
show | set true to show |
vec3 coat.symm.start | ( | ) |
get the start point reference
bool coat.symm.stepSymmetry | ( | ) |
returns the state of step symmetry
float coat.symm.stepX | ( | ) |
returns the reference to the x-step if the translational symmetry used
float coat.symm.stepY | ( | ) |
returns the reference to the y-step if the translational symmetry used
float coat.symm.stepZ | ( | ) |
returns the reference to the z-step if the translational symmetry used
symm coat.symm.toGeneral | ( | ) |
set the symmetry to general case
symm coat.symm.toGlobalSpace | ( | ) |
set the symmetry to be in global space
symm coat.symm.toLocalSpace | ( | ) |
set the symmetry to be in local space
symm coat.symm.translation | ( | numX = int , |
|
stepX = float , |
|||
numY = int , |
|||
stepY = float , |
|||
numZ = int , |
|||
stepZ = float |
|||
) |
Enable the translation symmetry.
numX | number of x-repeats |
stepX | the step of the x-repeat |
numY | number of y-repeats |
stepY | the step of the y-repeat |
numZ | number of z-repeats |
stepZ | the step of the z-repeat |
bool coat.symm.x | ( | ) |
check x symmetry state
symm coat.symm.xyz | ( | x = bool , |
|
y = bool , |
|||
z = bool |
|||
) |
Enable the XYZ-mirror symmetry.
x | true to enable x-symmetry, false to disable |
y | true to enable y-symmetry, false to disable |
z | true to enable z-symmetry, false to disable |
bool coat.symm.y | ( | ) |
check y symmetry state
bool coat.symm.z | ( | ) |
check z symmetry state