osg::DrawPixels Class Reference

Inheritance diagram for osg::DrawPixels:

Public Member Functions
	DrawPixels ()
	DrawPixels (const DrawPixels &drawimage, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const
virtual Object *	clone (const CopyOp &copyop) const
virtual bool	isSameKindAs (const Object *obj) const
virtual const char *	libraryName () const
virtual const char *	className () const
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
virtual BoundingBox	computeBound () const
Public Member Functions inherited from osg::Drawable
	Drawable ()
	Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Geometry *	asGeometry ()
virtual const Geometry *	asGeometry () const
virtual void	computeDataVariance ()
const ParentList &	getParents () const
ParentList	getParents ()
Node *	getParent (unsigned int i)
const Node *	getParent (unsigned int i) const
unsigned int	getNumParents () const
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void	setStateSet (StateSet *stateset)
StateSet *	getStateSet ()
const StateSet *	getStateSet () const
StateSet *	getOrCreateStateSet ()
void	setInitialBound (const osg::BoundingBox &bbox)
const BoundingBox &	getInitialBound () const
void	dirtyBound ()
const BoundingBox &	getBound () const
void	setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback ()
const ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback () const
void	setShape (Shape *shape)
Shape *	getShape ()
const Shape *	getShape () const
void	setSupportsDisplayList (bool flag)
bool	getSupportsDisplayList () const
void	setUseDisplayList (bool flag)
bool	getUseDisplayList () const
GLuint &	getDisplayList (unsigned int contextID) const
virtual void	setUseVertexBufferObjects (bool flag)
bool	getUseVertexBufferObjects () const
virtual void	dirtyDisplayList ()
virtual unsigned int	getGLObjectSizeHint () const
void	draw (RenderInfo &renderInfo) const
virtual void	compileGLObjects (RenderInfo &renderInfo) const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
virtual void	releaseGLObjects (State *state=0) const
virtual void	setUpdateCallback (UpdateCallback *ac)
UpdateCallback *	getUpdateCallback ()
const UpdateCallback *	getUpdateCallback () const
bool	requiresUpdateTraversal () const
virtual void	setEventCallback (EventCallback *ac)
EventCallback *	getEventCallback ()
const EventCallback *	getEventCallback () const
bool	requiresEventTraversal () const
virtual void	setCullCallback (CullCallback *cc)
CullCallback *	getCullCallback ()
const CullCallback *	getCullCallback () const
virtual void	setDrawCallback (DrawCallback *dc)
DrawCallback *	getDrawCallback ()
const DrawCallback *	getDrawCallback () const
virtual bool	supports (const AttributeFunctor &) const
virtual void	accept (AttributeFunctor &)
virtual bool	supports (const ConstAttributeFunctor &) const
virtual void	accept (ConstAttributeFunctor &) const
virtual bool	supports (const PrimitiveFunctor &) const
virtual void	accept (PrimitiveFunctor &) const
virtual bool	supports (const PrimitiveIndexFunctor &) const
virtual void	accept (PrimitiveIndexFunctor &) const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Protected Member Functions
DrawPixels &	operator= (const DrawPixels &)
virtual	~DrawPixels ()
Protected Member Functions inherited from osg::Drawable
Drawable &	operator= (const Drawable &)
virtual	~Drawable ()
void	setBound (const BoundingBox &bb) const
void	addParent (osg::Node *node)
void	removeParent (osg::Node *node)
void	setNumChildrenRequiringUpdateTraversal (unsigned int num)
unsigned int	getNumChildrenRequiringUpdateTraversal () const
void	setNumChildrenRequiringEventTraversal (unsigned int num)
unsigned int	getNumChildrenRequiringEventTraversal () const
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
Vec3	_position
ref_ptr< Image >	_image
bool	_useSubImage
unsigned int	_offsetX
unsigned int	_offsetY
unsigned int	_width
unsigned int	_height
Protected Attributes inherited from osg::Drawable
ParentList	_parents
ref_ptr< StateSet >	_stateset
BoundingBox	_initialBound
ref_ptr < ComputeBoundingBoxCallback >	_computeBoundCallback
BoundingBox	_boundingBox
bool	_boundingBoxComputed
ref_ptr< Shape >	_shape
bool	_supportsDisplayList
bool	_useDisplayList
bool	_supportsVertexBufferObjects
bool	_useVertexBufferObjects
GLObjectList	_globjList
ref_ptr< UpdateCallback >	_updateCallback
unsigned int	_numChildrenRequiringUpdateTraversal
ref_ptr< EventCallback >	_eventCallback
unsigned int	_numChildrenRequiringEventTraversal
ref_ptr< CullCallback >	_cullCallback
ref_ptr< DrawCallback >	_drawCallback
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::Drawable
enum	AttributeTypes {   VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3,   SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTRIBUTE_6 = 6, ATTRIBUTE_7 = 7,   TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2,   TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6,   TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7 }
typedef std::vector< Node * >	ParentList
typedef unsigned int	AttributeType
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Drawable
static GLuint	generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)
static void	setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
static unsigned int	getMinimumNumberOfDisplayListsToRetainInCache ()
static void	deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
static void	flushAllDeletedDisplayLists (unsigned int contextID)
static void	discardAllDeletedDisplayLists (unsigned int contextID)
static void	flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
static Extensions *	getExtensions (unsigned int contextID, bool createIfNotInitalized)
static void	setExtensions (unsigned int contextID, Extensions *extensions)
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Static Public Attributes inherited from osg::Drawable
static unsigned int	s_numberDrawablesReusedLastInLastFrame
static unsigned int	s_numberNewDrawablesInLastFrame
static unsigned int	s_numberDeletedDrawablesInLastFrame
Protected Types inherited from osg::Drawable
typedef osg::buffered_value < GLuint >	GLObjectList

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 ( )

