WeldmentComponentDefinition.FindUsingRay Method
Parent Object: WeldmentComponentDefinitionDescription
Method that fires a ray through the part or assembly and returns the entities intersected by the ray. The objects intersected by the ray are returned in the order in which they are intersected, with the first entities returned being those closest to the clipping plane.
Syntax
WeldmentComponentDefinition.FindUsingRay( RayStartPoint As Point, RayDirection As UnitVector, Radius As Double, FoundEntities As ObjectsEnumerator, LocationPoints As ObjectsEnumerator, [FindFirstOnly] As Boolean )Parameters
| Name | Type | Description |
| RayStartPoint | Point | Input object that defines the start point of the ray in model space. |
| RayDirection | UnitVector | Input object that defines the direction of the ray. The ray is infinite in the direction defined. |
| Radius | Double | Input Double that defines the radius of the ray. This value is specified in centimeters. Defining a radius for a ray allows the intersection to be within a given tolerance. This radius essentially results in the definition of a cylinder whose axis lies along the axis defined by the RayStartPoint and RayDirection. The intersection result is between the cylinder and the model's entities. A value higher than zero is recommended, though not explicitly required. |
| FoundEntities | ObjectsEnumerator | Output that returns the entities that were intersected by the ray. |
| LocationPoints | ObjectsEnumerator | Output that returns a set of Point objects. One Point object is returned for each entity in the FoundEntities list. The point defines the coordinate of the intersection between the ray and the corresponding entity. |
| FindFirstOnly | Boolean | Optional input Boolean that specifies whether to find just the first entity in the ray's path. If False (the default) then all entities found are returned. This is an optional argument whose default value is False. |