Api - chain Namespace

Index

Functions

chainFillet

chainFillet(traditional: boolean, chainToFillet: IChain, filletSpec: any): IModel

- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:507
Parameters
- traditional: boolean
- chainToFillet: IChain
- filletSpec: any
Returns IModel

cycle

cycle(chainContext: IChain, amount?: number): IChain

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:466
Shift the links of an endless chain.

Parameters
- chainContext: IChain
  
  Chain to cycle through. Must be endless.
- Default value amount: number = 1
  
  Optional number of links to shift. May be negative to cycle backwards.
Returns IChain

The chainContext for cascading.

dogbone

dogbone(chainToFillet: IChain, filletRadius: number): IModel
dogbone(chainToFillet: IChain, filletRadii: object): IModel

- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:466
Adds a dogbone fillet between each link in a chain. Each path will be cropped to fit a fillet, and all fillets will be returned as paths in a returned model object.

Parameters
- chainToFillet: IChain
  
  The chain to add fillets to.
- filletRadius: number
  
  Radius of the fillet.
Returns IModel

Model object containing paths which fillet the joints in the chain.
- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:477
Adds a dogbone fillet between each link in a chain. Each path will be cropped to fit a fillet, and all fillets will be returned as paths in a returned model object.

Parameters
- chainToFillet: IChain
  
  The chain to add fillets to.
- filletRadii: object
  
  Object specifying directional radii.
  - Optional left?: number
    
    Radius of left turning fillets.
  - Optional right?: number
    
    Radius of right turning fillets.
Returns IModel

Model object containing paths which fillet the joints in the chain.

fillet

fillet(chainToFillet: IChain, filletRadius: number): IModel
fillet(chainToFillet: IChain, filletRadii: object): IModel

- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:490
Adds a fillet between each link in a chain. Each path will be cropped to fit a fillet, and all fillets will be returned as paths in a returned model object.

Parameters
- chainToFillet: IChain
  
  The chain to add fillets to.
- filletRadius: number
  
  Radius of the fillet.
Returns IModel

Model object containing paths which fillet the joints in the chain.
- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:501
Adds a fillet between each link in a chain. Each path will be cropped to fit a fillet, and all fillets will be returned as paths in a returned model object.

Parameters
- chainToFillet: IChain
  
  The chain to add fillets to.
- filletRadii: object
  
  Object specifying directional radii.
  - Optional left?: number
    
    Radius of left turning fillets.
  - Optional right?: number
    
    Radius of right turning fillets.
Returns IModel

Model object containing paths which fillet the joints in the chain.

reverse

reverse(chainContext: IChain): IChain

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:488
Reverse the links of a chain.

Parameters
- chainContext: IChain
  
  Chain to reverse.
Returns IChain

The chainContext for cascading.

startAt

startAt(chainContext: IChain, routeKey: string): IChain

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:501
Set the beginning of an endless chain to a known routeKey of a path.

Parameters
- chainContext: IChain
  
  Chain to cycle through. Must be endless.
- routeKey: string
  
  RouteKey of the desired path to start the chain with.
Returns IChain

The chainContext for cascading.

toKeyPoints

toKeyPoints(chainContext: IChain, maxArcFacet?: number): IPoint[]

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:633
Get key points (a minimal a number of points) along a chain of paths.

Parameters
- chainContext: IChain
  
  Chain of paths to get points from.
- Optional maxArcFacet: number
  
  The maximum length between points on an arc or circle.
Returns IPoint[]

Array of points which are on the chain.

toNewModel

toNewModel(chainContext: IChain, detachFromOldModel?: boolean): IModel

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:524
Convert a chain to a new model, independent of any model from where the chain was found.

Parameters
- chainContext: IChain
  
  Chain to convert to a model.
- Default value detachFromOldModel: boolean = false
  
  Flag to remove the chain's paths from their current parent model. If false, each path will be cloned. If true, the original path will be re-parented into the resulting new model. Default is false.
Returns IModel

A new model containing paths from the chain.

toPoints

toPoints(chainContext: IChain, distanceOrDistances: number | number[], maxPoints?: number): IPoint[]

- Defined in src/maker.js/packages/maker.js/src/core/chain.ts:578
Get points along a chain of paths.

Parameters
- chainContext: IChain
  
  Chain of paths to get points from.
- distanceOrDistances: number | number[]
- Optional maxPoints: number
  
  Maximum number of points to retrieve.
Returns IPoint[]

Array of points which are on the chain spread at a uniform interval.

Generated using TypeDoc

Api - chain Namespace

Index

Functions

Functions

chainFillet

Parameters

traditional: boolean

chainToFillet: IChain

filletSpec: any

Returns IModel

cycle

Parameters

chainContext: IChain

Default value amount: number = 1

Returns IChain

dogbone

Parameters

chainToFillet: IChain

filletRadius: number

Returns IModel

Parameters

chainToFillet: IChain

filletRadii: object

Optional left?: number

Optional right?: number

Returns IModel

fillet

Parameters

chainToFillet: IChain

filletRadius: number

Returns IModel

Parameters

chainToFillet: IChain

filletRadii: object

Optional left?: number

Optional right?: number

Returns IModel

reverse

Parameters

chainContext: IChain

Returns IChain

startAt

Parameters

chainContext: IChain

routeKey: string

Returns IChain

toKeyPoints

Parameters

chainContext: IChain

Optional maxArcFacet: number

Returns IPoint[]

toNewModel

Parameters

chainContext: IChain

Default value detachFromOldModel: boolean = false

Returns IModel

toPoints

Parameters

chainContext: IChain

distanceOrDistances: number | number[]

Optional maxPoints: number

Returns IPoint[]