---

osg::ImageForegroundBase Class Reference

ImageForeground Base Class. More...

#include <OSGImageForegroundBase.h>

Inheritance diagram for osg::ImageForegroundBase:

[legend]Collaboration diagram for osg::ImageForegroundBase:

[legend]List of all members.

Public Types
enum	{ ImagesFieldId = Inherited::NextFieldId, PositionsFieldId = ImagesFieldId + 1, NextFieldId = PositionsFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
MFImageP *	getMFImages (void)
MFPnt2f *	getMFPositions (void)
ImageP &	getImages (const UInt32 index)
MFImageP &	getImages (void)
const MFImageP &	getImages (void) const
Pnt2f &	getPositions (const UInt32 index)
MFPnt2f &	getPositions (void)
const MFPnt2f &	getPositions (void) const
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
ImageForegroundPtr	create (void)
	create a new instance of the class
ImageForegroundPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	ImagesFieldMask
const osg::BitVector	PositionsFieldMask
Protected Methods
Constructors
	ImageForegroundBase (void)
	Constructor.
	ImageForegroundBase (const ImageForegroundBase &source)
	Copy Constructor.
Destructors
virtual	~ImageForegroundBase (void)
	Destructor.
Sync
void	executeSyncImpl (ImageForegroundBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
MFImageP	_mfImages
MFPnt2f	_mfPositions
Private Types
typedef Foreground	Inherited
Private Methods
void	operator= (const ImageForegroundBase &source)
Static Private Attributes
FieldDescription *	_desc []
	ImageForeground description.
FieldContainerType	_type
	ImageForeground type.
Friends
class	FieldContainer

---

Detailed Description

ImageForeground Base Class.

---

Member Typedef Documentation

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

Reimplemented from osg::Foreground. Reimplemented in osg::ImageForeground.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: ImagesFieldId  PositionsFieldId  NextFieldId

---

Constructor & Destructor Documentation

ImageForegroundBase::ImageForegroundBase (  void    )  [protected]

Constructor.

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

Copy Constructor.

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

Destructor.

---

Member Function Documentation

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

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

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

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

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

Reimplemented from osg::ForegroundBase.

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

Reimplemented from osg::ForegroundBase.

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

Reimplemented from osg::ForegroundBase.

MFImageP * osg::ImageForegroundBase::getMFImages (  void    )  [inline]

MFPnt2f * osg::ImageForegroundBase::getMFPositions (  void    )  [inline]

ImageP & osg::ImageForegroundBase::getImages (  const UInt32    index )  [inline]

MFImageP & osg::ImageForegroundBase::getImages (  void    )  [inline]

const MFImageP & osg::ImageForegroundBase::getImages (  void    )  const [inline]

Pnt2f & osg::ImageForegroundBase::getPositions (  const UInt32    index )  [inline]

MFPnt2f & osg::ImageForegroundBase::getPositions (  void    )  [inline]

const MFPnt2f & osg::ImageForegroundBase::getPositions (  void    )  const [inline]

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

Reimplemented from osg::ForegroundBase.

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

Reimplemented from osg::ForegroundBase.

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

Reimplemented from osg::ForegroundBase.

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

Reimplemented from osg::ForegroundBase.

ImageForegroundPtr osg::ImageForegroundBase::create (  void    )  [inline, static]

create a new instance of the class

ImageForegroundPtr osg::ImageForegroundBase::createEmpty (  void    )  [inline, static]

create an empty new instance of the class, do not copy the prototype

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

Implements osg::FieldContainer.

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

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

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::Foreground. Reimplemented in osg::ImageForeground.

---

Member Data Documentation

const osg::BitVector ImageForegroundBase::ImagesFieldMask [static]

Initial value: (1 << ImageForegroundBase::ImagesFieldId)

const osg::BitVector ImageForegroundBase::PositionsFieldMask [static]

Initial value: (1 << ImageForegroundBase::PositionsFieldId)

ImageP ImageForegroundBase::_mfImages [protected]

The images to display.

Pnt2f ImageForegroundBase::_mfPositions [protected]

The positions of the images.

FieldDescription * ImageForegroundBase::_desc [static, private]

Initial value: { new FieldDescription(MFImageP::getClassType(), "images", ImagesFieldId, ImagesFieldMask, false, (FieldAccessMethod) &ImageForegroundBase::getMFImages), new FieldDescription(MFPnt2f::getClassType(), "positions", PositionsFieldId, PositionsFieldMask, false, (FieldAccessMethod) &ImageForegroundBase::getMFPositions) } ImageForeground description. Reimplemented from osg::AttachmentContainer.

FieldContainerType ImageForegroundBase::_type [static, private]

ImageForeground type. Reimplemented from osg::ForegroundBase.

---

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

• OSGImageForegroundBase.h
• OSGImageForegroundBase.cpp
• OSGImageForegroundBase.inl

---