editor › Globals › PlateGroup
Class: PlateGroup
This class holds a number of plates with relative translation/rotation to one another. This is used to layout plates that are joint by CoplanarJoints in SVG.
Hierarchy
- PlateGroup
Index
Properties
Methods
- addPlate
- getAssembly
- getEdgeJointJigs
- getJoints
- getMatrix
- getPlateToSurfaceMap
- getPlates
- getSide
- setEdgeJointJigs
Properties
Private edgeJointsWithJigs
• edgeJointsWithJigs: Set‹EdgeJoint› = new Set()
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:19
Private joints
• joints: Set‹CoplanarJoint‹›› = new Set
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:20
Private Readonly matrices
• matrices: Map‹Plate‹›, Matrix4‹›› = new Map
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:17
Private Readonly plates
• plates: Plate[] = []
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:16
Private Readonly sides
• sides: Map‹Plate‹›, PlateSide› = new Map
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:18
Methods
addPlate
▸ addPlate(plate: Plate, matrix: Matrix4‹›, side: PlateSide, joint?: CoplanarJoint): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:22
Parameters:
| Name | Type | Default |
|---|---|---|
plate |
Plate | - |
matrix |
Matrix4‹› | new Matrix4() |
side |
PlateSide | PlateSide.FRONT |
joint? |
CoplanarJoint | - |
Returns: void
getAssembly
▸ getAssembly(): Assembly
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:54
Returns: Assembly
The assembly this PlateGroup belongs to.
getEdgeJointJigs
▸ getEdgeJointJigs(): Set‹EdgeJoint›
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:63
getJoints
▸ getJoints(): Set‹CoplanarJoint›
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:35
Returns: Set‹CoplanarJoint›
getMatrix
▸ getMatrix(plate: Plate): Matrix4
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:43
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
Returns: Matrix4
getPlateToSurfaceMap
▸ getPlateToSurfaceMap(): Map‹Plate, MeshSurface›
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:73
Maps plates to their model elements. If a plate is not realized yet, it will be omitted from the map. Rounded plates will be omitted as well.
Returns: Map‹Plate, MeshSurface›
A map of all plates within this PlateGroup to their respective MeshSurfaces.
getPlates
▸ getPlates(): Plate[]
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:39
Returns: Plate[]
getSide
▸ getSide(plate: Plate): PlateSide
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:47
Parameters:
| Name | Type |
|---|---|
plate |
Plate |
Returns: PlateSide
setEdgeJointJigs
▸ setEdgeJointJigs(edgeJointsWithJigs: Set‹EdgeJoint›): void
Defined in src/modules/kyub.core.svgObjExporter/src/export/PlateGroup.ts:59
Parameters:
| Name | Type |
|---|---|
edgeJointsWithJigs |
Set‹EdgeJoint› |
Returns: void