data class VerticalOutlineElement: Tolerable, Any
Fields
| Name | Description |
|---|---|
val basePoint: Vector3D
|
base point of the outline element |
val leftHeadPoint: Option
|
left head point representing the bound point of the side surface to the left |
val rightHeadPoint: Option
|
right head point representing the bound point of the side surface to the right |
val tolerance: Double
|
tolerable threshold value |
Constructors
<init>
constructor(basePoint: Vector3D, leftHeadPoint: Option
A vertical outline element is represented by a basePoint and an optional leftHeadPoint and rightHeadPoint. The basePoint defines the bound of the base surface
Parameters
| Name | Description |
|---|---|
basePoint: Vector3D
|
base point of the outline element |
leftHeadPoint: Option
|
left head point representing the bound point of the side surface to the left |
rightHeadPoint: Option
|
right head point representing the bound point of the side surface to the right |
tolerance: Double
|
Methods
containsHeadPoint
fun containsHeadPoint(): Boolean
ReturnValue
| Name | Description |
|---|---|
Boolean
|
containsOneHeadPoint
fun containsOneHeadPoint(): Boolean
ReturnValue
| Name | Description |
|---|---|
Boolean
|
getVerticesAsLeftBoundary
fun getVerticesAsLeftBoundary(): List<Vector3D>
ReturnValue
| Name | Description |
|---|---|
List<Vector3D>
|
getVerticesAsRightBoundary
fun getVerticesAsRightBoundary(): List<Vector3D>
ReturnValue
| Name | Description |
|---|---|
List<Vector3D>
|
getHeadPointAdjacentToTheRight
fun getHeadPointAdjacentToTheRight(): if (rightHeadPoint.isDefined()) rightHeadPoint else leftHeadPoint
ReturnValue
| Name | Description |
|---|---|
if (rightHeadPoint.isDefined()) rightHeadPoint else leftHeadPoint
|
CompanionObject
VerticalOutlineElement
data class VerticalOutlineElement: Tolerable, Any
A vertical outline element is represented by a basePoint and an optional leftHeadPoint and rightHeadPoint. The basePoint defines the bound of the base surface
Methods
of
fun of(basePoint: Vector3D, leftHeadPoint: Option
Parameters
ReturnValue
| Name | Description |
|---|---|
ContextMessage
|
of
fun of(basePoint: Vector3D, headPoints: List<Vector3D>, tolerance: Double): VerticalOutlineElement
Returns a VerticalOutlineElement based on a provided list of headPoints.
Parameters
ReturnValue
| Name | Description |
|---|---|
VerticalOutlineElement
|
of
fun of(elements: List<VerticalOutlineElement>, tolerance: Double): ContextMessage
Returns a VerticalOutlineElement by merging a list of elements.
Parameters
| Name | Description |
|---|---|
elements: List<VerticalOutlineElement>
|
list of VerticalOutlineElement which must all contain the same base point |
tolerance: Double
|
allowed tolerance |
ReturnValue
| Name | Description |
|---|---|
ContextMessage
|
A vertical outline element is represented by a basePoint and an optional leftHeadPoint and rightHeadPoint. The basePoint defines the bound of the base surface