Picking

Description

sealed class Tinman.Terrain.Meshing.Picking

Derived from: MeshTraversal ^abstract
IMeshBoundMinRadius

The Picking class traverses the filtered mesh (see IMeshFilters.FilterIn) and computes the intersection of the given geometric primitive with the terrain surface.

The Picking class can be used to pick individual points, vertices and/or triangles from a CLOD mesh.

The following vertex data semantics are used by this class:

required : Semantic.Position
required : Semantic.Radius
optional : Semantic.Elevation
optional : Semantic.HeightmapCoords
optional : Semantic.Normal

Public / Constructors

Picking

public constructor Picking → ()

Creates a new instance of Picking.

Public / Methods

PickCoords

_4 overloads

[Pure]
public method PickCoords¹ → (1)

coords ⁱⁿ : Vec3D: Heightmap coordinates (relative to HeightmapsUtil.MaxSize) of a point on the ray.
returns → Vec3D: The position of the found intersection or Vec3D.Undefined if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

[Pure]
public method PickCoords² → (3)

coordsX ⁱⁿ : float64: Heightmap X-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
coordsY ⁱⁿ : float64: Heightmap Y-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
coordsZ ⁱⁿ : float64: Heightmap Z-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
returns → Vec3D: The position of the found intersection or Vec3D.Undefined if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

public method PickCoords³ → (2)

coords ⁱⁿ : Vec3D: Heightmap coordinates (relative to HeightmapsUtil.MaxSize) of a point on the ray.
flags ⁱⁿ : PointInfoFlags: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

public method PickCoords⁴ → (4)

coordsX ⁱⁿ : float64: Heightmap X-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
coordsY ⁱⁿ : float64: Heightmap Y-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
coordsZ ⁱⁿ : float64: Heightmap Z-coordinate (relative to HeightmapsUtil.MaxSize) of a point on the ray.
flags ⁱⁿ : PointInfoFlags: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

PickPoint

_4 overloads

[Pure]
public method PickPoint¹ → (1)

point ⁱⁿ : Vec3D: A point on the ray.
returns → Vec3D: The position of the found intersection or Vec3D.Undefined if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

[Pure]
public method PickPoint² → (3)

pointX ⁱⁿ : float64: X-coordinate of a point on the ray.
pointY ⁱⁿ : float64: Y-coordinate of a point on the ray.
pointZ ⁱⁿ : float64: Z-coordinate of a point on the ray.
returns → Vec3D: The position of the found intersection or Vec3D.Undefined if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

public method PickPoint³ → (2)

point ⁱⁿ : Vec3D: A point on the ray.
flags ⁱⁿ : PointInfoFlags: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

public method PickPoint⁴ → (4)

pointX ⁱⁿ : float64: X-coordinate of a point on the ray.
pointY ⁱⁿ : float64: Y-coordinate of a point on the ray.
pointZ ⁱⁿ : float64: Z-coordinate of a point on the ray.
flags ⁱⁿ : PointInfoFlags: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

The ray direction is parallel to the terrain up-vector (see IGeometry.ComputeUp).

PickRay

_2 overloads

public method PickRay¹ → (2)

ray ⁱⁿ : Ray: The ray.
flags ^opt : PointInfoFlags = PointInfoFlags.All: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

Intersections behind the ray origin are not reported by this method.

public method PickRay² → (7)

pointX ⁱⁿ : float64: X-coordinate of ray origin.
pointY ⁱⁿ : float64: Y-coordinate of ray origin.
pointZ ⁱⁿ : float64: Z-coordinate of ray origin.
directionX ⁱⁿ : float64: X-component of ray direction.
directionY ⁱⁿ : float64: Y-component of ray direction.
directionZ ⁱⁿ : float64: Z-component of ray direction.
flags ^opt : PointInfoFlags = PointInfoFlags.All: The PointInfoFlags.
returns → PointInfo: A PointInfo object that describes the found intersection (valid until next call to Pick*) or null if no intersection has been found.

Computes the intersection of the given ray with the terrain surface.

Intersections behind the ray origin are not reported by this method.

Public / Attributes

FilterIn

public attribute FilterIn → (get,set)

value : MeshTreeFilter: The filter or null.

The mesh tree input filter to use for querying sector culling and marks.

The default value is null (i.e. all mesh sectors are visited).

See also: MeshTree.GetRoot
MeshTree.GetChild
MeshTree.GetDown