Represents a geometrical representation of an object. It is usually comprised of vertices/triangles but can also contain lines/edges (wireframe geometry). More...
Public Member Functions | |
| Vector3D | GetVertex (int index) |
| Retrieves the vertex at the specified index. More... | |
| Triangle3D | GetTriangle (int index) |
| Retrieves the triangle at the specified index. More... | |
| Segment3D | GetEdge (int index) |
| Retrieves the edge at the specified index. More... | |
| IEnumerable< Vector3D > | GetAllVertices () |
| Retrieves all vertices. More... | |
| IEnumerable< Triangle3D > | GetAllTriangles () |
| Retrieves all triangles. More... | |
| IEnumerable< Segment3D > | GetAllEdges () |
| Retrieves all edges. More... | |
| AABB3D | GetBoundingBox () |
| Returns an axis aligned bounding box (AABB) of the geometry. More... | |
| OBB3D | GetOrientedBoundingBox () |
| Calculates and returns an object oriented bounding box (OBB) of the geometry. More... | |
Properties | |
| int | VertexCount [get] |
| Returns the number of vertices associated with the geometry. More... | |
| int | TriangleCount [get] |
| Returns the number of triangles associated with the geometry. More... | |
| int | EdgeCount [get] |
| Returns the number of edges associated with this geometry. More... | |
Detailed Description
Represents a geometrical representation of an object. It is usually comprised of vertices/triangles but can also contain lines/edges (wireframe geometry).
All of the linear measurement values are expressed in meters (m).
Member Function Documentation
◆ GetAllEdges()
| IEnumerable<Segment3D> Bexel.Api.IGeometry.GetAllEdges | ( | ) |
Retrieves all edges.
- Returns
- Enumerable of all edges.
Implemented in Bexel.Api.Geometry, and Bexel.Api.ElementGeometry.
◆ GetAllTriangles()
| IEnumerable<Triangle3D> Bexel.Api.IGeometry.GetAllTriangles | ( | ) |
Retrieves all triangles.
- Returns
- Enumerable of all triangles.
Implemented in Bexel.Api.Geometry, and Bexel.Api.ElementGeometry.
◆ GetAllVertices()
| IEnumerable<Vector3D> Bexel.Api.IGeometry.GetAllVertices | ( | ) |
Retrieves all vertices.
- Returns
- Enumerable of all vertices.
Implemented in Bexel.Api.ElementGeometry, and Bexel.Api.Geometry.
◆ GetBoundingBox()
| AABB3D Bexel.Api.IGeometry.GetBoundingBox | ( | ) |
Returns an axis aligned bounding box (AABB) of the geometry.
- Returns
- AABB if it can be computed, else null.
Implemented in Bexel.Api.Geometry, and Bexel.Api.ElementGeometry.
◆ GetEdge()
| Segment3D Bexel.Api.IGeometry.GetEdge | ( | int | index | ) |
Retrieves the edge at the specified index.
- Parameters
-
index Index of the edge. Must be in range [0, EdgeCount).
- Returns
- Edge at the specified index.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException Thrown if specified index is out of range.
Implemented in Bexel.Api.ElementGeometry, and Bexel.Api.Geometry.
◆ GetOrientedBoundingBox()
| OBB3D Bexel.Api.IGeometry.GetOrientedBoundingBox | ( | ) |
Calculates and returns an object oriented bounding box (OBB) of the geometry.
- Returns
- OBB if it can be computed, else null.
Only XY plane is used to calculate the orientation of the object.
Implemented in Bexel.Api.Geometry, and Bexel.Api.ElementGeometry.
◆ GetTriangle()
| Triangle3D Bexel.Api.IGeometry.GetTriangle | ( | int | index | ) |
Retrieves the triangle at the specified index.
- Parameters
-
index Index of the triangle. Must be in range [0, TriangleCount).
- Returns
- Triangle at the specified index.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException Thrown if specified index is out of range.
Implemented in Bexel.Api.ElementGeometry, and Bexel.Api.Geometry.
◆ GetVertex()
| Vector3D Bexel.Api.IGeometry.GetVertex | ( | int | index | ) |
Retrieves the vertex at the specified index.
- Parameters
-
index Index of the vertex. Must be in range [0, VertexCount).
- Returns
- Vertex at the specified index.
- Exceptions
-
Bexel.Api.InvalidApiArgumentException Thrown if specified index is out of range.
Implemented in Bexel.Api.ElementGeometry, and Bexel.Api.Geometry.
Property Documentation
◆ EdgeCount
|
get |
Returns the number of edges associated with this geometry.
Note that the number of edges is not related to the number of triangles nor the number of vertices. Edges are displayed as wireframe geometry in the viewer.
◆ TriangleCount
|
get |
Returns the number of triangles associated with the geometry.
◆ VertexCount
|
get |
Returns the number of vertices associated with the geometry.
