coat.symm Class Reference

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.

Member Function Documentation

axial()

symm coat.symm.axial	(		n = int,
			extraMirror = bool,
			stepSymmetry = bool
	)

Enable the axial symmetry.

Parameters

n	the order of the axial symmetry
extraMirror	add the extra mirror orthogonal to the axis
stepSymmetry	enable the step symmetry

Returns

reference

axialMirror()

symm coat.symm.axialMirror	(		n = int,
			extraMirror = bool,
			stepSymmetry = bool
	)

Enable the axial mirror symmetry.

Parameters

n	the order of the symmetry
extraMirror	dd the extra mirror orthogonal to the axis
stepSymmetry	enable the step symmetry

Returns

the reference

axialOrder()

int coat.symm.axialOrder

(

)

returns the axial symmetry order if axial or axial mirror symmetry enabled

Returns

the reference to the order of the axial symmetry

disable()

symm coat.symm.disable

(

)

disable the symmetry

Returns

reference

enable()

symm coat.symm.enable

(

_enable = bool

)

Enable the symmetry.

Parameters

_enable

true to enable, false to disable

Returns

reference for the chain-like operations

enabled()

bool coat.symm.enabled

(

)

Enable the symmetry.

Parameters

_enable

true to enable, false to disable

Returns

reference for the chain-like operations

end()

vec3 coat.symm.end

(

)

the end point reference

Returns

the point reference

extraMirror()

bool coat.symm.extraMirror

(

)

returns the state of extra mirror, this is valid only tor the axial symmetry

Returns

the reference to the extra mirror state

getCurrentPlanes()

list coat.symm.getCurrentPlanes

(

)

Returns all symmetry planes using the current symmetry state.

Returns

the resulting list of planes (coat.plane)

getCurrentTransforms()

list coat.symm.getCurrentTransforms

(

)

Returns all transforms using the current symmetry state.

Returns

the resulting list of coat.mat4

is_axial()

bool coat.symm.is_axial

(

)

Check if the axial symmetry enabled

Returns

true if the axial symmetry enabled

is_translation()

bool coat.symm.is_translation

(

)

Check if the translation symmetry enabled.

Returns

the state

is_xyz()

bool coat.symm.is_xyz

(

)

check if the XYZ symmetry enabled

Returns

true if this type of the symmetry active

isAxialMirror()

bool coat.symm.isAxialMirror

(

)

Check if the axial mirror symmetry enabled.

Returns

true if the axial mirror symmetry enabled

isCustomSymmetry()

bool coat.symm.isCustomSymmetry

(

)

Check if the custom symmetry used.

Returns

true if the custom symmetry enabled

numX()

int coat.symm.numX

(

)

returns the reference to the number of the x repeats if the translational symmetry used

Returns

the bool reference

numY()

int coat.symm.numY

(

)

returns the reference to the number of the y repeats if the translational symmetry used

Returns

the bool reference

numZ()

int coat.symm.numZ

(

)

returns the reference to the number of the z repeats if the translational symmetry used

Returns

the bool reference

set_end()

symm coat.symm.set_end

(

pos = vec3

)

set the end point for the symmetry axis, calling this function enables the general case of the symmetry

Parameters

pos	the position

Returns

the reference

set_start()

symm coat.symm.set_start

(

pos = vec3

)

set the central point for the symmetry

Parameters

pos	the position (in local or global space, see the localSpace() or globalSpace())

Returns

the reference

setCustomSymetryTransforms()

symm coat.symm.setCustomSymetryTransforms

(

symmetryTransforms = Any

)

enable the custom symmetry, provide the symmetry transfoms

Parameters

symmetryTransforms

the list of additional transforms (list of coat.mat4) that will be applied to the any user action

Returns

the reference

showSymmetryPlane()

symm coat.symm.showSymmetryPlane

(

show = bool

)

Show or hide the symmetry planes.

Parameters

show	set true to show

Returns

the reference

start()

vec3 coat.symm.start

(

)

get the start point reference

Returns

the point reference

stepSymmetry()

bool coat.symm.stepSymmetry

(

)

returns the state of step symmetry

Returns

the reference to the step symmetry state

stepX()

float coat.symm.stepX

(

)

returns the reference to the x-step if the translational symmetry used

Returns

the value reference

stepY()

float coat.symm.stepY

(

)

returns the reference to the y-step if the translational symmetry used

Returns

the value reference

stepZ()

float coat.symm.stepZ

(

)

returns the reference to the z-step if the translational symmetry used

Returns

the value reference

toGeneral()

symm coat.symm.toGeneral

(

)

set the symmetry to general case

Returns

the reference

toGlobalSpace()

symm coat.symm.toGlobalSpace

(

)

set the symmetry to be in global space

Returns

the reference

toLocalSpace()

symm coat.symm.toLocalSpace

(

)

set the symmetry to be in local space

Returns

the reference

translation()

symm coat.symm.translation	(		numX = int,
			stepX = float,
			numY = int,
			stepY = float,
			numZ = int,
			stepZ = float
	)

Enable the translation symmetry.

Parameters

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

Returns

the reference

x()

bool coat.symm.x

(

)

check x symmetry state

Returns

reference to the x symmetry state

xyz()

symm coat.symm.xyz	(		x = bool,
			y = bool,
			z = bool
	)

Enable the XYZ-mirror symmetry.

Parameters

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

Returns

reference

y()

bool coat.symm.y

(

)

check y symmetry state

Returns

reference to the y symmetry state

z()

bool coat.symm.z

(

)

check z symmetry state

Returns

reference to the z symmetry state

---

The documentation for this class was generated from the following file:

• coat.py