TerraNode Class Reference

This class implements a generic node in the ArchesTree model. More...

#include <archestree.h>

Inheritance diagram for TerraNode:

Public Member Functions
	TerraNode (const Box2 &=Box2::Infinity)
	Create a node.
virtual Box2	GetBox () const
	Returns the bouding box of a node.
virtual ScalarAlpha	ElevationAlpha (const Vector2 &) const
	Compute the elevation and weight.
virtual double	Elevation (const Vector2 &) const
	Compute the elevation at a given position.
virtual double	Alpha (const Vector2 &) const
	Compute the alpha mask at a given position.
virtual Vector2	Gradient (const Vector2 &) const
	Compute the gradient at a given position.
virtual Vector	Normal (const Vector2 &) const
	Compute the normal at a given position.
virtual void	writeJson (QJsonObject &)
	Compute the Json Document of the subtree.
virtual int	Traversal (const Vector2 &) const
	Compute the number of nodes that are traversed when evaluating the tree.
virtual int	Memory () const
	Compute the size of a node.
ScalarField2	Sample (const Array2 &) const
	Create a discrete scalar field by sampling the elevation over a given domain.
ScalarField2	Alpha (const Array2 &) const
	Create a discrete scalar field by sampling the elevation over a given domain.
void	Blend (HeightField &) const
	Blend a given node with an existing terrain over an input heightfield.
void	Add (HeightField &) const
	Add a given node with an existing heightfield.
virtual void	Draw (QGraphicsScene &) const
	Renders the node into a QGraphicsScene.

Protected Attributes
Box2	box = Box2::Infinity
	Bounding box.

Static Protected Attributes
static const double	epsilon = 1e-2
	Epsilon value for gradient computations.

Detailed Description

This class implements a generic node in the ArchesTree model.

The default elevation function is set to 0 and the weight to 1.

Constructor & Destructor Documentation

TerraNode()

TerraNode::TerraNode ( const Box2 & box = Box2::Infinity )

explicit

Create a node.

Parameters

box

The box.

References box.

Referenced by TerraGrid::ElevationAlpha(), Memory(), TerraUnary::PutAt(), TerraUnary::PutAt(), TerraBinary::TerraBinary(), TerraOperator::TerraOperator(), and TerraUnary::TerraUnary().

Member Function Documentation

Add()

void TerraNode::Add

(

HeightField &

h

)

const

Add a given node with an existing heightfield.

Parameters

h	HeighfField.

References ScalarAlpha::Alpha(), box, ElevationAlpha(), and ScalarAlpha::Value().

Alpha() [1/2]

ScalarField2 TerraNode::Alpha

(

const Array2 &

a

)

const

Create a discrete scalar field by sampling the elevation over a given domain.

Parameters

a

Domain.

References Alpha(), Array2::ArrayVertex(), Array2::GetSizeX(), and Array2::GetSizeY().

Alpha() [2/2]

double TerraNode::Alpha ( const Vector2 & p ) const

virtual

Compute the alpha mask at a given position.

See also

Elevation

Parameters

p

Point.

References ScalarAlpha::Alpha(), and ElevationAlpha().

Referenced by Alpha().

Blend()

void TerraNode::Blend

(

HeightField &

h

)

const

Blend a given node with an existing terrain over an input heightfield.

Let a the mask of the node, the mask of the heightfield is implicitly defined as (1-a).

Parameters

h	HeighfField.

References ScalarAlpha::Alpha(), box, ElevationAlpha(), Math::Lerp(), ScalarAlpha::Value(), and Array2::VertexIntegerArea().

Draw()

void TerraNode::Draw ( QGraphicsScene & scene ) const

virtual

Renders the node into a QGraphicsScene.

Draws the box.

Parameters

scene

The scene.

Reimplemented in TerraAddNoise, TerraBinary, TerraBlend, TerraCurveThick, TerraDisc, TerraOcean, TerraPlateau, and TerraVertex.

References box.

Elevation()

double TerraNode::Elevation ( const Vector2 & p ) const

virtual

Compute the elevation at a given position.

This is a shortcut for:

TerraNode* node; // Node
double e=node->ElevationAlpha(p).Value(); // Get elevation from ScalarAlpha

Parameters

p

Point.

References ElevationAlpha(), and ScalarAlpha::Value().

Referenced by Gradient(), and Sample().

ElevationAlpha()

ScalarAlpha TerraNode::ElevationAlpha ( const Vector2 & ) const

virtual

Compute the elevation and weight.

Parameters

p

Point.

Reimplemented in Terra2015Replace, Terra2015ReplaceAlpha, Terra2015ReplaceMaxAlpha, TerraAdd, TerraAddNoise, TerraBinaryBlend, TerraBlend, TerraBlendGrid, TerraBox, TerraBoxImage, TerraCircleWarp, TerraClampWeight, TerraCrater, TerraCubic, TerraCubicImage, TerraCurveThick, TerraDisc, TerraDiscCut, TerraDiscNoise, TerraDunes, TerraFrame, TerraGrid, TerraHighest, TerraLowest, TerraOcean, TerraPlateau, TerraQuadrangleImage, TerraReplace, TerraScale, TerraSmooth, TerraSub, TerraTranslate, TerraTwist, TerraVertex, TerraVertexImage, TerraVertexNoise, TerraVertexNoiseRydge, and TerraWarpNoise.

Referenced by Add(), Alpha(), Blend(), Elevation(), and TerraGrid::ElevationAlpha().

Gradient()

Vector2 TerraNode::Gradient ( const Vector2 & p ) const

virtual

Compute the gradient at a given position.

Parameters

p

Point.

References Elevation(), and epsilon.

Referenced by Normal().

Normal()

Vector TerraNode::Normal ( const Vector2 & p ) const

virtual

Compute the normal at a given position.

See also

TerraNode::Gradient

Parameters

p

Point.

References Gradient().

Sample()

ScalarField2 TerraNode::Sample

(

const Array2 &

a

)

const

Create a discrete scalar field by sampling the elevation over a given domain.

Parameters

a

Domain.

References Array2::ArrayVertex(), Elevation(), Array2::GetSizeX(), and Array2::GetSizeY().

Traversal()

int TerraNode::Traversal ( const Vector2 & p ) const

virtual

Compute the number of nodes that are traversed when evaluating the tree.

Parameters

p

Point.

Reimplemented in TerraAddNoise, TerraBinary, TerraBlend, TerraPrimitive, and TerraUnary.