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

Fields

Name Description
val basePoint: Vector3D

base point of the outline element

val leftHeadPoint: Option<Vector3D>

left head point representing the bound point of the side surface to the left

val rightHeadPoint: Option<Vector3D>

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<Vector3D>, rightHeadPoint: Option<Vector3D>, tolerance: Double)

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<Vector3D>

left head point representing the bound point of the side surface to the left

rightHeadPoint: Option<Vector3D>

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

getHighestPointAdjacentToTheTop

fun getHighestPointAdjacentToTheTop(): List<Vector3D>

ReturnValue

Name Description
List<Vector3D>

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<Vector3D>, rightHeadPoint: Option<Vector3D>, tolerance: Double): ContextMessage<VerticalOutlineElement>

Parameters

Name Description
basePoint: Vector3D
leftHeadPoint: Option<Vector3D>
rightHeadPoint: Option<Vector3D>
tolerance: Double

ReturnValue

Name Description
ContextMessage<VerticalOutlineElement>

of

fun of(basePoint: Vector3D, headPoints: List<Vector3D>, tolerance: Double): VerticalOutlineElement

Returns a VerticalOutlineElement based on a provided list of headPoints.

Parameters

Name Description
basePoint: Vector3D

base point of the outline element

headPoints: List<Vector3D>

a maximum number of two head points must be provided

tolerance: Double

allowed tolerance

ReturnValue

Name Description
VerticalOutlineElement

of

fun of(elements: List<VerticalOutlineElement>, tolerance: Double): ContextMessage<VerticalOutlineElement>

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<VerticalOutlineElement>