PolygonLocationDetail Class

Carries data about a point in the plane of a polygon.

Methods

Name Description
copyContentsFrom(other: PolygonLocationDetail): void Set the instance contents from the other detail.  
invalidate(): void Invalidate this detail.  
create(result?: PolygonLocationDetail): PolygonLocationDetail Static Create an invalid detail.  
createAtVertexOrEdge(point: Point3d, index: number, fraction: number = 0): PolygonLocationDetail Static Set point, index, and fraction for an "at vertex" or "along edge" PolygonLocationDetail.  

Properties

Name Type Description
a number Application-specific number  
closestEdgeIndex number Index of the polygon vertex at the base of the edge closest to p.  
closestEdgeParam number The parameter along the closest edge of the projection of p.  
code PolygonLocation A number that classifies the point's location with respect to the polygon.  
isInsideOrOn Accessor ReadOnly boolean Whether this instance specifies a location inside or on the polygon.  
isValid Accessor ReadOnly boolean Whether this detail is valid.  
point Point3d The coordinates of the point p.  
v Vector3d Application-specific vector  

Defined in

Last Updated: 28 March, 2024