Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::GradientBackgroundBase Class Reference

GradientBackground Base Class. More...

#include <OSGGradientBackgroundBase.h>

Inheritance diagram for osg::GradientBackgroundBase:

Inheritance graph
[legend]
Collaboration diagram for osg::GradientBackgroundBase:

Collaboration graph
[legend]
List of all members.

Public Types

enum  { ColorFieldId = Inherited::NextFieldId, PositionFieldId = ColorFieldId + 1, NextFieldId = PositionFieldId + 1 }

Public Methods

Get
virtual FieldContainerType & getType (void)
virtual const FieldContainerType & getType (void) const
virtual UInt32 getContainerSize (void) const
Field Get
MFColor3f * getMFColor (void)
MFReal32 * getMFPosition (void)
Color3f & getColor (const UInt32 index)
MFColor3f & getColor (void)
const MFColor3f & getColor (void) const
Real32 & getPosition (const UInt32 index)
MFReal32 & getPosition (void)
const MFReal32 & getPosition (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
GradientBackgroundPtr create (void)
 create a new instance of the class

GradientBackgroundPtr 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 PositionFieldMask

Protected Methods

Constructors
 GradientBackgroundBase (void)
 Constructor.

 GradientBackgroundBase (const GradientBackgroundBase &source)
 Copy Constructor.

Destructors
virtual ~GradientBackgroundBase (void)
 Destructor.

Sync
void executeSyncImpl (GradientBackgroundBase *pOther, const BitVector &whichField)

Protected Attributes

Fields
MFColor3f _mfColor
MFReal32 _mfPosition

Private Types

typedef Background Inherited

Private Methods

void operator= (const GradientBackgroundBase &source)

Static Private Attributes

FieldDescription * _desc []
 GradientBackground description.

FieldContainerType _type
 GradientBackground type.


Friends

class FieldContainer

Detailed Description

GradientBackground Base Class.

Member Typedef Documentation

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

Reimplemented from osg::Background.

Reimplemented in osg::GradientBackground.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
ColorFieldId 
PositionFieldId 
NextFieldId 

Constructor & Destructor Documentation

GradientBackgroundBase::GradientBackgroundBase (  void    )  [protected]
 

Constructor.

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

Copy Constructor.

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

Destructor.

Member Function Documentation

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

access the type of the class

Reimplemented from osg::BackgroundBase.

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

access the numerical type of the class

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

MFColor3f * osg::GradientBackgroundBase::getMFColor (  void    )  [inline]
 

MFReal32 * osg::GradientBackgroundBase::getMFPosition (  void    )  [inline]
 

Color3f & osg::GradientBackgroundBase::getColor (  const UInt32    index )  [inline]
 

MFColor3f & osg::GradientBackgroundBase::getColor (  void    )  [inline]
 

const MFColor3f & osg::GradientBackgroundBase::getColor (  void    )  const [inline]
 

Real32 & osg::GradientBackgroundBase::getPosition (  const UInt32    index )  [inline]
 

MFReal32 & osg::GradientBackgroundBase::getPosition (  void    )  [inline]
 

const MFReal32 & osg::GradientBackgroundBase::getPosition (  void    )  const [inline]
 

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

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

Reimplemented from osg::BackgroundBase.

GradientBackgroundPtr osg::GradientBackgroundBase::create (  void    )  [inline, static]
 

create a new instance of the class

GradientBackgroundPtr osg::GradientBackgroundBase::createEmpty (  void    )  [inline, static]
 

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

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

Implements osg::FieldContainer.

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

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

Friends And Related Function Documentation

friend class FieldContainer [friend]
 

Reimplemented from osg::Background.

Reimplemented in osg::GradientBackground.

Member Data Documentation

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

Initial value:

 
    (1 << GradientBackgroundBase::ColorFieldId)

const osg::BitVector GradientBackgroundBase::PositionFieldMask [static]
 

Initial value:

 
    (1 << GradientBackgroundBase::PositionFieldId)

Color3f GradientBackgroundBase::_mfColor [protected]
 

The colors of the gradient.

Real32 GradientBackgroundBase::_mfPosition [protected]
 

The positions of the gradient.

FieldDescription * GradientBackgroundBase::_desc [static, private]
 

Initial value:

 
{
    new FieldDescription(MFColor3f::getClassType(), 
                     "color", 
                     ColorFieldId, ColorFieldMask,
                     false,
                     (FieldAccessMethod) &GradientBackgroundBase::getMFColor),
    new FieldDescription(MFReal32::getClassType(), 
                     "position", 
                     PositionFieldId, PositionFieldMask,
                     false,
                     (FieldAccessMethod) &GradientBackgroundBase::getMFPosition)
}
GradientBackground description.

Reimplemented from osg::AttachmentContainer.

FieldContainerType GradientBackgroundBase::_type [static, private]
 

GradientBackground type.

Reimplemented from osg::BackgroundBase.

The documentation for this class was generated from the following files:
Generated on Wed Jul 3 16:30:29 2002 for OpenSG by doxygen1.2.16