Swim Constraint Library

The Swim Constraint library implements an incremental solver for systems of linear constraint equations.

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyConstraintExpression

AnyConstraintExpression: ConstraintExpression | number

AnyConstraintStrength

AnyConstraintStrength: ConstraintStrength | ConstraintStrengthInit

ConstraintAnimatorDescriptor

ConstraintAnimatorDescriptor<O, T, U, I>: ThisType<ConstraintAnimator<O, T, U> & I> & ConstraintAnimatorInit<T, U> & Partial<I>

Type parameters

O = unknown
T = unknown
U = T
I = {}

ConstraintPropertyDescriptor

ConstraintPropertyDescriptor<O, T, U, I>: ThisType<ConstraintProperty<O, T, U> & I> & ConstraintPropertyInit<T, U> & Partial<I>

Type parameters

O = unknown
T = unknown
U = T
I = {}

ConstraintRelation

ConstraintRelation: "le" | "eq" | "ge"

ConstraintStrength

ConstraintStrength: number

ConstraintStrengthInit

ConstraintStrengthInit: "required" | "strong" | "medium" | "weak"

Variables

ConstraintAnimator

ConstraintAnimator: ConstraintAnimatorFactory<ConstraintAnimator<any, any, any>>

ConstraintExpression

ConstraintExpression: { zero: ConstraintConstant; constant: any; fromAny: any; product: any; sum: any }

Type declaration

Readonly zero: ConstraintConstant
constant: function
- constant(value: number): ConstraintConstant
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintExpression.d.ts:21
  Parameters
  - value: number
  Returns ConstraintConstant
fromAny: function
- fromAny(value: AnyConstraintExpression): ConstraintExpression
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintExpression.d.ts:18
  Parameters
  - value: AnyConstraintExpression
  Returns ConstraintExpression
product: function
- product(coefficient: number, variable: ConstraintVariable): ConstraintProduct
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintExpression.d.ts:20
  Parameters
  - coefficient: number
  - variable: ConstraintVariable
  Returns ConstraintProduct
sum: function
- sum(...expressions: AnyConstraintExpression[]): ConstraintSum
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintExpression.d.ts:19
  Parameters
  - Rest ...expressions: AnyConstraintExpression[]
  Returns ConstraintSum

ConstraintId

ConstraintId: { next: any }

Type declaration

next: function
- next(): number
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintId.d.ts:5
  Returns number

ConstraintProperty

ConstraintProperty: ConstraintPropertyFactory<ConstraintProperty<any, any, any>>

ConstraintScope

ConstraintScope: { is: any }

Type declaration

is: function
- is(object: unknown): object is ConstraintScope
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintScope.d.ts:19
  Parameters
  - object: unknown
  Returns object is ConstraintScope

ConstraintStrength

ConstraintStrength: { Medium: number; Required: number; Strong: number; Unbound: number; Weak: number; clip: any; fromAny: any }

Type declaration

Readonly Medium: number
Readonly Required: number
Readonly Strong: number
Readonly Unbound: number
Readonly Weak: number
clip: function
- clip(strength: number): number
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintStrength.d.ts:10
  Parameters
  - strength: number
  Returns number
fromAny: function
- fromAny(strength: AnyConstraintStrength): number
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintStrength.d.ts:11
  Parameters
  - strength: AnyConstraintStrength
  Returns number

ConstraintSymbol

ConstraintSymbol: { invalid: ConstraintInvalid }

Type declaration

Readonly invalid: ConstraintInvalid

ConstraintTerm

ConstraintTerm: { is: any }

Type declaration

is: function
- is(value: unknown): value is ConstraintTerm
- - Defined in swim-runtime-js/swim-core-js/@swim/constraint/lib/main/ConstraintTerm.d.ts:9
  Parameters
  - value: unknown
  Returns value is ConstraintTerm

Swim Constraint Library

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyConstraintExpression

AnyConstraintStrength

ConstraintAnimatorDescriptor

Type parameters

O = unknown

T = unknown

U = T

I = {}

ConstraintPropertyDescriptor

Type parameters

O = unknown

T = unknown

U = T

I = {}

ConstraintRelation

ConstraintStrength

ConstraintStrengthInit

Variables

ConstraintAnimator

ConstraintExpression

Type declaration

Readonly zero: ConstraintConstant

constant: function

Parameters

value: number

Returns ConstraintConstant

fromAny: function

Parameters

value: AnyConstraintExpression

Returns ConstraintExpression

product: function

Parameters

coefficient: number

variable: ConstraintVariable

Returns ConstraintProduct

sum: function

Parameters

Rest ...expressions: AnyConstraintExpression[]

Returns ConstraintSum

ConstraintId

Type declaration

next: function

Returns number

ConstraintProperty

ConstraintScope

Type declaration

is: function

Parameters

object: unknown

Returns object is ConstraintScope

ConstraintStrength

Type declaration

Readonly Medium: number

Readonly Required: number

Readonly Strong: number

Readonly Unbound: number

Readonly Weak: number

clip: function

Parameters

strength: number

Returns number

fromAny: function

Parameters

strength: AnyConstraintStrength

Returns number

ConstraintSymbol

Type declaration

Readonly invalid: ConstraintInvalid

ConstraintTerm

Type declaration

is: function

Parameters

value: unknown