Rtin

Description

sealed class Tinman.Terrain.Kernel.Rtin
→ <TVertex ^val : IRtinVertexTrait>
→ <TTriangle ^val : IRtinTriangleTrait>

Derived from: ICapacity

A general-purpose right-triangulated irregular network (RTIN).

The following steps are necessary to build and use an RTIN mesh:

Create an instance of Rtin. At this point, the type traits for IRtinVertexTrait and IRtinTriangleTrait must be chosen. Also, the vertex capacity must be chosen.
Call Create to build the initial mesh structure. Only during this invocation, IRtinVertexTrait.Compute² callbacks will be made.
Use Add to build the mesh structure by creating new vertices. Only during these invocations, IRtinVertexTrait.Compute¹ callbacks will be made.
Use Down, Face, Sector² and Up to traverse the existing mesh structure.
Use Delete to reduce the mesh structure by removing existing vertices.
Use Triangulate¹ to generate indexed triangle lists for mesh sectors. Only during these invocations, callbacks to IRtinTriangleTrait will be made.

Public / Constructors

Rtin

public constructor Rtin → (2)

vertex ⁱⁿ : TVertex: The vertex type trait.
triangle ⁱⁿ : TTriangle: The triangle type trait.

Creates a new instance of Rtin.

The initial mesh capacity will be zero (see ICapacity.Capacity).

Public / Methods

Add

public method Add → (2)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
index ⁱⁿ : int32: [0..3]
The child index, one of XDag.LL, XDag.LR, XDag.RL and XDag.RR.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null iff the capacity is exhausted.

Returns the index ⁱⁿ-th child of the given vertex, creating it if necessary.

This method will delegate to AddLL, AddLR, AddRL or AddRR.

AddLL

public method AddLL → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null iff the capacity is exhausted.

Returns the XDag.LL child of the given vertex, creating it if necessary.

AddLR

public method AddLR → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null iff the capacity is exhausted.

Returns the XDag.LR child of the given vertex, creating it if necessary.

AddRL

public method AddRL → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null iff the capacity is exhausted.

Returns the XDag.RL child of the given vertex, creating it if necessary.

AddRR

public method AddRR → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null iff the capacity is exhausted.

Returns the XDag.RR child of the given vertex, creating it if necessary.

Create

public method Create → (1)

type ⁱⁿ : MapType: The map type of the mesh to create.

Creates a new mesh, discarding the existing mesh, if any.

LicenceException: If the licence check has failed.

Delete

public method Delete → (1)

vertex ⁱⁿ : int32: The vertex.
returns → bool: true if vertex ⁱⁿ was a leaf and has been deleted,
false if vertex ⁱⁿ was not a leaf and has not been deleted.

Deletes the given leaf vertex.

See also: Rtin.Leaf

Down

public method Down → (2)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex.
index ⁱⁿ : int32: [0..3]
The child index, one of XDag.LL, XDag.LR, XDag.RL and XDag.RR.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the index ⁱⁿ-th child of the given vertex.

This method will delegate to DownLL, DownLR, DownRL or DownRR.

DownLL

public method DownLL → (1)

v ⁱⁿ : int32: The vertex.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the XDag.LL child of the given vertex.

DownLR

public method DownLR → (1)

v ⁱⁿ : int32: The vertex.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the XDag.LR child of the given vertex.

DownRL

public method DownRL → (1)

v ⁱⁿ : int32: The vertex.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the XDag.RL child of the given vertex.

DownRR

public method DownRR → (1)

v ⁱⁿ : int32: The vertex.
returns → int32: The child vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the XDag.RR child of the given vertex.

Face

public method Face → (1)

face ^opt : CubemapFace = CubemapFace.NegZ: The cubemap face.
returns → int32: The root vertex or XDag.Void if not existent.

Returns the root vertex of the given cubemap face.

Leaf

public method Leaf → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → bool: true if vertex ⁱⁿ is a leaf, false if not.

Checks if the given vertex is a leaf, i.e. it does not have any child vertices.

Sector

_2 overloads

public method Sector¹ → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → bool: true if sector ⁱⁿ is a mesh sector, false if not.

Checks if the given vertex is the center of a mesh sector.

public method Sector² → (2)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector.
index ⁱⁿ : int32: [0..3]
The child index.
returns → int32: The child mesh sector or XDag.Null if not existent.

Returns the index ⁱⁿ-th child sector.

This method will delegate to Sector0, Sector1, Sector2 or Sector3.

Sector0

public method Sector0 → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector.
returns → int32: The child mesh sector or XDag.Null if not existent.

Returns the child sector at index 0.

Sector1

public method Sector1 → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector.
returns → int32: The child mesh sector or XDag.Null if not existent.

Returns the child sector at index 1.

Sector2

public method Sector2 → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector.
returns → int32: The child mesh sector or XDag.Null if not existent.

Returns the child sector at index 2.

Sector3

public method Sector3 → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector.
returns → int32: The child mesh sector or XDag.Null if not existent.

Returns the child sector at index 3.

Triangulate

_2 overloads

public method Triangulate¹ → ()

Triangulates the whole mesh.

This method iterates over all Cubemap faces, calls Face for each one and finally delegates to Triangulate².

public method Triangulate² → (1)

sector ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The mesh sector to triangulate.

Triangulates the given mesh sector.

If sector ⁱⁿ does not refer to a valid mesh sector vertex, this method returns silently.

See also: Rtin.Sector¹

Up

public method Up → (2)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
index ⁱⁿ : int32: [0..3]
The parent index, one of XDag.L, XDag.R, XDag.A and XDag.G.
returns → int32: The parent vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the index ⁱⁿ-th parent of the given vertex.

This method will delegate to UpL, UpR, UpA or UpG.

UpA

public method UpA → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The ancestor vertex or XDag.Null if not existent.

Returns the ancestor XDag.A of the given vertex.

UpG

public method UpG → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The grand-parent vertex or XDag.Null if not existent.

Returns the grand-parent XDag.G of the given vertex.

UpL

public method UpL → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The left-parent vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the left parent XDag.L of the given vertex.

UpR

public method UpR → (1)

vertex ⁱⁿ : int32: [0..ICapacity.Capacity-1]
The vertex index.
returns → int32: The right-parent vertex or XDag.Void if the vertex would lie outside of the mesh bounds or XDag.Null if not existent.

Returns the right parent XDag.R of the given vertex.

Public / Attributes

CountUnused

public attribute CountUnused → (get)

value : int32: [0..ICapacity.Capacity]
The number of unused vertices.

Returns the number of unused vertices.

CountUsed

public attribute CountUsed → (get)

value : int32: [0..ICapacity.Capacity]
The number of used vertices.

Returns the number of used vertices.

Rtin

Description

Public / Constructors

Rtin

Public / Methods

Add

Add​LL

Add​LR

Add​RL

Add​RR

Create

Delete

Down

Down​LL

Down​LR

Down​RL

Down​RR

Face

Leaf

Sector

Sector0

Sector1

Sector2

Sector3

Triangulate

Up

Up​A

Up​G

Up​L

Up​R

Public / Attributes

Count​Unused

Count​Used

AddLL

AddLR

AddRL

AddRR

DownLL

DownLR

DownRL

DownRR

UpA

UpG

UpL

UpR

CountUnused

CountUsed