---

osg::GrabForegroundBase Class Reference

GrabForeground Base Class. More...

#include <OSGGrabForegroundBase.h>

Inheritance diagram for osg::GrabForegroundBase:

[legend]Collaboration diagram for osg::GrabForegroundBase:

[legend]List of all members.

Public Types
enum	{ ImageFieldId = Inherited::NextFieldId, NextFieldId = ImageFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
SFImageP *	getSFImage (void)
ImageP &	getImage (void)
const ImageP &	getImage (void) const
Field Set
void	setImage (const ImageP &value)
Sync
virtual void	executeSync (FieldContainer &other, const BitVector &whichField)
Binary Access
virtual UInt32	getBinSize (const BitVector &whichField)
virtual void	copyToBin (BinaryDataHandler &pMem, const BitVector &whichField)
virtual void	copyFromBin (BinaryDataHandler &pMem, const BitVector &whichField)
Copy
virtual FieldContainerPtr	shallowCopy (void) const
Static Public Methods
Class Get
FieldContainerType &	getClassType (void)
	access the type of the class
UInt32	getClassTypeId (void)
	access the numerical type of the class
Construction
GrabForegroundPtr	create (void)
	create a new instance of the class
GrabForegroundPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	ImageFieldMask
Protected Methods
Constructors
	GrabForegroundBase (void)
	Constructor.
	GrabForegroundBase (const GrabForegroundBase &source)
	Copy Constructor.
Destructors
virtual	~GrabForegroundBase (void)
	Destructor.
Sync
void	executeSyncImpl (GrabForegroundBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
SFImageP	_sfImage
Private Types
typedef Foreground	Inherited
Private Methods
void	operator= (const GrabForegroundBase &source)
Static Private Attributes
FieldDescription *	_desc []
	GrabForeground description.
FieldContainerType	_type
	GrabForeground type.
Friends
class	FieldContainer

---

Detailed Description

GrabForeground Base Class.

---

Member Typedef Documentation

typedef Foreground osg::GrabForegroundBase::Inherited [private]

Reimplemented from osg::Foreground. Reimplemented in osg::FileGrabForeground, osg::FileGrabForegroundBase, and osg::GrabForeground.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: ImageFieldId  NextFieldId

---

Constructor & Destructor Documentation

GrabForegroundBase::GrabForegroundBase (  void    )  [protected]

Constructor.

GrabForegroundBase::GrabForegroundBase (  const GrabForegroundBase &    source )  [protected]

Copy Constructor.

GrabForegroundBase::~GrabForegroundBase (  void    )  [protected, virtual]

Destructor.

---

Member Function Documentation

osg::FieldContainerType & osg::GrabForegroundBase::getClassType (  void    )  [inline, static]

access the type of the class Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

osg::UInt32 osg::GrabForegroundBase::getClassTypeId (  void    )  [inline, static]

access the numerical type of the class Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

FieldContainerType & GrabForegroundBase::getType (  void    )  [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

const FieldContainerType & GrabForegroundBase::getType (  void    )  const [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

UInt32 GrabForegroundBase::getContainerSize (  void    )  const [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

SFImageP * osg::GrabForegroundBase::getSFImage (  void    )  [inline]

ImageP & osg::GrabForegroundBase::getImage (  void    )  [inline]

const ImageP & osg::GrabForegroundBase::getImage (  void    )  const [inline]

void osg::GrabForegroundBase::setImage (  const ImageP &    value )  [inline]

void GrabForegroundBase::executeSync (  FieldContainer &    other, const BitVector &    whichField )  [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

UInt32 GrabForegroundBase::getBinSize (  const BitVector &    whichField )  [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

void GrabForegroundBase::copyToBin (  BinaryDataHandler &    pMem, const BitVector &    whichField )  [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

void GrabForegroundBase::copyFromBin (  BinaryDataHandler &    pMem, const BitVector &    whichField )  [virtual]

Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

GrabForegroundPtr osg::GrabForegroundBase::create (  void    )  [inline, static]

create a new instance of the class Reimplemented in osg::FileGrabForegroundBase.

GrabForegroundPtr osg::GrabForegroundBase::createEmpty (  void    )  [inline, static]

create an empty new instance of the class, do not copy the prototype Reimplemented in osg::FileGrabForegroundBase.

FieldContainerPtr GrabForegroundBase::shallowCopy (  void    )  const [virtual]

Implements osg::FieldContainer. Reimplemented in osg::FileGrabForegroundBase.

void GrabForegroundBase::executeSyncImpl (  GrabForegroundBase *    pOther, const BitVector &    whichField )  [protected]

void osg::GrabForegroundBase::operator= (  const GrabForegroundBase &    source )  [private]

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::Foreground. Reimplemented in osg::FileGrabForeground, osg::FileGrabForegroundBase, and osg::GrabForeground.

---

Member Data Documentation

const osg::BitVector GrabForegroundBase::ImageFieldMask [static]

Initial value: (1 << GrabForegroundBase::ImageFieldId)

ImageP GrabForegroundBase::_sfImage [protected]

The image to write to.

FieldDescription * GrabForegroundBase::_desc [static, private]

Initial value: { new FieldDescription(SFImageP::getClassType(), "image", ImageFieldId, ImageFieldMask, false, (FieldAccessMethod) &GrabForegroundBase::getSFImage) } GrabForeground description. Reimplemented from osg::AttachmentContainer. Reimplemented in osg::FileGrabForegroundBase.

FieldContainerType GrabForegroundBase::_type [static, private]

GrabForeground type. Reimplemented from osg::ForegroundBase. Reimplemented in osg::FileGrabForegroundBase.

---

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

• OSGGrabForegroundBase.h
• OSGGrabForegroundBase.cpp
• OSGGrabForegroundBase.inl

---