Namespace: primitives-2D

Source: primitives-2d/index.js, line 1

Methods

Circle(parameters) → {Face}

Creates a circle based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the circle.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the circle is constructed.
`center`	Vector	<optional>	Vector.ZERO	The center of the circle.
`radius`	number			The radius of the circle.

Source: primitives-2d/circle.js, line 15

Returns:

A Face object representing the constructed circle.

Type:: Face

Ellipse(parameters) → {Face}

Creates a ellipse based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the ellipse.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the ellipse is constructed.
`center`	Vector	<optional>	Vector.ZERO	The center of the ellipse.
`xRadius`	number			The radius of the ellipse along the X-axis.
`yRadius`	number			The radius of the ellipse along the Y-axis.

Source: primitives-2d/ellipse.js, line 16

Returns:

A Face object representing the constructed ellipse.

Type:: Face

Polygon(parameters) → {Face}

Creates a polygon based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the polygon.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the polygon is constructed.
`vertices`	Array.<Vector>			An array of vertices defining the polygon.

Source: primitives-2d/polygon.js, line 14

Returns:

A Face object representing the constructed polygon.

Type:: Face

Rectangle(parameters) → {Face}

Creates a rectangle based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the rectangle.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the rectangle is constructed.
`center`	Vector	<optional>	Vector.ZERO	The center of the rectangle.
`width`	number			The width of the rectangle.
`height`	number			The height of the rectangle.

Source: primitives-2d/rectangle.js, line 15

Returns:

A Face object representing the constructed rectangle.

Type:: Face

RegularPolygon(parameters) → {Face}

Creates a regular polygon based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the regular polygon.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the polygon is constructed.
`center`	Vector	<optional>	Vector.ZERO	The center of the polygon.
`radius`	number			The radius of the circumscribed circle of the polygon.
`vertices`	number			The number of vertices of the polygon.

Source: primitives-2d/regular-polygon.js, line 15

Returns:

A Face object representing the constructed regular polygon.

Type:: Face

Square(parameters) → {Face}

Creates a square based on the specified parameters.

Parameters:

Name Type Description

parameters

Object

The parameters for the square.

Properties

Name	Type	Attributes	Default	Description
`plane`	Plane	<optional>	Plane.XY	The plane in which the square is constructed.
`center`	Vector	<optional>	Vector.ZERO	The center of the square.
`size`	number			The length of the square's sides.

Source: primitives-2d/square.js, line 14

Returns:

A Face object representing the constructed square.

Type:: Face