FGSurface Class Reference

Detailed Description

Base class for all surface properties.

Author

Erik M. Hofman

Definition at line 62 of file FGSurface.h.

#include <FGSurface.h>

Inheritance diagram for FGSurface:

Public Member Functions
	FGSurface (FGFDMExec *fdmex)
	Constructor.
void	bind (FGPropertyManager *pm)
double	GetBumpHeight ()
	Returns the height of the bump at the provided offset.
double	GetBumpiness (void)
	Gets the normalized bumpiness factor associated with the surface.
double	GetMaximumForce (void)
	Gets the maximum force of the surface area.
double	GetRollingFFactor (void)
	Gets the rolling friction factor of the surface area.
bool	GetSolid (void)
	Gets the surface is a solid flag value.
double	GetStaticFFactor (void)
	Gets the static friction factor of the surface area.
void	resetValues (void)
	Reset all surface values to a default.
void	SetBumpiness (double bump)
	Sets the normalized bumpiness factor associated with the surface.
void	SetMaximumForce (double force)
	Sets the maximum force for the surface area.
void	SetPosition (const double pt[3])
	Set the currect position for bumpiness calulcation.
void	SetRollingFFactor (double friction)
	Sets the rolling friction factor of the surface area.
void	SetSolid (bool solid)
	Sets the surface is a solid flag value.
void	SetStaticFFactor (double friction)
	Sets the static friction factor of the surface area.

Protected Attributes
double	bumpiness
bool	isSolid
double	maximumForce
double	rollingFFactor
double	staticFFactor

Constructor & Destructor Documentation

FGSurface()

FGSurface

(

FGFDMExec *

fdmex

)

Constructor.

Definition at line 52 of file FGSurface.cpp.

{
  resetValues();
}

Here is the call graph for this function:

Member Function Documentation

bind()

void bind

(

FGPropertyManager *

pm

)

Definition at line 73 of file FGSurface.cpp.

{
  string base_property_name = "ground";
  string property_name;
 
  property_name = base_property_name + "/solid";
  PropertyManager->Tie( property_name.c_str(), &isSolid);
  property_name = base_property_name + "/bumpiness";
  PropertyManager->Tie( property_name.c_str(), &bumpiness);
  property_name = base_property_name + "/maximum-force-lbs";
  PropertyManager->Tie( property_name.c_str(), &maximumForce);
  property_name = base_property_name + "/rolling_friction-factor";
  PropertyManager->Tie( property_name.c_str(), &rollingFFactor);
  property_name = base_property_name + "/static-friction-factor";
  PropertyManager->Tie( property_name.c_str(), &staticFFactor);
}

GetBumpHeight()

double GetBumpHeight

(

)

Returns the height of the bump at the provided offset.

Definition at line 92 of file FGSurface.cpp.

{
  if (bumpiness < 0.001) return 0.0f;
 
  double x = pos[0]*0.1;
  double y = pos[1]*0.1;
  x -= floor(x);
  y -= floor(y);
  x *= 2*M_PI;
  y *= 2*M_PI;
  //now x and y are in the range of 0..2pi
  //we need a function, that is periodically on 2pi and gives some
  //height. This is not very fast, but for a beginning.
  //maybe this should be done by interpolating between some precalculated
  //values
  static const double maxGroundBumpAmplitude=0.4;
  double h = sin(x)+sin(7*x)+sin(8*x)+sin(13*x);
  h += sin(2*y)+sin(5*y)+sin(9*y*x)+sin(17*y);
 
  return h*(1/8.)*bumpiness*maxGroundBumpAmplitude;
}

Here is the caller graph for this function:

GetBumpiness()

double GetBumpiness ( void  )

inline

Gets the normalized bumpiness factor associated with the surface.

Definition at line 104 of file FGSurface.h.

{ return bumpiness; }

Here is the caller graph for this function:

GetMaximumForce()

double GetMaximumForce ( void  )

inline

Gets the maximum force of the surface area.

Definition at line 101 of file FGSurface.h.

{ return maximumForce; }

Here is the caller graph for this function:

GetRollingFFactor()

double GetRollingFFactor ( void  )

inline

Gets the rolling friction factor of the surface area.

Definition at line 98 of file FGSurface.h.

{ return rollingFFactor; }

Here is the caller graph for this function:

GetSolid()

bool GetSolid ( void  )

inline

Gets the surface is a solid flag value.

Definition at line 107 of file FGSurface.h.

{ return isSolid; }

Here is the caller graph for this function:

GetStaticFFactor()

double GetStaticFFactor ( void  )

inline

Gets the static friction factor of the surface area.

Definition at line 95 of file FGSurface.h.

{ return staticFFactor; }

Here is the caller graph for this function:

resetValues()

void resetValues

(

void

)

Reset all surface values to a default.

Definition at line 59 of file FGSurface.cpp.

{
  staticFFactor = 1.0;
  rollingFFactor = 1.0;
  maximumForce = DBL_MAX;
  bumpiness = 0.0;
  isSolid = true;
  pos[0] = 0.0;
  pos[1] = 0.0;
  pos[2] = 0.0;
}

Here is the caller graph for this function:

SetBumpiness()

void SetBumpiness ( double  bump )

inline

Sets the normalized bumpiness factor associated with the surface.

Definition at line 83 of file FGSurface.h.

{ bumpiness = bump; }

SetMaximumForce()

void SetMaximumForce ( double  force )

inline

Sets the maximum force for the surface area.

Definition at line 80 of file FGSurface.h.

{ maximumForce = force; }

SetPosition()

void SetPosition ( const double  pt[3] )

inline

Set the currect position for bumpiness calulcation.

Definition at line 89 of file FGSurface.h.

                                       {
      pos[0] = pt[0]; pos[1] = pt[1]; pos[2] = pt[2];
  }

SetRollingFFactor()

void SetRollingFFactor ( double  friction )

inline

Sets the rolling friction factor of the surface area.

Definition at line 77 of file FGSurface.h.

{ rollingFFactor = friction; }

SetSolid()

void SetSolid ( bool  solid )

inline

Sets the surface is a solid flag value.

Definition at line 86 of file FGSurface.h.

{ isSolid = solid; }

SetStaticFFactor()

void SetStaticFFactor ( double  friction )

inline

Sets the static friction factor of the surface area.

Definition at line 74 of file FGSurface.h.

{ staticFFactor = friction; }

Member Data Documentation

bumpiness

double bumpiness

protected

Definition at line 115 of file FGSurface.h.

isSolid

bool isSolid

protected

Definition at line 116 of file FGSurface.h.

maximumForce

double maximumForce

protected

Definition at line 114 of file FGSurface.h.

rollingFFactor

double rollingFFactor

protected

Definition at line 113 of file FGSurface.h.

staticFFactor

double staticFFactor

protected

Definition at line 113 of file FGSurface.h.

---

The documentation for this class was generated from the following files:

• FGSurface.h
• FGSurface.cpp