TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class DefaultVisibleCheck in Tinman.Terrain.Visibility

Abstract base class for IVisibleCheck implementations that have default settings.

abstract class DefaultVisibleCheck extends VisibleCheck
  base of ScreenVisibleCheck
  TerrainVisibleCheck

Public / Attributes

ErrorMaterial

Include surface materials (see Material) in visible check?

public property ErrorMaterial { get set }
type bool
value true if surface materials are included in the visible check, false if not.

See also:

Semantic.ErrorMaterial

ErrorNormal

Include surface normals (see Normal) in visible check?

public property ErrorNormal { get set }
type bool
value true if surface normals are included in the visible check, false if not.

See also:

Semantic.ErrorNormal

ErrorPosition

Include surface geometry (see Position) in visible check?

public property ErrorPosition { get set }
type bool
value true if surface geometry is included in the visible check, false if not.

See also:

Semantic.ErrorPosition

ErrorTexture

Include surface texture (see Texture) in visible check?

public property ErrorTexture { get set }
type bool
value true if surface texture is included in the visible check, false if not.

See also:

Semantic.ErrorTexture

Public / Methods

Add

Adds the given visibility check to this one, so that a mesh vertex will be visible if at least one of both returns true.

[Pure]
public virtual method Add (IVisibleCheck check)
type IVisibleCheck
params check [not-null] The visibility check to add.
returns [not-null] The resulting visibility check.
inherited VisibleCheck.Add

See also:

IVisibleCheck.Remove

Contains

Does this visible check contain the given one?

[Pure]
public virtual method Contains (IVisibleCheck check)
type bool
params check [not-null] The visible check.
returns true if check is contained, i.e. calling Add will return this.
false if check is not contained, i.e. calling Remove will return this.
inherited VisibleCheck.Contains

IsVertexVisible

Computes whether the given vertex shall be visible in the terrain mesh or not.

[Pure]
public abstract method IsVertexVisible (int32 v, int32 g, int32 a, float64 thresholdSqr)
type bool
params v The vertex to check for visibility.
  g Grand-parent of v.
  a Ancestor vertex of v.
  thresholdSqr The tolerated squared terrain-space vertex error.
returns true if the squared terrain-space vertex error value is greater than thresholdSqr (i.e. the vertex will be visible in the terrain mesh), false if not (i.e. the vertex will be invisible).
inherited VisibleCheck.IsVertexVisible

Remarks:

This method will be called repeatedly only by the refinement thread of the MeshBuffer. Thus, as long as no other code is called it, thread-safe code is not required here.

Remove

Removes the given vertex visibility check from this one, so that a mesh vertex will only be visible if this one returns true.

[Pure]
public virtual method Remove (IVisibleCheck check)
type IVisibleCheck
params check [not-null] The visibility check to remove.
returns [not-null] The resulting visibility check.
inherited VisibleCheck.Remove

See also:

IVisibleCheck.Add

SetVertexArrays

Sets the vertex data containers from which this vertex converter shall read vertex data.

public override method SetVertexArrays (VertexArrays vertexArrays)
params vertexArrays [not-null] The vertex data collection.
overrides VisibleCheck.SetVertexArrays

ToString

[Pure]
public override method ToString ()
type string

Protected / Attributes

errorMaterial

The ErrorMaterial vertex array of null if not present or disabled.

protected field errorMaterial
type float32[]

errorNormal

The ErrorNormal vertex array of null if not present or disabled.

protected field errorNormal
type float32[]

errorPosition

The ErrorPosition vertex array of null if not present or disabled.

protected field errorPosition
type float32[]

errorTexture

The ErrorTexture vertex array of null if not present or disabled.

protected field errorTexture
type float32[]

vertexArrays

The current vertex array collection.

protected field vertexArrays
type VertexArrays

See also:

SetVertexArrays

Protected / Constructors

DefaultVisibleCheck

Creates a new instance of DefaultVisibleCheck.

protected constructor DefaultVisibleCheck ()

Protected / Methods

ToString

Returns a unique name for this VisibleCheck instance.

protected method ToString (string name)
type string
params name Human-readable name of subclass.
returns [not-null] The unique and human-readable name.
inherited VisibleCheck.ToString