JSDoc: Class: Shape

Constructor

new Shape(parent)

Parameters:

Name	Type	Default	Description
`parent`	Shape \| Graphable \| Coords	null

Source:

Shape.js, line 11

Extends

Graphable

Classes

Shape

Members

dv :number

Nominal step-count for parametric curves and surfaces.

Type:

number

Overrides:

Graphable#dv

Source:

Coords.js, line 26

Methods

color(color) → {this}

Parameters:

Name	Type	Description
`color`	string

Overrides:

Graphable#color

Source:

Graphable.js, line 90

Returns:

Type: this

curve(f, u) → {Array.<Geometry>}

Draw a parametric curve.

Parameters:

Name	Type	Description
`f`	function	parametric function
`u`	Array.<number>	parametric coordinate range

Source:

Shape.js, line 45

Returns:

Type: Array.<Geometry>

dupe() → {this}

Get a new duplicate transformed Coords object.

Overrides:

Graphable#dupe

Source:

Coords.js, line 150

Returns:

Type: this

grey(valueopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`value`	number	<optional>	0	grey value (0-100)

Overrides:

Graphable#grey

Source:

Graphable.js, line 98

Returns:

Type: this

hue(hueopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`hue`	number	<optional>	0	hue as degrees on a color wheel (0-360)

Overrides:

Graphable#hue

Source:

Graphable.js, line 108

Returns:

Type: this

lightness(lightnessopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`lightness`	number	<optional>	0	lightness percentage

Overrides:

Graphable#lightness

Source:

Graphable.js, line 126

Returns:

Type: this

opacity(opacity) → {this}

Parameters:

Name	Type	Description
`opacity`	number

Overrides:

Graphable#opacity

Source:

Graphable.js, line 82

Returns:

Type: this

orient(v) → {Array.<number>}

Apply current un-translated coordinate transform to vector v.

Parameters:

Name	Type	Description
`v`	Array.<number>

Overrides:

Graphable#orient

Source:

Coords.js, line 170

Returns:

Type: Array.<number>

quaternion(q) → {this}

Rotate by a quaternion

Parameters:

Name	Type	Description
`q`	Array.<number>	a quaternion

Overrides:

Graphable#quaternion

Source:

Coords.js, line 124

Returns:

Type: this

resetTransform() → {this}

Overrides:

Graphable#resetTransform

Source:

Coords.js, line 141

Returns:

Type: this

rotate(angleopt, axisopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`angle`	number	<optional>	0
`axis`	number \| Array.<number>	<optional>	0	either an axis index (0, 1, 2) or an axis vector

Overrides:

Graphable#rotate

Source:

Coords.js, line 81

Returns:

Type: this

rotateTo(srcAxis, dstAxis)

Rotate so that srcAxis goes into dstAxis.

Parameters:

Name	Type	Description
`srcAxis`	Array.<number>
`dstAxis`	Array.<number>

Overrides:

Graphable#rotateTo

Source:

Coords.js, line 107

saturation(saturationopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`saturation`	number	<optional>	0	saturation percentage

Overrides:

Graphable#saturation

Source:

Graphable.js, line 117

Returns:

Type: this

scale(sopt) → {this}

Parameters:

Name	Type	Attributes	Default	Description
`s`	number	<optional>	1

Overrides:

Graphable#scale

Source:

Coords.js, line 54

Returns:

Type: this

setOptions(options) → {this}

Parameters:

Name	Type	Description
`options`	geometryOptions

Overrides:

Graphable#setOptions

Source:

Graphable.js, line 59

Returns:

Type: this

setSubOptions(options) → {this}

Should only be given settings for object-valued options.

Parameters:

Name	Type	Description
`options`	geometrySubOptions

Overrides:

Graphable#setSubOptions

Source:

Graphable.js, line 69

Returns:

Type: this

stretch(xopt, yopt, zopt) → {this}

Parameters:

Name	Type	Attributes	Default
`x`	number	<optional>	1
`y`	number	<optional>	1
`z`	number	<optional>	1

Overrides:

Graphable#stretch

Source:

Coords.js, line 68

Returns:

Type: this

style(style) → {this}

Set the drawing style of the surface() method. Allows for easy dynamic switching between solid and wireframe views.

Parameters:

Name	Type	Description
`style`	string	either 'surface' or 'wireframe'.

Source:

Shape.js, line 32

Returns:

Type: this

surface(f, u, v) → {Array.<Geometry>}

Draw a parametric surface (or a wireframe representation, if our style has been set to "wireframe").

Parameters:

Name	Type	Description
`f`	function	parametric function
`u`	Array.<number>	first parametric coordinate range
`v`	Array.<number>	second parametric coordinate range

Source:

Shape.js, line 67

Returns:

Type: Array.<Geometry>

transform(v) → {Array.<number>}

Apply current coordinate transform to vector v.

Parameters:

Name	Type	Description
`v`	Array.<number>

Overrides:

Graphable#transform

Source:

Coords.js, line 159

Returns:

Type: Array.<number>

translate(xopt, yopt, zopt) → {this}

Parameters:

Name	Type	Attributes
`x`	number	<optional>
`y`	number	<optional>
`z`	number	<optional>

Overrides:

Graphable#translate

Source:

Coords.js, line 42

Returns:

Type: this

wireframe(f, u, v) → {Array.<Geometry>}

Draw a wireframe of a parametric surface.

Parameters:

Name	Type	Description
`f`	function	parametric function
`u`	Array.<number>	first parametric coordinate range
`v`	Array.<number>	second parametric coordinate range

Source:

Shape.js, line 56

Returns:

Type: Array.<Geometry>