osg::DrawPixels Class Reference

#include <DrawPixels.h>

Inheritance diagram for osg::DrawPixels:

Collaboration 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	computeBoundingBox () const
Public Member Functions inherited from osg::Drawable
	Drawable ()
	Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_Node (osg, Drawable)
virtual Drawable *	asDrawable ()
virtual const Drawable *	asDrawable () const
virtual void	computeDataVariance ()
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void	setInitialBound (const osg::BoundingBox &bbox)
const BoundingBox &	getInitialBound () const
const BoundingSphere &	getBound () const
const BoundingBox &	getBoundingBox () const
virtual BoundingSphere	computeBound () 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	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::Node
	Node ()
	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual Geometry *	asGeometry ()
virtual const Geometry *	asGeometry () const
virtual Group *	asGroup ()
virtual const Group *	asGroup () const
virtual Transform *	asTransform ()
virtual const Transform *	asTransform () const
virtual Camera *	asCamera ()
virtual const Camera *	asCamera () const
virtual Switch *	asSwitch ()
virtual const Switch *	asSwitch () const
virtual Geode *	asGeode ()
virtual const Geode *	asGeode () const
virtual osgTerrain::Terrain *	asTerrain ()
virtual const osgTerrain::Terrain *	asTerrain () const
virtual void	accept (NodeVisitor &nv)
virtual void	ascend (NodeVisitor &nv)
virtual void	traverse (NodeVisitor &)
const ParentList &	getParents () const
ParentList	getParents ()
Group *	getParent (unsigned int i)
const Group *	getParent (unsigned int i) const
unsigned int	getNumParents () const
NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void	setUpdateCallback (Callback *nc)
Callback *	getUpdateCallback ()
const Callback *	getUpdateCallback () const
void	addUpdateCallback (Callback *nc)
void	removeUpdateCallback (Callback *nc)
unsigned int	getNumChildrenRequiringUpdateTraversal () const
void	setEventCallback (Callback *nc)
Callback *	getEventCallback ()
const Callback *	getEventCallback () const
void	addEventCallback (Callback *nc)
void	removeEventCallback (Callback *nc)
unsigned int	getNumChildrenRequiringEventTraversal () const
void	setCullCallback (Callback *nc)
Callback *	getCullCallback ()
const Callback *	getCullCallback () const
void	addCullCallback (Callback *nc)
void	removeCullCallback (Callback *nc)
void	setCullingActive (bool active)
bool	getCullingActive () const
unsigned int	getNumChildrenWithCullingDisabled () const
bool	isCullingActive () const
unsigned int	getNumChildrenWithOccluderNodes () const
bool	containsOccluderNodes () const
void	setNodeMask (NodeMask nm)
NodeMask	getNodeMask () const
void	setStateSet (osg::StateSet *stateset)
osg::StateSet *	getOrCreateStateSet ()
osg::StateSet *	getStateSet ()
const osg::StateSet *	getStateSet () const
void	setDescriptions (const DescriptionList &descriptions)
DescriptionList &	getDescriptions ()
const DescriptionList &	getDescriptions () const
const std::string &	getDescription (unsigned int i) const
std::string &	getDescription (unsigned int i)
unsigned int	getNumDescriptions () const
void	addDescription (const std::string &desc)
void	setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSphere &	getInitialBound () const
void	dirtyBound ()
const BoundingSphere &	getBound () const
void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string	getCompoundClassName () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
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 BoundingBoxdValueObject BoundingSpheredValueObject 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
Protected Member Functions inherited from osg::Node
virtual	~Node ()
void	addParent (osg::Group *parent)
void	removeParent (osg::Group *parent)
void	setNumChildrenRequiringUpdateTraversal (unsigned int num)
void	setNumChildrenRequiringEventTraversal (unsigned int num)
void	setNumChildrenWithCullingDisabled (unsigned int num)
void	setNumChildrenWithOccluderNodes (unsigned int num)
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
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 >	_drawableUpdateCallback
ref_ptr< EventCallback >	_drawableEventCallback
ref_ptr< CullCallback >	_drawableCullCallback
ref_ptr< DrawCallback >	_drawCallback
Protected Attributes inherited from osg::Node
BoundingSphere	_initialBound
ref_ptr < ComputeBoundingSphereCallback >	_computeBoundCallback
BoundingSphere	_boundingSphere
bool	_boundingSphereComputed
ParentList	_parents
ref_ptr< Callback >	_updateCallback
unsigned int	_numChildrenRequiringUpdateTraversal
ref_ptr< Callback >	_eventCallback
unsigned int	_numChildrenRequiringEventTraversal
ref_ptr< Callback >	_cullCallback
bool	_cullingActive
unsigned int	_numChildrenWithCullingDisabled
unsigned int	_numChildrenWithOccluderNodes
NodeMask	_nodeMask
ref_ptr< StateSet >	_stateset
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 unsigned int	AttributeType
Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList
typedef unsigned int	NodeMask
typedef std::vector< std::string >	DescriptionList
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 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.

Definition at line 25 of file DrawPixels.h.

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 node's class type.

Reimplemented from osg::Node.

Definition at line 41 of file DrawPixels.h.

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

inlinevirtual

return a clone of a node, with Object* return type.

Reimplemented from osg::Node.

Definition at line 36 of file DrawPixels.h.

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

inlinevirtual

clone an object of the same type as the node.

Reimplemented from osg::Node.

Definition at line 34 of file DrawPixels.h.

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

virtual

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

virtual void osg::DrawPixels::drawImplementation ( 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.

Reimplemented from osg::Drawable.

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

inline

Definition at line 51 of file DrawPixels.h.

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

inline

Definition at line 52 of file DrawPixels.h.

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

inline

Definition at line 46 of file DrawPixels.h.

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

inline

Definition at line 47 of file DrawPixels.h.

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

bool osg::DrawPixels::getUseSubImage ( ) const

inline

Definition at line 55 of file DrawPixels.h.

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

inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

Definition at line 38 of file DrawPixels.h.

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

inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

Definition at line 40 of file DrawPixels.h.

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

inlineprotected

Definition at line 66 of file DrawPixels.h.

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

inline

Definition at line 49 of file DrawPixels.h.

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

Definition at line 54 of file DrawPixels.h.

Member Data Documentation

unsigned int osg::DrawPixels::_height

protected

Definition at line 74 of file DrawPixels.h.

ref_ptr<Image> osg::DrawPixels::_image

protected

Definition at line 71 of file DrawPixels.h.

unsigned int osg::DrawPixels::_offsetX

protected

Definition at line 74 of file DrawPixels.h.

unsigned int osg::DrawPixels::_offsetY

protected

Definition at line 74 of file DrawPixels.h.

Vec3 osg::DrawPixels::_position

protected

Definition at line 70 of file DrawPixels.h.

bool osg::DrawPixels::_useSubImage

protected

Definition at line 73 of file DrawPixels.h.

unsigned int osg::DrawPixels::_width

protected

Definition at line 74 of file DrawPixels.h.

---

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

• osg_head/include/osg/DrawPixels.h