OSGHeightField Class Reference

Graphical HeightField. More...

#include <osgheightfield.h>

Inheritance diagram for OSGHeightField:

Collaboration diagram for OSGHeightField:

Public Types
enum	CodingMode { Red, Sum, LowMidHigh }
	height coding using in the read in bitmap. More...
Public Types inherited from OSGPrimitive
enum	Quality { Low, Middle, High }

Public Member Functions
	OSGHeightField (osg::HeightField *heightfield, float x_size, float y_size)
	OSGHeightField (const std::string &filename, float x_size, float y_size, float height)
virtual void	setMatrix (const osg::Matrix &matrix)
	Sets the transformation matrix of this object (position and orientation) More...
virtual void	init (const OsgHandle &osgHandle, Quality quality=Middle)
	Initialisation of the primitive. More...
virtual const osg::HeightField *	getHeightField () const
Public Member Functions inherited from OSGPrimitive
	OSGPrimitive ()
virtual	~OSGPrimitive ()
virtual osg::Group *	getGroup ()
	returns the group object which is the root of all subcomponents of this primitive More...
virtual void	setTexture (const std::string &filename)
	assigns a texture to the primitive More...
virtual void	setTexture (const TextureDescr &texture)
	assigns a texture to the primitive, you can choose how often to repeat More...
virtual void	setTexture (int surface, const TextureDescr &texture)
	assigns a texture to the x-th surface of the primitive, you can choose how often to repeat More...
virtual void	setTextures (const std::vector< TextureDescr > &textures)
	assign a set of texture to the surfaces of the primitive More...
virtual std::vector< TextureDescr >	getTextures () const
	returns the list of textures More...
virtual void	setColor (const Color &color)
	sets the color for painting this primitive More...
virtual void	setColor (const std::string &color)
	sets the color using the colorschema of osgHandle More...
virtual Color	getColor ()
	returns the current color More...
virtual osg::Transform *	getTransform ()
	returns a osg transformation object; More...
virtual const OsgHandle &	getOsgHandle ()
	returns the osgHandle object More...

Static Public Member Functions
static osg::HeightField *	loadFromPPM (const std::string &filename, double height, CodingMode codingMode=Red)
	loads an ppm image and returns the height field using the given coding and the height (maximal height of the heightfield) More...
static double	coding (CodingMode mode, const unsigned char *data)
	return the height using the given coding mode. The data pointer points to RGB data point More...

Protected Attributes
osg::HeightField *	field
float	x_size
float	y_size
Protected Attributes inherited from OSGPrimitive
osg::ref_ptr< osg::Geode >	geode
osg::ref_ptr < osg::MatrixTransform >	transform
osg::ref_ptr< osg::ShapeDrawable >	shape
std::vector< TextureDescr >	textures
OsgHandle	osgHandle

Additional Inherited Members
Protected Member Functions inherited from OSGPrimitive
virtual void	applyTextures ()
	this actually sets the textures More...

Detailed Description

Graphical HeightField.

Member Enumeration Documentation

enum CodingMode

height coding using in the read in bitmap.

Red: just the red channel is used; Sum: the sum of all channels is used; HighMidLow: Blue is least significant, Green is medium significant and Red is most significant

Enumerator
Red
Sum
LowMidHigh

Constructor & Destructor Documentation

OSGHeightField	(	osg::HeightField *	heightfield,
		float	x_size,
		float	y_size
	)

OSGHeightField	(	const std::string &	filename,
		float	x_size,
		float	y_size,
		float	height
	)

Member Function Documentation

double coding ( CodingMode  mode, const unsigned char *  data  )

static

return the height using the given coding mode. The data pointer points to RGB data point

virtual const osg::HeightField* getHeightField ( ) const

inlinevirtual

void init ( const OsgHandle &  osgHandle, Quality  quality = Middle  )

virtual

Initialisation of the primitive.

Must in order to place the object into the scene. This function should be overloaded

Implements OSGPrimitive.

HeightField * loadFromPPM ( const std::string &  filename, double  height, CodingMode  codingMode = Red  )

static

loads an ppm image and returns the height field using the given coding and the height (maximal height of the heightfield)

void setMatrix ( const osg::Matrix &  m4x4 )

virtual

Sets the transformation matrix of this object (position and orientation)

Reimplemented from OSGPrimitive.

Member Data Documentation

osg::HeightField* field

protected

float x_size

protected

float y_size

protected

---

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

• osgheightfield.h
• osgheightfield.cpp