33 lines
1.2 KiB
TypeScript
33 lines
1.2 KiB
TypeScript
|
import { DOFSets } from 'animation-utilities';
|
||
|
|
/**
|
||
|
|
* A representation of a set of Degrees of Freedom (DOFs).
|
||
|
|
* @class DOFSet
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Creates a new DOFSet containing all the DOFs of this
|
||
|
|
* DOFSet, plus all the DOFs of the set passed in. Duplicates
|
||
|
|
* are included only once (union of the sets).
|
||
|
|
* @method DOFSet#plus
|
||
|
|
* @param {DOFSet|string} otherSet - Set to add: either the name of the set or the actual DOFSet.
|
||
|
|
* @returns {DOFSet} Union of this and `otherSet`.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Creates a new DOFSet containing all the DOFs of this
|
||
|
|
* DOFSet that are not present in `otherSet`.
|
||
|
|
* @method DOFSet#minus
|
||
|
|
* @param {DOFSet|string} otherSet - Set to subtract: either the name of the set or the actual DOFSet.
|
||
|
|
* @returns {DOFSet} DOFSet containing DOFs of this set that are not in the argument set.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Get the DOFs from this set as an array of strings.
|
||
|
|
* @method DOFSet#getDOFs
|
||
|
|
* @returns {string[]}
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Check if this DOFSet contains a particular DOF.
|
||
|
|
* @method DOFSet#hasDOF
|
||
|
|
* @param {string} dofName - DOF name to test for membership in this set.
|
||
|
|
* @returns {boolean} `true` if this DOFSet has this dof.
|
||
|
|
*/
|
||
|
|
export default function createDOFs(): Promise<DOFSets>;
|