editor › Globals › OnPlaneAlignment

Class: OnPlaneAlignment

Class that holds information to align an object to a plane (parallel to the plane) Usually defined by the plate normal, position, and the distance of the parallel plane to the plate

Hierarchy

↳ PositionAlignment

↳ OnPlaneAlignment

Index

Properties

• distance
• normal
• point

Methods

• getConstraint
• setDistance
• setNormal
• setPoint

Properties

Private distance

• distance: AlignValue

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:13

---

Private normal

• normal: AlignValue

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:11

---

Private point

• point: AlignValue

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:12

Methods

getConstraint

▸ getConstraint(): OnPlaneConstraint

Overrides Alignment.getConstraint

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:30

Returns: OnPlaneConstraint

Actual plane and distance to align to

---

setDistance

▸ setDistance(alignValue: AlignValue): void

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:23

Parameters:

Name	Type
alignValue	AlignValue

Returns: void

---

setNormal

▸ setNormal(alignValue: AlignValue): void

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:19

Parameters:

Name	Type
alignValue	AlignValue

Returns: void

---

setPoint

▸ setPoint(alignValue: AlignValue): void

Defined in src/model/data/aligning/Alignments/OnPlaneAlignment.ts:15

Parameters:

Name	Type
alignValue	AlignValue

Returns: void