SymmetrySettings

Summary

A collection of settings for the symmetry mode

Instance Properties

Name	Return Type	Description
matrices	MatrixList Read-only	The list of transform matrices for this symmetry mode
mode	SymmetryMode Read/Write	The symmetry mode
transform	Transform Read/Write	The transform of the symmetry widget
position	Vector3 Read/Write	The position of the symmetry widget
rotation	Rotation Read/Write	The rotation of the symmetry widget
spin	Vector3 Read/Write	How fast the symmetry widget is spinning in each axis
pointType	SymmetryPointType Read/Write	The type of point symmetry
pointOrder	number Read/Write	The order of point symmetry (how many times it repeats around it's axis)
wallpaperType	SymmetryWallpaperType Read/Write	The type of wallpaper symmetry
wallpaperRepeatX	number Read/Write	How many times the wallpaper symmetry repeats in the X axis
wallpaperRepeatY	number Read/Write	How many times the wallpaper symmetry repeats in the Y axis
wallpaperScale	number Read/Write	The overall scale of the wallpaper symmetry
wallpaperScaleX	number Read/Write	The scale of the wallpaper symmetry in the X axis
wallpaperScaleY	number Read/Write	The scale of the wallpaper symmetry in the Y axis
wallpaperSkewX	number Read/Write	The skew of the wallpaper symmetry in the X axis
wallpaperSkewY	number Read/Write	The skew of the wallpaper symmetry in the Y axis

Class Methods

SymmetrySettings:NewPointSymmetry(type, order)

Creates a new set of symmetry settings based on point symmetry

Returns: SymmetrySettings

Parameters:

Name	Type	Default	Description
type	SymmetryPointType		The type of point symmetry
order	number		The number of repeats around the axis

Example

mySymSettings = Symmetry:NewPoint()

SymmetrySettings:NewWallpaperSymmetry(type, repeatX, repeatY, scale, scaleX, scaleY, skewX, skewY)

Creates a new set of symmetry settings based on wallpaper symmetry

Returns: SymmetrySettings

Parameters:

Name	Type	Default	Description
type	SymmetryWallpaperType		The type of point symmetry
repeatX	number
repeatY	number
scale	number	1
scaleX	number	1
scaleY	number	1
skewX	number	0
skewY	number	0

Example

mySymSettings = Symmetry:NewPoint()

Instance Methods

symmetrySettings:Duplicate()

Creates a copy of these symmetry settings

Returns: SymmetrySettings

Example

newSettings = Symmetry.current:Duplicate()