osgUtil::CubeMapGenerator Class Reference

This is the base class for cube map generators. More...

Inheritance diagram for osgUtil::CubeMapGenerator:

Public Member Functions
	CubeMapGenerator (int texture_size=64)
	CubeMapGenerator (const CubeMapGenerator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
osg::Image *	getImage (osg::TextureCubeMap::Face face)
const osg::Image *	getImage (osg::TextureCubeMap::Face face) const
void	generateMap (bool use_osg_system=true)
	Generate the six cube images. More...
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
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	~CubeMapGenerator ()
CubeMapGenerator &	operator= (const CubeMapGenerator &)
void	set_pixel (int index, int c, int r, const osg::Vec4 &color)
virtual osg::Vec4	compute_color (const osg::Vec3 &R) const =0
	Override this method to define how colors are computed. More...
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Static Protected Member Functions
static osg::Vec4	vector_to_color (const osg::Vec3 &vec)

Additional Inherited Members
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...
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Detailed Description

This is the base class for cube map generators.

It exposes the necessary interface to access the six generated images; descendants should only override the compute_color() method.

Constructor & Destructor Documentation

osgUtil::CubeMapGenerator::CubeMapGenerator ( int  texture_size = 64 )

explicit

osgUtil::CubeMapGenerator::CubeMapGenerator	(	const CubeMapGenerator &	copy,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

virtual osgUtil::CubeMapGenerator::~CubeMapGenerator ( )

inlineprotectedvirtual

Member Function Documentation

virtual osg::Vec4 osgUtil::CubeMapGenerator::compute_color ( const osg::Vec3 &  R ) const

protectedpure virtual

Override this method to define how colors are computed.

The parameter R is the reflection vector, pointing from the center of the cube. The return value should be the RGBA color associated with that reflection ray.

Implemented in osgUtil::HighlightMapGenerator, osgUtil::HalfWayMapGenerator, and osgUtil::ReflectionMapGenerator.

void osgUtil::CubeMapGenerator::generateMap

(

bool

use_osg_system = true

)

Generate the six cube images.

If use_osg_system is true, then the OSG's coordinate system is used instead of the default OpenGL one.

osg::Image * osgUtil::CubeMapGenerator::getImage ( osg::TextureCubeMap::Face  face )

inline

const osg::Image * osgUtil::CubeMapGenerator::getImage ( osg::TextureCubeMap::Face  face ) const

inline

CubeMapGenerator& osgUtil::CubeMapGenerator::operator= ( const CubeMapGenerator &  )

inlineprotected

void osgUtil::CubeMapGenerator::set_pixel ( int  index, int  c, int  r, const osg::Vec4 &  color  )

inlineprotected

osg::Vec4 osgUtil::CubeMapGenerator::vector_to_color ( const osg::Vec3 &  vec )

inlinestaticprotected

---

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

• osgUtil/CubeMapGenerator