---

osg::SkyBackgroundBase Class Reference

SkyBackground Base Class. More...

#include <OSGSkyBackgroundBase.h>

Inheritance diagram for osg::SkyBackgroundBase:

[legend]Collaboration diagram for osg::SkyBackgroundBase:

[legend]List of all members.

Public Types
enum	{   SkyColorFieldId = Inherited::NextFieldId, SkyAngleFieldId = SkyColorFieldId + 1, GroundColorFieldId = SkyAngleFieldId + 1, GroundAngleFieldId = GroundColorFieldId + 1,   SphereResFieldId = GroundAngleFieldId + 1, BackTextureFieldId = SphereResFieldId + 1, BottomTextureFieldId = BackTextureFieldId + 1, FrontTextureFieldId = BottomTextureFieldId + 1,   LeftTextureFieldId = FrontTextureFieldId + 1, RightTextureFieldId = LeftTextureFieldId + 1, TopTextureFieldId = RightTextureFieldId + 1, NextFieldId = TopTextureFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
MFColor3f *	getMFSkyColor (void)
MFReal32 *	getMFSkyAngle (void)
MFColor3f *	getMFGroundColor (void)
MFReal32 *	getMFGroundAngle (void)
SFUInt32 *	getSFSphereRes (void)
SFTextureChunkPtr *	getSFBackTexture (void)
SFTextureChunkPtr *	getSFBottomTexture (void)
SFTextureChunkPtr *	getSFFrontTexture (void)
SFTextureChunkPtr *	getSFLeftTexture (void)
SFTextureChunkPtr *	getSFRightTexture (void)
SFTextureChunkPtr *	getSFTopTexture (void)
UInt32 &	getSphereRes (void)
const UInt32 &	getSphereRes (void) const
TextureChunkPtr &	getBackTexture (void)
const TextureChunkPtr &	getBackTexture (void) const
TextureChunkPtr &	getBottomTexture (void)
const TextureChunkPtr &	getBottomTexture (void) const
TextureChunkPtr &	getFrontTexture (void)
const TextureChunkPtr &	getFrontTexture (void) const
TextureChunkPtr &	getLeftTexture (void)
const TextureChunkPtr &	getLeftTexture (void) const
TextureChunkPtr &	getRightTexture (void)
const TextureChunkPtr &	getRightTexture (void) const
TextureChunkPtr &	getTopTexture (void)
const TextureChunkPtr &	getTopTexture (void) const
Color3f &	getSkyColor (const UInt32 index)
MFColor3f &	getSkyColor (void)
const MFColor3f &	getSkyColor (void) const
Real32 &	getSkyAngle (const UInt32 index)
MFReal32 &	getSkyAngle (void)
const MFReal32 &	getSkyAngle (void) const
Color3f &	getGroundColor (const UInt32 index)
MFColor3f &	getGroundColor (void)
const MFColor3f &	getGroundColor (void) const
Real32 &	getGroundAngle (const UInt32 index)
MFReal32 &	getGroundAngle (void)
const MFReal32 &	getGroundAngle (void) const
Field Set
void	setSphereRes (const UInt32 &value)
void	setBackTexture (const TextureChunkPtr &value)
void	setBottomTexture (const TextureChunkPtr &value)
void	setFrontTexture (const TextureChunkPtr &value)
void	setLeftTexture (const TextureChunkPtr &value)
void	setRightTexture (const TextureChunkPtr &value)
void	setTopTexture (const TextureChunkPtr &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
SkyBackgroundPtr	create (void)
	create a new instance of the class
SkyBackgroundPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	SkyColorFieldMask
const osg::BitVector	SkyAngleFieldMask
const osg::BitVector	GroundColorFieldMask
const osg::BitVector	GroundAngleFieldMask
const osg::BitVector	SphereResFieldMask
const osg::BitVector	BackTextureFieldMask
const osg::BitVector	BottomTextureFieldMask
const osg::BitVector	FrontTextureFieldMask
const osg::BitVector	LeftTextureFieldMask
const osg::BitVector	RightTextureFieldMask
const osg::BitVector	TopTextureFieldMask
Protected Methods
Constructors
	SkyBackgroundBase (void)
	Constructor.
	SkyBackgroundBase (const SkyBackgroundBase &source)
	Copy Constructor.
Destructors
virtual	~SkyBackgroundBase (void)
	Destructor.
Sync
void	executeSyncImpl (SkyBackgroundBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
MFColor3f	_mfSkyColor
MFReal32	_mfSkyAngle
MFColor3f	_mfGroundColor
MFReal32	_mfGroundAngle
SFUInt32	_sfSphereRes
SFTextureChunkPtr	_sfBackTexture
SFTextureChunkPtr	_sfBottomTexture
SFTextureChunkPtr	_sfFrontTexture
SFTextureChunkPtr	_sfLeftTexture
SFTextureChunkPtr	_sfRightTexture
SFTextureChunkPtr	_sfTopTexture
Private Types
typedef Background	Inherited
Private Methods
void	operator= (const SkyBackgroundBase &source)
Static Private Attributes
FieldDescription *	_desc []
	SkyBackground description.
FieldContainerType	_type
	SkyBackground type.
Friends
class	FieldContainer

---

Detailed Description

SkyBackground Base Class.

---

Member Typedef Documentation

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

Reimplemented from osg::Background. Reimplemented in osg::SkyBackground.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: SkyColorFieldId  SkyAngleFieldId  GroundColorFieldId  GroundAngleFieldId  SphereResFieldId  BackTextureFieldId  BottomTextureFieldId  FrontTextureFieldId  LeftTextureFieldId  RightTextureFieldId  TopTextureFieldId  NextFieldId

---

Constructor & Destructor Documentation

SkyBackgroundBase::SkyBackgroundBase (  void    )  [protected]

Constructor.

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

Copy Constructor.

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

Destructor.

---

Member Function Documentation

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

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

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

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

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

MFColor3f * osg::SkyBackgroundBase::getMFSkyColor (  void    )  [inline]

MFReal32 * osg::SkyBackgroundBase::getMFSkyAngle (  void    )  [inline]

MFColor3f * osg::SkyBackgroundBase::getMFGroundColor (  void    )  [inline]

MFReal32 * osg::SkyBackgroundBase::getMFGroundAngle (  void    )  [inline]

SFUInt32 * osg::SkyBackgroundBase::getSFSphereRes (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFBackTexture (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFBottomTexture (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFFrontTexture (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFLeftTexture (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFRightTexture (  void    )  [inline]

SFTextureChunkPtr * osg::SkyBackgroundBase::getSFTopTexture (  void    )  [inline]

UInt32 & osg::SkyBackgroundBase::getSphereRes (  void    )  [inline]

const UInt32 & osg::SkyBackgroundBase::getSphereRes (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getBackTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getBackTexture (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getBottomTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getBottomTexture (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getFrontTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getFrontTexture (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getLeftTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getLeftTexture (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getRightTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getRightTexture (  void    )  const [inline]

TextureChunkPtr & osg::SkyBackgroundBase::getTopTexture (  void    )  [inline]

const TextureChunkPtr & osg::SkyBackgroundBase::getTopTexture (  void    )  const [inline]

Color3f & osg::SkyBackgroundBase::getSkyColor (  const UInt32    index )  [inline]

MFColor3f & osg::SkyBackgroundBase::getSkyColor (  void    )  [inline]

const MFColor3f & osg::SkyBackgroundBase::getSkyColor (  void    )  const [inline]

Real32 & osg::SkyBackgroundBase::getSkyAngle (  const UInt32    index )  [inline]

MFReal32 & osg::SkyBackgroundBase::getSkyAngle (  void    )  [inline]

const MFReal32 & osg::SkyBackgroundBase::getSkyAngle (  void    )  const [inline]

Color3f & osg::SkyBackgroundBase::getGroundColor (  const UInt32    index )  [inline]

MFColor3f & osg::SkyBackgroundBase::getGroundColor (  void    )  [inline]

const MFColor3f & osg::SkyBackgroundBase::getGroundColor (  void    )  const [inline]

Real32 & osg::SkyBackgroundBase::getGroundAngle (  const UInt32    index )  [inline]

MFReal32 & osg::SkyBackgroundBase::getGroundAngle (  void    )  [inline]

const MFReal32 & osg::SkyBackgroundBase::getGroundAngle (  void    )  const [inline]

void osg::SkyBackgroundBase::setSphereRes (  const UInt32 &    value )  [inline]

void osg::SkyBackgroundBase::setBackTexture (  const TextureChunkPtr &    value )  [inline]

void osg::SkyBackgroundBase::setBottomTexture (  const TextureChunkPtr &    value )  [inline]

void osg::SkyBackgroundBase::setFrontTexture (  const TextureChunkPtr &    value )  [inline]

void osg::SkyBackgroundBase::setLeftTexture (  const TextureChunkPtr &    value )  [inline]

void osg::SkyBackgroundBase::setRightTexture (  const TextureChunkPtr &    value )  [inline]

void osg::SkyBackgroundBase::setTopTexture (  const TextureChunkPtr &    value )  [inline]

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

SkyBackgroundPtr osg::SkyBackgroundBase::create (  void    )  [inline, static]

create a new instance of the class

SkyBackgroundPtr osg::SkyBackgroundBase::createEmpty (  void    )  [inline, static]

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

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

Implements osg::FieldContainer.

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

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

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::Background. Reimplemented in osg::SkyBackground.

---

Member Data Documentation

const osg::BitVector SkyBackgroundBase::SkyColorFieldMask [static]

Initial value: (1 << SkyBackgroundBase::SkyColorFieldId)

const osg::BitVector SkyBackgroundBase::SkyAngleFieldMask [static]

Initial value: (1 << SkyBackgroundBase::SkyAngleFieldId)

const osg::BitVector SkyBackgroundBase::GroundColorFieldMask [static]

Initial value: (1 << SkyBackgroundBase::GroundColorFieldId)

const osg::BitVector SkyBackgroundBase::GroundAngleFieldMask [static]

Initial value: (1 << SkyBackgroundBase::GroundAngleFieldId)

const osg::BitVector SkyBackgroundBase::SphereResFieldMask [static]

Initial value: (1 << SkyBackgroundBase::SphereResFieldId)

const osg::BitVector SkyBackgroundBase::BackTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::BackTextureFieldId)

const osg::BitVector SkyBackgroundBase::BottomTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::BottomTextureFieldId)

const osg::BitVector SkyBackgroundBase::FrontTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::FrontTextureFieldId)

const osg::BitVector SkyBackgroundBase::LeftTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::LeftTextureFieldId)

const osg::BitVector SkyBackgroundBase::RightTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::RightTextureFieldId)

const osg::BitVector SkyBackgroundBase::TopTextureFieldMask [static]

Initial value: (1 << SkyBackgroundBase::TopTextureFieldId)

Color3f SkyBackgroundBase::_mfSkyColor [protected]

Real32 SkyBackgroundBase::_mfSkyAngle [protected]

Color3f SkyBackgroundBase::_mfGroundColor [protected]

Real32 SkyBackgroundBase::_mfGroundAngle [protected]

UInt32 SkyBackgroundBase::_sfSphereRes [protected]

TextureChunkPtr SkyBackgroundBase::_sfBackTexture [protected]

TextureChunkPtr SkyBackgroundBase::_sfBottomTexture [protected]

TextureChunkPtr SkyBackgroundBase::_sfFrontTexture [protected]

TextureChunkPtr SkyBackgroundBase::_sfLeftTexture [protected]

TextureChunkPtr SkyBackgroundBase::_sfRightTexture [protected]

TextureChunkPtr SkyBackgroundBase::_sfTopTexture [protected]

FieldDescription * SkyBackgroundBase::_desc [static, private]

SkyBackground description. Reimplemented from osg::AttachmentContainer.

FieldContainerType SkyBackgroundBase::_type [static, private]

SkyBackground type. Reimplemented from osg::BackgroundBase.

---

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

• OSGSkyBackgroundBase.h
• OSGSkyBackgroundBase.cpp
• OSGSkyBackgroundBase.inl

---