---

osg::BillboardBase Class Reference

Billboard Base Class. More...

#include <OSGBillboardBase.h>

Inheritance diagram for osg::BillboardBase:

[legend]Collaboration diagram for osg::BillboardBase:

[legend]List of all members.

Public Types
enum	{ AxisOfRotationFieldId = Inherited::NextFieldId, FocusOnCameraFieldId = AxisOfRotationFieldId + 1, AlignToScreenFieldId = FocusOnCameraFieldId + 1, NextFieldId = AlignToScreenFieldId + 1 }
Public Methods
Get
virtual FieldContainerType &	getType (void)
virtual const FieldContainerType &	getType (void) const
virtual UInt32	getContainerSize (void) const
Field Get
SFVec3f *	getSFAxisOfRotation (void)
SFBool *	getSFFocusOnCamera (void)
SFBool *	getSFAlignToScreen (void)
Vec3f &	getAxisOfRotation (void)
const Vec3f &	getAxisOfRotation (void) const
bool &	getFocusOnCamera (void)
const bool &	getFocusOnCamera (void) const
bool &	getAlignToScreen (void)
const bool &	getAlignToScreen (void) const
Field Set
void	setAxisOfRotation (const Vec3f &value)
void	setFocusOnCamera (const bool &value)
void	setAlignToScreen (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
BillboardPtr	create (void)
	create a new instance of the class
BillboardPtr	createEmpty (void)
	create an empty new instance of the class, do not copy the prototype
Static Public Attributes
const osg::BitVector	AxisOfRotationFieldMask
const osg::BitVector	FocusOnCameraFieldMask
const osg::BitVector	AlignToScreenFieldMask
Protected Methods
Constructors
	BillboardBase (void)
	Constructor.
	BillboardBase (const BillboardBase &source)
	Copy Constructor.
Destructors
virtual	~BillboardBase (void)
	Destructor.
Sync
void	executeSyncImpl (BillboardBase *pOther, const BitVector &whichField)
Protected Attributes
Fields
SFVec3f	_sfAxisOfRotation
SFBool	_sfFocusOnCamera
SFBool	_sfAlignToScreen
Private Types
typedef NodeCore	Inherited
Private Methods
void	operator= (const BillboardBase &source)
Static Private Attributes
FieldDescription *	_desc []
	Billboard description.
FieldContainerType	_type
	Billboard type.
Friends
class	FieldContainer

---

Detailed Description

Billboard Base Class.

---

Member Typedef Documentation

typedef NodeCore osg::BillboardBase::Inherited [private]

Reimplemented from osg::NodeCore. Reimplemented in osg::Billboard.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: AxisOfRotationFieldId  FocusOnCameraFieldId  AlignToScreenFieldId  NextFieldId

---

Constructor & Destructor Documentation

BillboardBase::BillboardBase (  void    )  [protected]

Constructor.

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

Copy Constructor.

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

Destructor.

---

Member Function Documentation

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

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

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

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

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

Reimplemented from osg::FieldContainer.

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

Reimplemented from osg::FieldContainer.

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

Implements osg::FieldContainer.

SFVec3f * osg::BillboardBase::getSFAxisOfRotation (  void    )  [inline]

SFBool * osg::BillboardBase::getSFFocusOnCamera (  void    )  [inline]

SFBool * osg::BillboardBase::getSFAlignToScreen (  void    )  [inline]

Vec3f & osg::BillboardBase::getAxisOfRotation (  void    )  [inline]

const Vec3f & osg::BillboardBase::getAxisOfRotation (  void    )  const [inline]

bool & osg::BillboardBase::getFocusOnCamera (  void    )  [inline]

const bool & osg::BillboardBase::getFocusOnCamera (  void    )  const [inline]

bool & osg::BillboardBase::getAlignToScreen (  void    )  [inline]

const bool & osg::BillboardBase::getAlignToScreen (  void    )  const [inline]

void osg::BillboardBase::setAxisOfRotation (  const Vec3f &    value )  [inline]

void osg::BillboardBase::setFocusOnCamera (  const bool &    value )  [inline]

void osg::BillboardBase::setAlignToScreen (  const bool &    value )  [inline]

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

Reimplemented from osg::NodeCore.

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

Reimplemented from osg::NodeCore.

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

Reimplemented from osg::NodeCore.

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

Reimplemented from osg::NodeCore.

BillboardPtr osg::BillboardBase::create (  void    )  [inline, static]

create a new instance of the class

BillboardPtr osg::BillboardBase::createEmpty (  void    )  [inline, static]

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

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

Implements osg::FieldContainer.

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

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

---

Friends And Related Function Documentation

friend class FieldContainer [friend]

Reimplemented from osg::NodeCore. Reimplemented in osg::Billboard.

---

Member Data Documentation

const osg::BitVector BillboardBase::AxisOfRotationFieldMask [static]

Initial value: (1 << BillboardBase::AxisOfRotationFieldId)

const osg::BitVector BillboardBase::FocusOnCameraFieldMask [static]

Initial value: (1 << BillboardBase::FocusOnCameraFieldId)

const osg::BitVector BillboardBase::AlignToScreenFieldMask [static]

Initial value: (1 << BillboardBase::AlignToScreenFieldId)

Vec3f BillboardBase::_sfAxisOfRotation [protected]

bool BillboardBase::_sfFocusOnCamera [protected]

bool BillboardBase::_sfAlignToScreen [protected]

FieldDescription * BillboardBase::_desc [static, private]

Initial value: { new FieldDescription(SFVec3f::getClassType(), "axisOfRotation", AxisOfRotationFieldId, AxisOfRotationFieldMask, true, (FieldAccessMethod) &BillboardBase::getSFAxisOfRotation), new FieldDescription(SFBool::getClassType(), "focusOnCamera", FocusOnCameraFieldId, FocusOnCameraFieldMask, true, (FieldAccessMethod) &BillboardBase::getSFFocusOnCamera), new FieldDescription(SFBool::getClassType(), "alignToScreen", AlignToScreenFieldId, AlignToScreenFieldMask, true, (FieldAccessMethod) &BillboardBase::getSFAlignToScreen) } Billboard description. Reimplemented from osg::NodeCore.

FieldContainerType BillboardBase::_type [static, private]

Billboard type. Reimplemented from osg::NodeCore.

---

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

• OSGBillboardBase.h
• OSGBillboardBase.cpp
• OSGBillboardBase.inl

---