editor › Globals › EdgeJoinedPlatesContext
Class: EdgeJoinedPlatesContext
A plate context that assumes two plates being joined via a shared section. By knowing the shared section, this subclass can offer methods that are required to calculate corner shape changes
Hierarchy
↳ EdgeJoinedPlatesContext
Index
Constructors
Properties
- angle
- end
- isConvex
- isExternal
- isOtherExternal
- otherMaterialType
- otherStiffness
- otherThickness
- section
- start
- thisMaterialType
- thisStiffness
- thisThickness
Methods
- _getPointAt
- _getSectionAt
- getAngle
- getCornerAngle
- getDirection2D
- getEdgeJoint
- getIsConvex
- getIsExternal
- getIsOneSideFoamcore
- getIsOtherExternal
- getLength
- getNeighborContext
- getNormal2D
- getNormal2DAt
- getOtherMaterialType
- getOtherStiffness
- getOtherThickness
- getPosition2D
- getSection
- getTangent2DAt
- getThisMaterialType
- getThisStiffness
- getThisThickness
- hasFingerInCorner
- isAcuteCorner
- isConcaveCorner
- isConvexCorner
- isJoinedToMasterPlate
- isNeighborSectionJoined
- isObtuseCorner
- flipRoles
- fromPlates
- fromSection
Constructors
Protected constructor
+ new EdgeJoinedPlatesContext(outlineSection: OutlineSection, thisThickness?: number, otherThickness?: number, angle?: number, isExternal?: boolean, isOtherExternal?: boolean, startPosition2D?: Vector3, endPosition2D?: Vector3, isConvex?: boolean | null, thisStiffness?: number, otherStiffness?: number, thisMaterialType?: string, otherMaterialType?: string): EdgeJoinedPlatesContext
Overrides JoinedPlatesContext.constructor
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:54
Parameters:
| Name | Type |
|---|---|
outlineSection |
OutlineSection |
thisThickness? |
number |
otherThickness? |
number |
angle? |
number |
isExternal? |
boolean |
isOtherExternal? |
boolean |
startPosition2D? |
Vector3 |
endPosition2D? |
Vector3 |
isConvex? |
boolean | null |
thisStiffness? |
number |
otherStiffness? |
number |
thisMaterialType? |
string |
otherMaterialType? |
string |
Returns: EdgeJoinedPlatesContext
Properties
Protected angle
• angle: number
Inherited from JoinedPlatesContext.angle
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:42
Protected end
• end: Vector3‹›
Inherited from JoinedPlatesContext.end
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:48
Protected isConvex
• isConvex: boolean | null
Inherited from JoinedPlatesContext.isConvex
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:49
Protected isExternal
• isExternal: boolean
Inherited from JoinedPlatesContext.isExternal
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:45
Protected isOtherExternal
• isOtherExternal: boolean
Inherited from JoinedPlatesContext.isOtherExternal
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:46
Protected otherMaterialType
• otherMaterialType: string
Inherited from JoinedPlatesContext.otherMaterialType
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:53
Protected otherStiffness
• otherStiffness: number
Inherited from JoinedPlatesContext.otherStiffness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:51
Protected otherThickness
• otherThickness: number
Inherited from JoinedPlatesContext.otherThickness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:41
Private Readonly section
• section: OutlineSection
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:54
Protected start
• start: Vector3‹›
Inherited from JoinedPlatesContext.start
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:47
Protected thisMaterialType
• thisMaterialType: string
Inherited from JoinedPlatesContext.thisMaterialType
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:52
Protected thisStiffness
• thisStiffness: number
Inherited from JoinedPlatesContext.thisStiffness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:50
Protected thisThickness
• thisThickness: number
Inherited from JoinedPlatesContext.thisThickness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:40
Methods
Private _getPointAt
▸ _getPointAt(startOrEnd: "start" | "end"): OutlinePoint
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:173
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: OutlinePoint
Private _getSectionAt
▸ _getSectionAt(startOrEnd: "start" | "end"): OutlineSection
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:177
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: OutlineSection
getAngle
▸ getAngle(): number
Inherited from JoinedPlatesContext.getAngle
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:67
Returns: number
getCornerAngle
▸ getCornerAngle(startOrEnd: "start" | "end"): number
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:123
Parameters:
| Name | Type | Description |
|---|---|---|
startOrEnd |
"start" | "end" | corner angle (within their plate) for either 'start' or 'end' point |
Returns: number
@see Plate2DHelpers.getCornerAngle
getDirection2D
▸ getDirection2D(): Vector3
Inherited from JoinedPlatesContext.getDirection2D
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:92
Returns: Vector3
getEdgeJoint
▸ getEdgeJoint(): EdgeJoint
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:92
Returns: EdgeJoint
the edge joint instance that links the two plates
getIsConvex
▸ getIsConvex(): boolean
Inherited from JoinedPlatesContext.getIsConvex
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:146
Convex means that - assuming plate normals point outward from the object - the normals point away from each other. Concave means the opposite, normals point towards each other.
CONVEX
^
|
|
_______________
\
\----->
\
\
CONCAVE
_______________
| \
| <-----\
v \
\
Returns: boolean
Whether the two joined plates form a convex or a concave joint.
getIsExternal
▸ getIsExternal(): boolean
Inherited from JoinedPlatesContext.getIsExternal
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:79
Returns: boolean
getIsOneSideFoamcore
▸ getIsOneSideFoamcore(): boolean
Inherited from JoinedPlatesContext.getIsOneSideFoamcore
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:111
Returns: boolean
getIsOtherExternal
▸ getIsOtherExternal(): boolean
Inherited from JoinedPlatesContext.getIsOtherExternal
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:83
Returns: boolean
getLength
▸ getLength(): number
Inherited from JoinedPlatesContext.getLength
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:96
Returns: number
getNeighborContext
▸ getNeighborContext(startOrEnd: "start" | "end"): EdgeJoinedPlatesContext | null
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:150
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: EdgeJoinedPlatesContext | null
the JoinedPlatesContext that belongs to either the next section (starting with the 'end' point) or the previous section (ending in the 'start' point). Requires the other section to be joined with an EdgeJoint in order to reconstruct all information, so check with isNeighborSectionJoined() first.
getNormal2D
▸ getNormal2D(): Vector3
Inherited from JoinedPlatesContext.getNormal2D
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:87
Returns: Vector3
getNormal2DAt
▸ getNormal2DAt(startOrEnd: "start" | "end"): Vector3‹›
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:131
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: Vector3‹›
getOtherMaterialType
▸ getOtherMaterialType(): string
Inherited from JoinedPlatesContext.getOtherMaterialType
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:119
Returns: string
getOtherStiffness
▸ getOtherStiffness(): number
Inherited from JoinedPlatesContext.getOtherStiffness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:75
Returns: number
getOtherThickness
▸ getOtherThickness(): number
Inherited from JoinedPlatesContext.getOtherThickness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:63
Returns: number
getPosition2D
▸ getPosition2D(startOrEnd: "start" | "end"): Vector3
Inherited from JoinedPlatesContext.getPosition2D
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:100
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: Vector3
getSection
▸ getSection(): OutlineSection
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:96
Returns: OutlineSection
getTangent2DAt
▸ getTangent2DAt(startOrEnd: "start" | "end"): Vector3‹›
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:127
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: Vector3‹›
getThisMaterialType
▸ getThisMaterialType(): string
Inherited from JoinedPlatesContext.getThisMaterialType
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:115
Returns: string
getThisStiffness
▸ getThisStiffness(): number
Inherited from JoinedPlatesContext.getThisStiffness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:71
Returns: number
getThisThickness
▸ getThisThickness(): number
Inherited from JoinedPlatesContext.getThisThickness
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:59
Returns: number
hasFingerInCorner
▸ hasFingerInCorner(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:160
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
whether this plate will get a finger in this corner
isAcuteCorner
▸ isAcuteCorner(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:115
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
isConcaveCorner
▸ isConcaveCorner(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:107
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
whether the 'start' or 'end' point is in a concave corner
isConvexCorner
▸ isConvexCorner(startOrEnd: any): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:100
Parameters:
| Name | Type |
|---|---|
startOrEnd |
any |
Returns: boolean
isJoinedToMasterPlate
▸ isJoinedToMasterPlate(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:166
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
isNeighborSectionJoined
▸ isNeighborSectionJoined(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:141
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
whether the section ending in the 'start' point or the section starting in the 'end' point are joined with an edge joint (which would require extra care in that corner)
isObtuseCorner
▸ isObtuseCorner(startOrEnd: "start" | "end"): boolean
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:111
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: boolean
Static flipRoles
▸ flipRoles(startOrEnd: "start" | "end"): "start" | "end"
Inherited from JoinedPlatesContext.flipRoles
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:11
Parameters:
| Name | Type |
|---|---|
startOrEnd |
"start" | "end" |
Returns: "start" | "end"
Static fromPlates
▸ fromPlates(thisPlate: Plate, other: Plate, start: Vector3, end: Vector3, isConvex: boolean | null): JoinedPlatesContext
Inherited from JoinedPlatesContext.fromPlates
Defined in src/model/visualization/Joints/Renderer/FingerRendering/JoinedPlatesContext.ts:15
Parameters:
| Name | Type | Default |
|---|---|---|
thisPlate |
Plate | - |
other |
Plate | - |
start |
Vector3 | new Vector3() |
end |
Vector3 | new Vector3() |
isConvex |
boolean | null | - |
Returns: JoinedPlatesContext
Static fromSection
▸ fromSection(outlineSection: OutlineSection): EdgeJoinedPlatesContext‹›
Defined in src/model/visualization/Joints/Renderer/FingerRendering/EdgeJoinedPlatesContext.ts:19
Parameters:
| Name | Type |
|---|---|
outlineSection |
OutlineSection |
Returns: EdgeJoinedPlatesContext‹›