protectedvirtual

Member Function Documentation

virtual const char* osg::DrawPixels::className ( ) const

inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Reimplemented from osg::Drawable.

virtual Object* osg::DrawPixels::clone ( const CopyOp &  ) const

inlinevirtual

Clone an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

virtual Object* osg::DrawPixels::cloneType ( ) const

inlinevirtual

Clone the type of an object, with Object* return type. Must be defined by derived classes.

Implements osg::Object.

virtual BoundingBox osg::DrawPixels::computeBound ( ) const

virtual

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

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 actual drawing itself.

Parameters

renderInfo

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

Implements osg::Drawable.

osg::Image* osg::DrawPixels::getImage ( )

inline

const osg::Image* osg::DrawPixels::getImage ( ) const

inline

osg::Vec3& osg::DrawPixels::getPosition ( )

inline

const osg::Vec3& osg::DrawPixels::getPosition ( ) const

inline

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

bool osg::DrawPixels::getUseSubImage ( ) const

inline

virtual bool osg::DrawPixels::isSameKindAs ( const Object *  obj ) const

inlinevirtual

Reimplemented from osg::Drawable.

References NULL.

virtual const char* osg::DrawPixels::libraryName ( ) const

inlinevirtual

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.

DrawPixels& osg::DrawPixels::operator= ( const DrawPixels &  )

inlineprotected

void osg::DrawPixels::setImage ( osg::Image *  image )

inline

void osg::DrawPixels::setPosition

(

const osg::Vec3 &

position

)

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

void osg::DrawPixels::setUseSubImage ( bool  useSubImage )

inline

Member Data Documentation

unsigned int osg::DrawPixels::_height

protected

ref_ptr<Image> osg::DrawPixels::_image

protected

unsigned int osg::DrawPixels::_offsetX

protected

unsigned int osg::DrawPixels::_offsetY

protected

Vec3 osg::DrawPixels::_position

protected

bool osg::DrawPixels::_useSubImage

protected

unsigned int osg::DrawPixels::_width

protected

---

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

• DrawPixels