---

osg::SolidBackgroundBase Class Reference

SolidBackground Base Class. More...

#include <OSGSolidBackgroundBase.h>

Inheritance diagram for osg::SolidBackgroundBase:

[legend]Collaboration diagram for osg::SolidBackgroundBase:

[legend]List of all members.

Public Types
enum	{ ColorFieldId = Inherited::NextFieldId, NextFieldId = ColorFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
SFColor3f *	getSFColor (void)
Color3f &	getColor (void)
const Color3f &	getColor (void) const
Field Set
void	setColor (const Color3f &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
SolidBackgroundPtr	create (void)
	create a new instance of the class
SolidBackgroundPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	ColorFieldMask
Protected Methods
Constructors
	SolidBackgroundBase (void)
	Constructor.
	SolidBackgroundBase (const SolidBackgroundBase &source)
	Copy Constructor.
Destructors
virtual	~SolidBackgroundBase (void)
	Destructor.
Sync
void	executeSyncImpl (SolidBackgroundBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
SFColor3f	_sfColor
Private Types
typedef Background	Inherited
Private Methods
void	operator= (const SolidBackgroundBase &source)
Static Private Attributes
FieldDescription *	_desc []
	SolidBackground description.
FieldContainerType	_type
	SolidBackground type.
Friends
class	FieldContainer

---

Detailed Description

SolidBackground Base Class.

---

Member Typedef Documentation

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

Reimplemented from osg::Background. Reimplemented in osg::SolidBackground.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: ColorFieldId  NextFieldId

---

Constructor & Destructor Documentation

SolidBackgroundBase::SolidBackgroundBase (  void    )  [protected]

Constructor.

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

Copy Constructor.

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

Destructor.

---

Member Function Documentation

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

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

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

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

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

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

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

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

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

SolidBackgroundPtr osg::SolidBackgroundBase::create (  void    )  [inline, static]

create a new instance of the class

SolidBackgroundPtr osg::SolidBackgroundBase::createEmpty (  void    )  [inline, static]

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

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

Implements osg::FieldContainer.

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

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

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::Background. Reimplemented in osg::SolidBackground.

---

Member Data Documentation

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

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

Color3f SolidBackgroundBase::_sfColor [protected]

The background color.

FieldDescription * SolidBackgroundBase::_desc [static, private]

Initial value: { new FieldDescription(SFColor3f::getClassType(), "color", ColorFieldId, ColorFieldMask, false, (FieldAccessMethod) &SolidBackgroundBase::getSFColor) } SolidBackground description. Reimplemented from osg::AttachmentContainer.

FieldContainerType SolidBackgroundBase::_type [static, private]

SolidBackground type. Reimplemented from osg::BackgroundBase.

---

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

• OSGSolidBackgroundBase.h
• OSGSolidBackgroundBase.cpp
• OSGSolidBackgroundBase.inl

---