# Two.Polygon

Extends: Two.Path

Source

# Constructor

Argument Description
x The x position of the polygon.
y The y position of the polygon.
radius The radius value of the polygon.
sides The number of vertices used to construct the polygon.

# Properties

A list of properties that are on every Two.Polygon.

polygon.js:117

# fromObject

Returns: Two.Polygon

Argument Description
obj Object notation of a Two.Polygon to create a new instance

Create a new Two.Polygon from an object notation of a Two.Polygon.

polygon.js:123

nota-bene

Works in conjunction with Two.Polygon.toObject

# radius

The radius value of the polygon.

polygon.js:78

nota-bene

This property is tied to Two.Polygon.width and Two.Polygon.height. When you set radius, it affects width and height. Likewise, if you set width or height it will change the radius.

# width

The size of the width of the polygon.

polygon.js:87

nota-bene

This property is tied to Two.Polygon.radius. When you set radius, it affects the width. Likewise, if you set width it will change the radius.

# height

The size of the height of the polygon.

polygon.js:93

nota-bene

This property is tied to Two.Polygon.radius. When you set radius, it affects the height. Likewise, if you set height it will change the radius.

# sides

The amount of sides the polyogn has.

polygon.js:99

# copy

Argument Description
polygon The reference Two.Polygon

Copy the properties of one Two.Polygon onto another.

polygon.js:141

# clone

Returns: Two.Polygon

Argument Description
parent The parent group or scene to add the clone to.

Create a new instance of Two.Polygon with the same properties of the current path.

polygon.js:217

# toObject

Returns: Object

Return a JSON compatible plain object that represents the path.

polygon.js:251

← Two.Star →