Bexel.Api.ElementGeometry Class Reference

Represents the geometrical representation associated with the element. More...

Inheritance diagram for Bexel.Api.ElementGeometry:

Public Member Functions
Geometry	GetGeometry ()
	Retrieves the geometry object of the element. More...
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
bool	HasGeometry [get]
	Indicates whether the element has geometrical representation. More...
bool	IsInstanced [get]
	Indicates whether the element has instanced geometry. If True, use cast to Bexel.Api.InstancedGeometry when calling GetGeometry to retrieve instance information. More...
int	VertexCount [get]
int	TriangleCount [get]
int	EdgeCount [get]
Properties inherited from Bexel.Api.IGeometry
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 the geometrical representation associated with the element.

Member Function Documentation

GetAllEdges()

IEnumerable<Segment3D> Bexel.Api.ElementGeometry.GetAllEdges

(

)

Retrieves all edges.

Returns

Enumerable of all edges.

Implements Bexel.Api.IGeometry.

GetAllTriangles()

IEnumerable<Triangle3D> Bexel.Api.ElementGeometry.GetAllTriangles

(

)

Retrieves all triangles.

Returns

Enumerable of all triangles.

Implements Bexel.Api.IGeometry.

GetAllVertices()

IEnumerable<Vector3D> Bexel.Api.ElementGeometry.GetAllVertices

(

)

Retrieves all vertices.

Returns

Enumerable of all vertices.

Implements Bexel.Api.IGeometry.

GetBoundingBox()

AABB3D Bexel.Api.ElementGeometry.GetBoundingBox

(

)

Returns an axis aligned bounding box (AABB) of the geometry.

Returns

AABB if it can be computed, else null.

Implements Bexel.Api.IGeometry.

GetEdge()

Segment3D Bexel.Api.ElementGeometry.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.

Implements Bexel.Api.IGeometry.

GetGeometry()

Geometry Bexel.Api.ElementGeometry.GetGeometry

(

)

Retrieves the geometry object of the element.

Returns

The geometry object of the element.

Exceptions

Bexel.Api.InvalidApiOperationException

Thrown if element has no geometry.

GetOrientedBoundingBox()

OBB3D Bexel.Api.ElementGeometry.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.

Implements Bexel.Api.IGeometry.

GetTriangle()

Triangle3D Bexel.Api.ElementGeometry.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.

Implements Bexel.Api.IGeometry.

GetVertex()

Vector3D Bexel.Api.ElementGeometry.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.

Implements Bexel.Api.IGeometry.

Property Documentation

HasGeometry

bool Bexel.Api.ElementGeometry.HasGeometry

get

Indicates whether the element has geometrical representation.

IsInstanced

bool Bexel.Api.ElementGeometry.IsInstanced

get

Indicates whether the element has instanced geometry. If True, use cast to Bexel.Api.InstancedGeometry when calling GetGeometry to retrieve instance information.