---

osg::ImageBackgroundBase Class Reference

ImageBackground Base Class. More...

#include <OSGImageBackgroundBase.h>

Inheritance diagram for osg::ImageBackgroundBase:

[legend]Collaboration diagram for osg::ImageBackgroundBase:

[legend]List of all members.

Public Types
enum	{ ColorFieldId = Inherited::NextFieldId, ImageFieldId = ColorFieldId + 1, ScaleFieldId = ImageFieldId + 1, NextFieldId = ScaleFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
SFColor3f *	getSFColor (void)
SFImageP *	getSFImage (void)
SFBool *	getSFScale (void)
Color3f &	getColor (void)
const Color3f &	getColor (void) const
ImageP &	getImage (void)
const ImageP &	getImage (void) const
bool &	getScale (void)
const bool &	getScale (void) const
Field Set
void	setColor (const Color3f &value)
void	setImage (const ImageP &value)
void	setScale (const bool &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
ImageBackgroundPtr	create (void)
	create a new instance of the class
ImageBackgroundPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	ColorFieldMask
const osg::BitVector	ImageFieldMask
const osg::BitVector	ScaleFieldMask
Protected Methods
Constructors
	ImageBackgroundBase (void)
	Constructor.
	ImageBackgroundBase (const ImageBackgroundBase &source)
	Copy Constructor.
Destructors
virtual	~ImageBackgroundBase (void)
	Destructor.
Sync
void	executeSyncImpl (ImageBackgroundBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
SFColor3f	_sfColor
SFImageP	_sfImage
SFBool	_sfScale
Private Types
typedef Background	Inherited
Private Methods
void	operator= (const ImageBackgroundBase &source)
Static Private Attributes
FieldDescription *	_desc []
	ImageBackground description.
FieldContainerType	_type
	ImageBackground type.
Friends
class	FieldContainer

---

Detailed Description

ImageBackground Base Class.

---

Member Typedef Documentation

typedef Background osg::ImageBackgroundBase::Inherited [private]

Reimplemented from osg::Background. Reimplemented in osg::ImageBackground.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: ColorFieldId  ImageFieldId  ScaleFieldId  NextFieldId

---

Constructor & Destructor Documentation

ImageBackgroundBase::ImageBackgroundBase (  void    )  [protected]

Constructor.

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

Copy Constructor.

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

Destructor.

---

Member Function Documentation

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

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

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

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

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

SFColor3f * osg::ImageBackgroundBase::getSFColor (  void    )  [inline]

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

SFBool * osg::ImageBackgroundBase::getSFScale (  void    )  [inline]

Color3f & osg::ImageBackgroundBase::getColor (  void    )  [inline]

const Color3f & osg::ImageBackgroundBase::getColor (  void    )  const [inline]

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

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

bool & osg::ImageBackgroundBase::getScale (  void    )  [inline]

const bool & osg::ImageBackgroundBase::getScale (  void    )  const [inline]

void osg::ImageBackgroundBase::setColor (  const Color3f &    value )  [inline]

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

void osg::ImageBackgroundBase::setScale (  const bool &    value )  [inline]

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

ImageBackgroundPtr osg::ImageBackgroundBase::create (  void    )  [inline, static]

create a new instance of the class

ImageBackgroundPtr osg::ImageBackgroundBase::createEmpty (  void    )  [inline, static]

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

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

Implements osg::FieldContainer.

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

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

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::Background. Reimplemented in osg::ImageBackground.

---

Member Data Documentation

const osg::BitVector ImageBackgroundBase::ColorFieldMask [static]

Initial value: (1 << ImageBackgroundBase::ColorFieldId)

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

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

const osg::BitVector ImageBackgroundBase::ScaleFieldMask [static]

Initial value: (1 << ImageBackgroundBase::ScaleFieldId)

Color3f ImageBackgroundBase::_sfColor [protected]

The background color for the areas without image.

ImageP ImageBackgroundBase::_sfImage [protected]

The image to put in the background.

bool ImageBackgroundBase::_sfScale [protected]

Define whether the image is scaled to fill the viewport or not (non-functional right now).

FieldDescription * ImageBackgroundBase::_desc [static, private]

Initial value: { new FieldDescription(SFColor3f::getClassType(), "color", ColorFieldId, ColorFieldMask, false, (FieldAccessMethod) &ImageBackgroundBase::getSFColor), new FieldDescription(SFImageP::getClassType(), "image", ImageFieldId, ImageFieldMask, false, (FieldAccessMethod) &ImageBackgroundBase::getSFImage), new FieldDescription(SFBool::getClassType(), "scale", ScaleFieldId, ScaleFieldMask, false, (FieldAccessMethod) &ImageBackgroundBase::getSFScale) } ImageBackground description. Reimplemented from osg::AttachmentContainer.

FieldContainerType ImageBackgroundBase::_type [static, private]

ImageBackground type. Reimplemented from osg::BackgroundBase.

---

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

• OSGImageBackgroundBase.h
• OSGImageBackgroundBase.cpp
• OSGImageBackgroundBase.inl

---