Inheritance diagram for osgTerrain::Layer:

[legend]

Public Member Functions
	Layer ()

	Layer (const Layer &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Object (osgTerrain, Layer)

void	setSetName (const std::string &setname)
	Set the name of this layer. More...

const std::string &	getSetName () const
	Get the name of this layer. More...

virtual void	setFileName (const std::string &filename)
	Set the file name of the data associated with this layer. More...

virtual const std::string &	getFileName () const
	Get the file name of the layer. More...

std::string	getCompoundName () const
	Return the compound name of the layer in the form set::name::filename string. More...

void	setLocator (Locator *locator)

template<class T >
void	setLocator (const osg::ref_ptr< T > &locator)

Locator *	getLocator ()

const Locator *	getLocator () const

void	setMinLevel (unsigned int minLevel)

unsigned int	getMinLevel () const

void	setMaxLevel (unsigned int maxLevel)

unsigned int	getMaxLevel () const

void	setValidDataOperator (ValidDataOperator *validDataOp)
	Set the data validation operator. More...

ValidDataOperator *	getValidDataOperator ()
	Get the data validation operator. More...

const ValidDataOperator *	getValidDataOperator () const
	Get the const data validation operator. More...

virtual unsigned int	getNumColumns () const
	Get the number of columns. More...

virtual unsigned int	getNumRows () const
	Get the number of rows. More...

void	setDefaultValue (const osg::Vec4 &value)

const osg::Vec4 &	getDefaultValue () const

void	setMinFilter (osg::Texture::FilterMode filter)
	Set the minification texture filter to use when a texture is associated with this layer. More...

osg::Texture::FilterMode	getMinFilter () const
	Get the minification texture filter to use when a texture is associated with this layer. More...

void	setMagFilter (osg::Texture::FilterMode filter)
	Set the magnification texture filter to use when a texture is associated with this layer. More...

osg::Texture::FilterMode	getMagFilter () const
	Get the magnification texture filter to use when a texture is associated with this layer. More...

virtual osg::Image *	getImage ()
	Return image associated with layer if supported. More...

virtual const osg::Image *	getImage () const
	Return const image associated with layer if supported. More...

virtual bool	transform (float, float)

virtual bool	getValue (unsigned int, unsigned int, float &) const
	Get the layer value at position i,j. More...

virtual bool	getValue (unsigned int, unsigned int, osg::Vec2 &) const

virtual bool	getValue (unsigned int, unsigned int, osg::Vec3 &) const

virtual bool	getValue (unsigned int, unsigned int, osg::Vec4 &) const

bool	getValidValue (unsigned int i, unsigned int j, float &value) const

bool	getValidValue (unsigned int i, unsigned int j, osg::Vec2 &value) const

bool	getValidValue (unsigned int i, unsigned int j, osg::Vec3 &value) const

bool	getValidValue (unsigned int i, unsigned int j, osg::Vec4 &value) const

void	computeIndices (double ndc_x, double ndc_y, unsigned int &i, unsigned int &j, double &ir, double &jr)
	Compute column,row indices from normalized coordinates. More...

bool	getInterpolatedValue (double ndc_x, double ndc_y, float &value)
	Calculate the interpolated layer value at the given normalized coordinates. More...

bool	getInterpolatedValidValue (double ndc_x, double ndc_y, float &value)

virtual void	dirty ()
	increment the modified count. More...

virtual void	setModifiedCount (unsigned int)
	Set the modified count value. More...

virtual unsigned int	getModifiedCount () const
	Get modified count value. More...

virtual osg::BoundingSphere	computeBound (bool treatAsElevationLayer) const

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0
	return the name of the object's library. More...

virtual const char *	className () const =0
	return the name of the object's class type. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Member Functions
virtual	~Layer ()

Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes
std::string	_filename

osg::ref_ptr< Locator >	_locator

unsigned int	_minLevel

unsigned int	_maxLevel

osg::ref_ptr< ValidDataOperator >	_validDataOperator

osg::Vec4	_defaultValue

osg::Texture::FilterMode	_minFilter

osg::Texture::FilterMode	_magFilter

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Constructor & Destructor Documentation

osgTerrain::Layer::Layer ( )

osgTerrain::Layer::Layer	(	const Layer &	,
		const osg::CopyOp &	copyop = `osg::CopyOp::SHALLOW_COPY`
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgTerrain::Layer::~Layer ( )

protectedvirtual

Member Function Documentation

virtual osg::BoundingSphere osgTerrain::Layer::computeBound ( bool treatAsElevationLayer ) const

virtual

Reimplemented in osgTerrain::ProxyLayer.

void osgTerrain::Layer::computeIndices	(	double	ndc_x,
		double	ndc_y,
		unsigned int &	i,
		unsigned int &	j,
		double &	ir,
		double &	jr
	)

inline

Compute column,row indices from normalized coordinates.

Parameters

[in]	ndc_x	Normalized X-axis coordinate.
[in]	ndc_y	Normalized Y-axis coordinate.
[out]	i	Returned X-axis (or column) index.
[out]	j	Returned Y-axis (or row) index.
[out]	ir	Returned X-axis fraction.
[out]	jr	Returned Y-axis fraction.

virtual void osgTerrain::Layer::dirty ( )

inlinevirtual

increment the modified count.

"

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

std::string osgTerrain::Layer::getCompoundName ( ) const

inline

Return the compound name of the layer in the form set::name::filename string.

const osg::Vec4& osgTerrain::Layer::getDefaultValue ( ) const

inline

virtual const std::string& osgTerrain::Layer::getFileName ( ) const

inlinevirtual

Get the file name of the layer.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, and osgTerrain::ImageLayer.

virtual osg::Image* osgTerrain::Layer::getImage ( )

inlinevirtual

Return image associated with layer if supported.

Reimplemented in osgTerrain::SwitchLayer, osgTerrain::ProxyLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual const osg::Image* osgTerrain::Layer::getImage ( ) const

inlinevirtual

Return const image associated with layer if supported.

Reimplemented in osgTerrain::SwitchLayer, osgTerrain::ProxyLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

bool osgTerrain::Layer::getInterpolatedValidValue	(	double	ndc_x,
		double	ndc_y,
		float &	value
	)

inline

bool osgTerrain::Layer::getInterpolatedValue	(	double	ndc_x,
		double	ndc_y,
		float &	value
	)

inline

Calculate the interpolated layer value at the given normalized coordinates.

Parameters

[in]	ndc_x	Normalized X-axis coordinate.
[in]	ndc_y	Normalized Y-axis coordinate.
[out]	value	Returned layer value.

Returns: true if value is valid, else false

Locator* osgTerrain::Layer::getLocator ( )

inline

const Locator* osgTerrain::Layer::getLocator ( ) const

inline

osg::Texture::FilterMode osgTerrain::Layer::getMagFilter ( ) const

inline

Get the magnification texture filter to use when a texture is associated with this layer.

unsigned int osgTerrain::Layer::getMaxLevel ( ) const

inline

osg::Texture::FilterMode osgTerrain::Layer::getMinFilter ( ) const

inline

Get the minification texture filter to use when a texture is associated with this layer.

unsigned int osgTerrain::Layer::getMinLevel ( ) const

inline

virtual unsigned int osgTerrain::Layer::getModifiedCount ( ) const

inlinevirtual

Get modified count value.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual unsigned int osgTerrain::Layer::getNumColumns ( ) const

inlinevirtual

Get the number of columns.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual unsigned int osgTerrain::Layer::getNumRows ( ) const

inlinevirtual

Get the number of rows.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

const std::string& osgTerrain::Layer::getSetName ( ) const

inline

Get the name of this layer.

ValidDataOperator* osgTerrain::Layer::getValidDataOperator ( )

inline

Get the data validation operator.

const ValidDataOperator* osgTerrain::Layer::getValidDataOperator ( ) const

inline

Get the const data validation operator.

bool osgTerrain::Layer::getValidValue	(	unsigned int	i,
		unsigned int	j,
		float &	value
	)		const

inline

bool osgTerrain::Layer::getValidValue	(	unsigned int	i,
		unsigned int	j,
		osg::Vec2 &	value
	)		const

inline

bool osgTerrain::Layer::getValidValue	(	unsigned int	i,
		unsigned int	j,
		osg::Vec3 &	value
	)		const

inline

bool osgTerrain::Layer::getValidValue	(	unsigned int	i,
		unsigned int	j,
		osg::Vec4 &	value
	)		const

inline

virtual bool osgTerrain::Layer::getValue	(	unsigned int	,
		unsigned int	,
		float &
	)		const

inlinevirtual

Get the layer value at position i,j.

Parameters

[in]	i	X-axis (or column) index.
[in]	j	Y-axis (or row) index.
[out]	value	Returned layer value.

Returns: true if value is valid, else false

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual bool osgTerrain::Layer::getValue	(	unsigned int	,
		unsigned int	,
		osg::Vec2 &
	)		const

inlinevirtual

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual bool osgTerrain::Layer::getValue	(	unsigned int	,
		unsigned int	,
		osg::Vec3 &
	)		const

inlinevirtual

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

virtual bool osgTerrain::Layer::getValue	(	unsigned int	,
		unsigned int	,
		osg::Vec4 &
	)		const

inlinevirtual

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

osgTerrain::Layer::META_Object	(	osgTerrain	,
		Layer
	)

void osgTerrain::Layer::setDefaultValue ( const osg::Vec4 & value )

inline

virtual void osgTerrain::Layer::setFileName ( const std::string & filename )

inlinevirtual

Set the file name of the data associated with this layer.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, and osgTerrain::ImageLayer.

void osgTerrain::Layer::setLocator ( Locator * locator )

inline

template<class T >

void osgTerrain::Layer::setLocator ( const osg::ref_ptr< T > & locator )

inline

void osgTerrain::Layer::setMagFilter ( osg::Texture::FilterMode filter )

inline

Set the magnification texture filter to use when a texture is associated with this layer.

void osgTerrain::Layer::setMaxLevel ( unsigned int maxLevel )

inline

void osgTerrain::Layer::setMinFilter ( osg::Texture::FilterMode filter )

inline

Set the minification texture filter to use when a texture is associated with this layer.

void osgTerrain::Layer::setMinLevel ( unsigned int minLevel )

inline

virtual void osgTerrain::Layer::setModifiedCount ( unsigned int )

inlinevirtual

Set the modified count value.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

void osgTerrain::Layer::setSetName ( const std::string & setname )

inline

Set the name of this layer.

void osgTerrain::Layer::setValidDataOperator ( ValidDataOperator * validDataOp )

inline

Set the data validation operator.

virtual bool osgTerrain::Layer::transform	(	float	,
		float
	)

inlinevirtual

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

Member Data Documentation

osg::Vec4 osgTerrain::Layer::_defaultValue

protected

std::string osgTerrain::Layer::_filename

protected

osg::ref_ptr<Locator> osgTerrain::Layer::_locator

protected

osg::Texture::FilterMode osgTerrain::Layer::_magFilter

protected

unsigned int osgTerrain::Layer::_maxLevel

protected

osg::Texture::FilterMode osgTerrain::Layer::_minFilter

protected

unsigned int osgTerrain::Layer::_minLevel

protected

osg::ref_ptr<ValidDataOperator> osgTerrain::Layer::_validDataOperator

protected

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

osgTerrain/Layer

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation