Builds "foil" shapes such as trefoils, quatrefoils, cinquefoils, etc. Input 2D profiles must be centred at (0, 0, 0)
- Source:
Methods
cinquefoil(opts, geomProfile)
Builds a cinquefoil opening using a given 2d cross-section profile
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
radius |
number
|
radius of container circle |
lobeRadiusType |
string
|
"inSlice", "halfRadius", "mean" |
cutCentre |
boolean
|
if true, cuts a circular hole in centre of opening (only for 3D) |
|
geomProfile |
geom2.Geom2
|
2D cross-section profile |
- Source:
octofoil(opts, geomProfile)
Builds an octofoil opening using a given 2d cross-section profile
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
radius |
number
|
radius of container circle |
lobeRadiusType |
string
|
"inSlice", "halfRadius", "mean" |
cutCentre |
boolean
|
if true, cuts a circular hole in centre of opening (only for 3D) |
|
geomProfile |
geom2.Geom2
|
2D cross-section profile |
- Source:
quatrefoil(opts, geomProfile)
Builds a quatrefoil opening using a given 2d cross-section profile
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
radius |
number
|
radius of container circle |
lobeRadiusType |
string
|
"inSlice", "halfRadius", "mean" |
cutCentre |
boolean
|
if true, cuts a circular hole in centre of opening (only for 3D) |
|
geomProfile |
geom2.Geom2
|
2D cross-section profile |
- Source:
sexfoil(opts, geomProfile)
Builds a sexfoil opening using a given 2d cross-section profile
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
radius |
number
|
radius of container circle |
lobeRadiusType |
string
|
"inSlice", "halfRadius", "mean" |
cutCentre |
boolean
|
if true, cuts a circular hole in centre of opening (only for 3D) |
|
geomProfile |
geom2.Geom2
|
2D cross-section profile |
- Source:
trefoil(opts, geomProfile)
Builds a trefoil opening using a given 2d cross-section profile
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
radius |
number
|
radius of container circle |
lobeRadiusType |
string
|
"inSlice", "halfRadius", "mean" |
cutCentre |
boolean
|
if true, cuts a circular hole in centre of opening (only for 3D) |
|
geomProfile |
geom2.Geom2
|
2D cross-section profile |
- Source: