ActiveLib
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
active::geometry::XInfo Class Reference

#include <XInfo.h>

Public Member Functions

 XInfo (Position pos=Point::undefined, vertOption vertIndex=std::nullopt, partOption partIndex=std::nullopt)
 

Public Attributes

Position pos
 The relative position of the point to the component.
 
vertOption vertexIndex
 The ID of the intersecting component vertex (optional)
 
partOption partIndex
 The ID of the component part (optional)
 

Detailed Description

Information about an intersection point, e.g. the intersecting component and its geometric relationship to it

NB: The word "intersection" is generally abbreviated to "X" in class names, e.g. XPoint, XList etc. To understand this class, consider the calculation of the intersection between a polygon (with holes) and a line. There could be any number of intersections and, depending on the criteria, might include both actual and projected intersections (where an intersection would occur if the line was extended in either direction). In the first instance, a tool evaluating these intersections might want to stipulate that it is only interested in specific intersections, e.g. only:

Constructor & Destructor Documentation

◆ XInfo()

active::geometry::XInfo::XInfo ( Position pos = Point::undefined,
vertOption vertIndex = std::nullopt,
partOption partIndex = std::nullopt )
inline

Constructor

Parameters
posThe relationship of the point to the component (optional)
vertIndexThe ID of the intersecting component vertex (optional)
partIndexThe ID of the component part (optional)

The documentation for this class was generated from the following file: