PointsOfInterest

Description

sealed class Tinman.Engine.Scenes.Util.PointsOfInterest

Helper class for focusing on points of interest in a scene.

Public / Constructors

Points​Of​Interest

public constructor PointsOfInterest → ()

Creates a new instance of PointsOfInterest.

Public / Methods

Add

public method Add → (2)

center in : ITerrainTransform

[not-null]
The center of the point of interest.

radius in : float64

The bounding sphere radius of the point of interest.

returns → PointsOfInterest

this

Adds a point of interest.

Clear

public method Clear → ()

returns → PointsOfInterest

this

Removes all points of interest.

Compute​Angle

public method ComputeAngle → (1)

view in : Ray

The view ray.

returns → float64

The cone opening angle, in degrees. Will be 0 if there are no points of interest or if Ray.Origin is inside of all bounding spheres of the points of interest.

Computes the opening angle that will turn the given ray into a cone that contains all points of interest.

Compute​Bounds

public method ComputeBounds → ()

returns → Sphere

The enclosing bounding sphere, in terrain-space.

Computes the bounding sphere that encloses all points of interest.

See also

PointsOfInterest.MinimumRadius

Compute​Offset

public method ComputeOffset → (2)

view in : Ray

The cone ray.

angle in : float64

The cone opening angle, in degrees.

returns → float64

The movement offset along Ray.Direction of view in.

Computes the movement offset that will put the given cone at a position so that it contains all points of interest.

Remove

public method Remove → (1)

center in : ITerrainTransform

[not-null]
The point of interest no more.

returns → PointsOfInterest

this

Removes a point of interest.

Public / Attributes

Minimum​Radius

public attribute MinimumRadius → (get,set)

value : float64

[>=0]
The minimum radius to apply (see remarks).

Specifies the minimum bounding sphere radius of the points of interest.

The minimum radius is applied to the bounding sphere radius of each point that has been added via Add and thus influences ComputeAngle, ComputeBounds and ComputeOffset. Defaults to 0.