editor › Globals › IDirectionSpace

Interface: IDirectionSpace

a subset of the full sphere of directions. DirectionSpaces are immutable.

Hierarchy

• IDirectionSpace

Implemented by

• DirectionRange
• EveryDirection
• NoDirection
• SingleDirection

Index

Methods

• containsDirection
• exampleDirection
• getPlateSides
• intersectWith
• isEmpty

Methods

containsDirection

▸ containsDirection(direction: Vector3): boolean

Defined in src/model/data/Joints/Directions/IDirectionSpace.ts:30

Does this DirectionSpace contain a given direction?

Parameters:

Name	Type	Description
direction	Vector3	the given direction

Returns: boolean

---

exampleDirection

▸ exampleDirection(): Vector3

Defined in src/model/data/Joints/Directions/IDirectionSpace.ts:16

Returns one direction that is represented by this DirectionSpace

Returns: Vector3

---

getPlateSides

▸ getPlateSides(): PlateSides

Defined in src/model/data/Joints/Directions/IDirectionSpace.ts:35

On which side or sides of a reference plate is this DirectionSpace?

Returns: PlateSides

---

intersectWith

▸ intersectWith(other: IDirectionSpace): IDirectionSpace

Defined in src/model/data/Joints/Directions/IDirectionSpace.ts:24

Calculates and returns the intersection between this DirectionSpace and a given one. Might return itself or the given DirectionSpace if they contain the other one or a new DirectionSpace otherwise. DirectionSpaces are immutable.

Parameters:

Name	Type	Description
other	IDirectionSpace	the DirectionSpace to intersect with

Returns: IDirectionSpace

---

isEmpty

▸ isEmpty(): boolean

Defined in src/model/data/Joints/Directions/IDirectionSpace.ts:11

Returns true if this direction space has no direction, which is the case if it is a NoDirection

Returns: boolean