ISpatialCallback

Description

interface Tinman.Terrain.Util.ISpatialCallback

Extended by: Example_SpatialCallback ^sealed

Base interface for classes that consume callbacks during collision tests.

Public / Methods

Begin

public method Begin → (2)

minimum ⁱⁿ : float64: The minimum distance value that will be reported to Pair.
maximum ⁱⁿ : float64: The maximum distance value that will be reported to Pair.

A new collision test has begun.

For simple collision tests, minimum ⁱⁿ will be 0 and maximum ⁱⁿ will be Maths.UlpDouble.

ChildPop

public method ChildPop → (1)

firstOrSecond ⁱⁿ : bool: true to leave the first child node,
second to leave the second child node.

Leaves the current child node.

ChildPush

public method ChildPush → (2)

firstOrSecond ⁱⁿ : bool: true to enter a child of the first node,
second to enter a child of the second child node.
index ⁱⁿ : int32: The zero-based child index. The interpretation of child indices is defined by the class that accepts ISpatialCallback objects and the documentation should provide explanations accordingly.

Enters the given child node.

Counters

public method Counters → (2)

broad ⁱⁿ : int32: The number of processed nodes in the broad phase.
narrow ⁱⁿ : int32: The number of processed nodes in the narrow phase.

Accumulates performance counters.

End

public method End → ()

The current collision test has ended.

Pair

public method Pair → (4)

first ⁱⁿ : Box3D: The bounding-box of the first collision node, in its local model-space.
second ⁱⁿ : Box3D: The bounding-box of the first collision node, in its local model-space.
firstToSecond ⁱⁿ : AffineTransform: The transformation from first ⁱⁿ to second ⁱⁿ.
distance ⁱⁿ : float64: The resulting distance value. Will be in the range [minimum..maximum], see Begin.

A pair of collision nodes has been processed.

TransformPop

public method TransformPop → ()

Pops the top-most transformation from the stack.

TransformPush

public method TransformPush → (1)

transform ⁱⁿ : AffineTransform: The transformation to add.

Appends the top-most transformation of the stack to the given transform ⁱⁿ and then pushes the resulting transformation onto the stack.

The top-most transformation is used to transform first model-space to world-space.