Copyright © 2021 by K4.org
  (v.0.48.124)

A Pattern is a visual copy of an object. It has none of the rules of the source object, but it uses the same geometry, and can be transformed independently.

Index

Rules

count

count: Number

The number of copies to create.

Flags : Cached, Parameter (Note this is uncached)

Expression : 1

frames

frames: Array

The list of frames which place the copies. If does not contain count Frames, the last Frame is replicated.

Flags : Cached, Parameter (Note this is uncached)

Expression : this.source.localTransform.generatePattern(this.pattern, this.count, this.spacing, this.includeSource)

includeSource

includeSource: Boolean

If true then the first item will be included in the pattern as a copy of the source. Default is false.

Flags : Cached, Parameter (Note this is uncached)

Expression : false

pattern

pattern: String

One of 'Linear', 'Circular', 'Rectangular', 'Cubic', 'Cylindrical' or 'Supplied'

Flags : Cached, Parameter (Note this is uncached)

Expression : "Linear"

source

source: Model

The object to copy. The source is treated as the first item in all of the patterns, but is not included in count.

Flags : Cached, Parameter, Required (Note this is uncached)

Expression : ``

spacing

spacing: Any

An object containing properties to control the spacing and layout of the frames. Each pattern expects different properties in this object.

Linear patterns will use the first non-zero value of x, y, or z, in those directions, from the source object.

Rectangular patterns will use the first two of x, y, or z in those directions.

Cubic patterns will use all x, y, and z. Use xCount, yCount, zCount to specify the number of copies if you want to override count in each directions.

Circular patterns will use x and y as center and angle. Cylindrical will additionally use z and zCount. Circular and Cylindrical both accept 'noRotate' to prevent copies from rotation.

Supplied patterns do not access the spacing property.

Flags : Cached, Parameter (Note this is uncached)

Expression : {}