editor › Globals › JointCoordinator
Class: JointCoordinator
Abstract class that detects and fixes joint overlaps
Hierarchy
- JointCoordinator
Index
Methods
Methods
Static canCoordinateJointClass
▸ canCoordinateJointClass(jointClass: any): boolean
Defined in src/model/visualization/Joints/JointCoordination/JointCoordinator.ts:13
Determine whether this JointCoordinator subclass can coordinate the given type of joint
Parameters:
| Name | Type | Description |
|---|---|---|
jointClass |
any | joint type that is to be tested |
Returns: boolean
whether the joint class can be coordinated
Static coordinateJointShapeChanges
▸ coordinateJointShapeChanges(changedObjects: Set‹PhysicalObject›, fabricationConfig: FabricationConfig, highFidelity: boolean): Set‹PhysicalObject›
Defined in src/model/visualization/Joints/JointCoordination/JointCoordinator.ts:24
Detect and fix overlaps between joints in changedJoints, which might lead to changes in oldJoints
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
changedObjects |
Set‹PhysicalObject› | - | newly rendered physical objects that need to be checked for overlaps |
fabricationConfig |
FabricationConfig | - | optional, the fabricationConfig to use |
highFidelity |
boolean | false | whether the JointCoordinator should go to great lengths to produce better results |
Returns: Set‹PhysicalObject›
changedObjects objects that have been altered during or before this call
Static coordinateJointShapeChangesAsynchronously
▸ coordinateJointShapeChangesAsynchronously(changedObjects: Set‹PhysicalObject›, fabricationConfig: FabricationConfig, highFidelity: boolean): Promise‹Set‹PhysicalObject››
Defined in src/model/visualization/Joints/JointCoordination/JointCoordinator.ts:36
The same as @see JointCoordinator.coordinateJointShapeChanges, only asynchronously.
Parameters:
| Name | Type | Default |
|---|---|---|
changedObjects |
Set‹PhysicalObject› | - |
fabricationConfig |
FabricationConfig | - |
highFidelity |
boolean | false |
Returns: Promise‹Set‹PhysicalObject››
Promise resolving to objects that have been altered