osg::DrawPixels Class Reference

DrawPixels is an osg::Drawable subclass which encapsulates the drawing of images using glDrawPixels. More...

Inheritance diagram for osg::DrawPixels:

[legend]

List of all members.

Public Member Functions
	DrawPixels ()
	DrawPixels (const DrawPixels &drawimage, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
virtual Object *	cloneType () const
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &copyop) const
	Clone an object, with Object* return type.
virtual bool	isSameKindAs (const Object *obj) const
virtual const char *	libraryName () const
	return the name of the object's library.
virtual const char *	className () const
	return the name of the object's class type.
void	setPosition (const osg::Vec3 &position)
osg::Vec3 &	getPosition ()
const osg::Vec3 &	getPosition () const
void	setImage (osg::Image *image)
osg::Image *	getImage ()
const osg::Image *	getImage () const
void	setUseSubImage (bool useSubImage)
bool	getUseSubImage () const
void	setSubImageDimensions (unsigned int offsetX, unsigned int offsetY, unsigned int width, unsigned int height)
void	getSubImageDimensions (unsigned int &offsetX, unsigned int &offsetY, unsigned int &width, unsigned int &height) const
virtual void	drawImplementation (RenderInfo &renderInfo) const
	drawImplementation(RenderInfo&) is a pure virtual method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable.
virtual BoundingBox	computeBound () const
	Compute the bounding box around Drawables's geometry.
Protected Member Functions
DrawPixels &	operator= (const DrawPixels &)
virtual	~DrawPixels ()
Protected Attributes
Vec3	_position
ref_ptr< Image >	_image
bool	_useSubImage
unsigned int	_offsetX
unsigned int	_offsetY
unsigned int	_width
unsigned int	_height

---

Detailed Description

DrawPixels is an osg::Drawable subclass which encapsulates the drawing of images using glDrawPixels.

---

Constructor & Destructor Documentation

osg::DrawPixels::DrawPixels

(

)

osg::DrawPixels::DrawPixels	(	const DrawPixels &	drawimage,
		const CopyOp &	copyop = CopyOp::SHALLOW_COPY
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::DrawPixels::~DrawPixels

(

)

[protected, virtual]

---

Member Function Documentation

virtual Object* osg::DrawPixels::cloneType

(

)

const [inline, virtual]

Clone the type of an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

virtual Object* osg::DrawPixels::clone

(

const CopyOp &

)

const [inline, virtual]

Clone an object, with Object* return type.

Must be defined by derived classes.

Implements osg::Object.

virtual bool osg::DrawPixels::isSameKindAs

(

const Object *

obj

)

const [inline, virtual]

Reimplemented from osg::Drawable.

virtual const char* osg::DrawPixels::libraryName

(

)

const [inline, virtual]

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::Drawable.

virtual const char* osg::DrawPixels::className

(

)

const [inline, virtual]

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::Drawable.

void osg::DrawPixels::setPosition

(

const osg::Vec3 &

position

)

osg::Vec3& osg::DrawPixels::getPosition

(

)

[inline]

const osg::Vec3& osg::DrawPixels::getPosition

(

)

const [inline]

void osg::DrawPixels::setImage

(

osg::Image *

image

)

[inline]

osg::Image* osg::DrawPixels::getImage

(

)

[inline]

const osg::Image* osg::DrawPixels::getImage

(

)

const [inline]

void osg::DrawPixels::setUseSubImage

(

bool

useSubImage

)

[inline]

bool osg::DrawPixels::getUseSubImage

(

)

const [inline]

void osg::DrawPixels::setSubImageDimensions	(	unsigned int	offsetX,
		unsigned int	offsetY,
		unsigned int	width,
		unsigned int	height
	)

void osg::DrawPixels::getSubImageDimensions	(	unsigned int &	offsetX,
		unsigned int &	offsetY,
		unsigned int &	width,
		unsigned int &	height
	)			const

virtual void osg::DrawPixels::drawImplementation

(

RenderInfo &

renderInfo

)

const [virtual]

drawImplementation(RenderInfo&) is a pure virtual method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable.

drawImplementation(RenderInfo&) is called from the draw(RenderInfo&) method, with the draw method handling management of OpenGL display lists, and drawImplementation(RenderInfo&) handling the actuall drawing itself.

Parameters:

renderInfo

The osg::RenderInfo object that encapulates the current rendering information including the osg::State OpenGL state for the current graphics context.

Implements osg::Drawable.

virtual BoundingBox osg::DrawPixels::computeBound

(

)

const [virtual]

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

DrawPixels& osg::DrawPixels::operator=

(

const DrawPixels &

)

[inline, protected]

---

Member Data Documentation

Vec3 osg::DrawPixels::_position [protected]

ref_ptr<Image> osg::DrawPixels::_image [protected]

bool osg::DrawPixels::_useSubImage [protected]

unsigned int osg::DrawPixels::_offsetX [protected]

unsigned int osg::DrawPixels::_offsetY [protected]

unsigned int osg::DrawPixels::_width [protected]

unsigned int osg::DrawPixels::_height [protected]

---

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

• DrawPixels

---