AnalyticHeightField Class Reference

A base two-dimensional analytic field of real values. More...

#include <analyticfield.h>

Inheritance diagram for AnalyticHeightField:

Public Member Functions
	AnalyticHeightField ()
	Empty.
virtual double	Height (const Vector2 &) const
	Compute elevation at a given point.
virtual Vector	Normal (const Vector2 &) const
	Compute the normal to the field.
HeightField	CreateHeightField (const Box2 &, int, int) const
	Create a HeightField given an input domain.
double	Slope (const Vector2 &) const
	Compute the slope at a given point.
double	AverageSlope (const Vector2 &, int=8) const
	Compute the average slope at a given point.
double	Slope (const Vector2 &, const Vector2 &) const
	Compute the slope in a given direction and at a given point.
QVector< double >	Cross (const Vector2 &, const Vector2 &, int) const
	Compute the elevation along a segment.

Static Public Member Functions
static double	Ridge (const double &, const double &=0.0)
	Ridge function.

Static Protected Attributes
static double	Epsilon = 1e-6
	Epsilon value used for gradient computation.

Detailed Description

A base two-dimensional analytic field of real values.

Member Function Documentation

AverageSlope()

double AnalyticHeightField::AverageSlope	(	const Vector2 &	p,
		int	n = 8 ) const

Compute the average slope at a given point.

Parameters

p	The point.
n	Number of sampling directions.

CreateHeightField()

HeightField AnalyticHeightField::CreateHeightField	(	const Box2 &	box,
		int	nx,
		int	ny ) const

Create a HeightField given an input domain.

Parameters

box	The box.
nx,ny	Resolution.

Cross()

QVector< double > AnalyticHeightField::Cross	(	const Vector2 &	a,
		const Vector2 &	b,
		int	n ) const

Compute the elevation along a segment.

Parameters

a,b	Segment.
n	Number of samples.

Height()

double AnalyticHeightField::Height ( const Vector2 & p ) const

inlinevirtual

Compute elevation at a given point.

Parameters

p

Point.

Normal()

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

virtual

Compute the normal to the field.

Parameters

p

Point.

Ridge()

double AnalyticHeightField::Ridge ( const double & z, const double & r = 0.0 )

inlinestatic

Ridge function.

Parameters

z	Elevation.
r	Ridge elevation.

Slope() [1/2]

double AnalyticHeightField::Slope

(

const Vector2 &

p

)

const

Compute the slope at a given point.

This is the maximum slope, which is the norm of the gradient.

See also

AnalyticHeightField::Gradient()

Parameters

p	The point.

Slope() [2/2]

double AnalyticHeightField::Slope	(	const Vector2 &	p,
		const Vector2 &	d ) const

Compute the slope in a given direction and at a given point.

Parameters

p	The point.
d	Direction (should be normalized).

Member Data Documentation

Epsilon

double AnalyticHeightField::Epsilon = 1e-6

staticprotected

Epsilon value used for gradient computation.

Epsilon value used for all fields.