ISpatialEntityTrait

Description

interface Tinman.Terrain.Util.ISpatialEntityTrait
→ <TEntity ⁱⁿ ^val>
→ <TBounds ^val>

Extended by: SpatialOctree_Lines_Entity ^sealed
SpatialOctree_Points_Entity ^sealed
SpatialOctree_Triangles_Entity ^sealed
SpatialQuadtree_Lines_Entity ^sealed
SpatialQuadtree_Points_Entity ^sealed
SpatialQuadtree_Triangles_Entity ^sealed

Type trait for structures that provide the semantic of spatial tree node entities.

[Pure]
public method Bounds → (1)

Computes the bounding box of the given entity.

[Pure]
public method BoundsIntersect → (2)

entity ⁱⁿ : TEntity: The spatial entity.
bounds ⁱⁿ : TBounds: The axis-aligned bounds.
returns → int32: -1 if entity ⁱⁿ and bounds ⁱⁿ are disjoint.
0 if entity ⁱⁿ and bounds ⁱⁿ intersect.
1 if bounds ⁱⁿ fully contains entity ⁱⁿ.
2 if entity ⁱⁿ fully contains bounds ⁱⁿ or if it would not be advantageous to distribute entity ⁱⁿ any further down the spatial tree.

Checks if the given spatial entity intersects with the specified bounds.

This method is only called when a spatial entity is being added to the tree. Use Prepare to pre-compute coefficients.

[Pure]
public method Equals → (2)

Checks if the given spatial entities are equal.

Two spatial entities are considered to be equal if BoundsIntersect returns the same value for both entities, given any bounds.

[Pure]
public method Opposite → (2)

a ⁱⁿ : TEntity: First entity.
b ⁱⁿ : TEntity: Second entity.
returns → bool: true if the entities represent a shared spatial feature, false if not.

Checks if the given spatial entities represent a shared spatial feature, for example an edge that is shared by two polygons.

public method Prepare → (1)

entity ⁱⁿ : TEntity: The spatial entity.
returns → bool: true if entity ⁱⁿ has been prepared for being added,
false if entity ⁱⁿ cannot be added (for example, degenerated geometry).

The given spatial entity is about to be added to the spatial tree.