ICameraFocus

Description

interface Tinman.Engine.Scenes.Entities.ICameraFocus

Base interface for cameras that can be focused automatically on points of interest in the scene.

public method FocusAngle → (1)

angle ⁱⁿ : float64: [>=0]
The cone opening angle, in degrees.
returns → bool: true if angle ⁱⁿ has been applied to some amount, false if it has been ignored.

Applies the given cone opening angle.

The given angle ⁱⁿ depicts the optimal focus value, implementations are free to interpret it in any way.

public method FocusCenter → (1)

center ⁱⁿ : Vec3D: The point in terrain-space.
returns → bool: true if center ⁱⁿ has been applied to some amount, false if it has been ignored.

Applies the given focus center.

The given center ⁱⁿ depicts the optimal focus value, implementations are free to interpret it in any way.

public method FocusCone → (1)

Returns the current focus cone of this camera.

public method FocusOffset → (1)

offset ⁱⁿ : float64: The cone offset distance, in terrain-space.
returns → bool: true if offset ⁱⁿ has been applied to some amount, false if it has been ignored.

Applies the given cone offset distance.

The given offset ⁱⁿ depicts the optimal focus value, implementations are free to interpret it in any way.