Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
osg::SkyBackgroundBase

osg::SkyBackgroundBase Class Reference

SkyBackground Base Class.

#include <OSGSkyBackgroundBase.h>

Inheritance diagram for osg::SkyBackgroundBase:

osg::Background osg::BackgroundBase osg::AttachmentContainer osg::FieldContainer osg::SkyBackground List of all members.

Public Types

typedef SkyBackgroundPtr Ptr
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, BoxInsideFieldId = TopTextureFieldId + 1,
  TopTexCoordFieldId = BoxInsideFieldId + 1, BottomTexCoordFieldId = TopTexCoordFieldId + 1, RightTexCoordFieldId = BottomTexCoordFieldId + 1, LeftTexCoordFieldId = RightTexCoordFieldId + 1,
  FrontTexCoordFieldId = LeftTexCoordFieldId + 1, BackTexCoordFieldId = FrontTexCoordFieldId + 1, NextFieldId = BackTexCoordFieldId + 1
}

Public Member Functions

FieldContainer Get
*virtual FieldContainerType & getType (void)
virtual const FieldContainerType & getType (void) const
virtual UInt32 getContainerSize (void) const
Field Get
*MFColor4f * getMFSkyColor (void)
 Get the SkyBackground::_mfSkyColor field.
MFReal32 * getMFSkyAngle (void)
 Get the SkyBackground::_mfSkyAngle field.
MFColor4f * getMFGroundColor (void)
 Get the SkyBackground::_mfGroundColor field.
MFReal32 * getMFGroundAngle (void)
 Get the SkyBackground::_mfGroundAngle field.
SFUInt32 * getSFSphereRes (void)
 Get the SkyBackground::_sfSphereRes field.
SFTextureChunkPtr * getSFBackTexture (void)
 Get the SkyBackground::_sfBackTexture field.
SFTextureChunkPtr * getSFBottomTexture (void)
 Get the SkyBackground::_sfBottomTexture field.
SFTextureChunkPtr * getSFFrontTexture (void)
 Get the SkyBackground::_sfFrontTexture field.
SFTextureChunkPtr * getSFLeftTexture (void)
 Get the SkyBackground::_sfLeftTexture field.
SFTextureChunkPtr * getSFRightTexture (void)
 Get the SkyBackground::_sfRightTexture field.
SFTextureChunkPtr * getSFTopTexture (void)
 Get the SkyBackground::_sfTopTexture field.
SFBool * getSFBoxInside (void)
 Get the SkyBackground::_sfBoxInside field.
MFVec3f * getMFTopTexCoord (void)
 Get the SkyBackground::_mfTopTexCoord field.
MFVec3f * getMFBottomTexCoord (void)
 Get the SkyBackground::_mfBottomTexCoord field.
MFVec3f * getMFRightTexCoord (void)
 Get the SkyBackground::_mfRightTexCoord field.
MFVec3f * getMFLeftTexCoord (void)
 Get the SkyBackground::_mfLeftTexCoord field.
MFVec3f * getMFFrontTexCoord (void)
 Get the SkyBackground::_mfFrontTexCoord field.
MFVec3f * getMFBackTexCoord (void)
 Get the SkyBackground::_mfBackTexCoord field.
UInt32 & getSphereRes (void)
 Get the value of the SkyBackground::_sfSphereRes field.
const UInt32 & getSphereRes (void) const
 Get the value of the SkyBackground::_sfSphereRes field.
TextureChunkPtr & getBackTexture (void)
 Get the value of the SkyBackground::_sfBackTexture field.
const TextureChunkPtr & getBackTexture (void) const
 Get the value of the SkyBackground::_sfBackTexture field.
TextureChunkPtr & getBottomTexture (void)
 Get the value of the SkyBackground::_sfBottomTexture field.
const TextureChunkPtr & getBottomTexture (void) const
 Get the value of the SkyBackground::_sfBottomTexture field.
TextureChunkPtr & getFrontTexture (void)
 Get the value of the SkyBackground::_sfFrontTexture field.
const TextureChunkPtr & getFrontTexture (void) const
 Get the value of the SkyBackground::_sfFrontTexture field.
TextureChunkPtr & getLeftTexture (void)
 Get the value of the SkyBackground::_sfLeftTexture field.
const TextureChunkPtr & getLeftTexture (void) const
 Get the value of the SkyBackground::_sfLeftTexture field.
TextureChunkPtr & getRightTexture (void)
 Get the value of the SkyBackground::_sfRightTexture field.
const TextureChunkPtr & getRightTexture (void) const
 Get the value of the SkyBackground::_sfRightTexture field.
TextureChunkPtr & getTopTexture (void)
 Get the value of the SkyBackground::_sfTopTexture field.
const TextureChunkPtr & getTopTexture (void) const
 Get the value of the SkyBackground::_sfTopTexture field.
bool & getBoxInside (void)
 Get the value of the SkyBackground::_sfBoxInside field.
const bool & getBoxInside (void) const
 Get the value of the SkyBackground::_sfBoxInside field.
Color4f & getSkyColor (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfSkyColor field.
MFColor4f & getSkyColor (void)
 Get the SkyBackground::_mfSkyColor field.
const MFColor4f & getSkyColor (void) const
 Get the SkyBackground::_mfSkyColor field.
Real32 & getSkyAngle (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfSkyAngle field.
MFReal32 & getSkyAngle (void)
 Get the SkyBackground::_mfSkyAngle field.
const MFReal32 & getSkyAngle (void) const
 Get the SkyBackground::_mfSkyAngle field.
Color4f & getGroundColor (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfGroundColor field.
MFColor4f & getGroundColor (void)
 Get the SkyBackground::_mfGroundColor field.
const MFColor4f & getGroundColor (void) const
 Get the SkyBackground::_mfGroundColor field.
Real32 & getGroundAngle (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfGroundAngle field.
MFReal32 & getGroundAngle (void)
 Get the SkyBackground::_mfGroundAngle field.
const MFReal32 & getGroundAngle (void) const
 Get the SkyBackground::_mfGroundAngle field.
Vec3f & getTopTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfTopTexCoord field.
MFVec3f & getTopTexCoord (void)
 Get the SkyBackground::_mfTopTexCoord field.
const MFVec3f & getTopTexCoord (void) const
 Get the SkyBackground::_mfTopTexCoord field.
Vec3f & getBottomTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfBottomTexCoord field.
MFVec3f & getBottomTexCoord (void)
 Get the SkyBackground::_mfBottomTexCoord field.
const MFVec3f & getBottomTexCoord (void) const
 Get the SkyBackground::_mfBottomTexCoord field.
Vec3f & getRightTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfRightTexCoord field.
MFVec3f & getRightTexCoord (void)
 Get the SkyBackground::_mfRightTexCoord field.
const MFVec3f & getRightTexCoord (void) const
 Get the SkyBackground::_mfRightTexCoord field.
Vec3f & getLeftTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfLeftTexCoord field.
MFVec3f & getLeftTexCoord (void)
 Get the SkyBackground::_mfLeftTexCoord field.
const MFVec3f & getLeftTexCoord (void) const
 Get the SkyBackground::_mfLeftTexCoord field.
Vec3f & getFrontTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfFrontTexCoord field.
MFVec3f & getFrontTexCoord (void)
 Get the SkyBackground::_mfFrontTexCoord field.
const MFVec3f & getFrontTexCoord (void) const
 Get the SkyBackground::_mfFrontTexCoord field.
Vec3f & getBackTexCoord (const UInt32 index)
 Get the value of the index element the SkyBackground::_mfBackTexCoord field.
MFVec3f & getBackTexCoord (void)
 Get the SkyBackground::_mfBackTexCoord field.
const MFVec3f & getBackTexCoord (void) const
 Get the SkyBackground::_mfBackTexCoord field.
Field Set
*void setSphereRes (const UInt32 &value)
 Set the value of the SkyBackground::_sfSphereRes field.
void setBackTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfBackTexture field.
void setBottomTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfBottomTexture field.
void setFrontTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfFrontTexture field.
void setLeftTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfLeftTexture field.
void setRightTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfRightTexture field.
void setTopTexture (const TextureChunkPtr &value)
 Set the value of the SkyBackground::_sfTopTexture field.
void setBoxInside (const bool &value)
 Set the value of the SkyBackground::_sfBoxInside field.
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
access fields
*virtual void clear (DrawActionBase *action, Viewport *port)=0
transformation
*virtual void changed (BitVector whichField, UInt32 origin)
dump
*virtual void dump (UInt32 uiIndent=0, const BitVector bvFlags=0) const
Handle Attachments
*void addAttachment (const AttachmentPtr &fieldContainerP, UInt16 binding=0)
void subAttachment (const AttachmentPtr &fieldContainerP, UInt16 binding=0)
AttachmentPtr findAttachment (UInt32 groupId, UInt16 binding=0)
AttachmentPtr findAttachment (const FieldContainerType &type, UInt16 binding=0)
Field Access *SFAttachmentMap * getSFAttachments (void)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8 * getTypeName (void) const
Generic Field Access *Field * getField (UInt32 fieldId)
Field * getField (const Char8 *fieldName)

Static Public Member Functions

Class Get
*static FieldContainerType & getClassType (void)
 access the type of the class
static UInt32 getClassTypeId (void)
 access the numerical type of the class
Construction
*static SkyBackgroundPtr create (void)
 create a new instance of the class
static SkyBackgroundPtr createEmpty (void)
 create an empty new instance of the class, do not copy the prototype
Class Get
*static const Char8 * getClassname (void)
Get Class Type Information
static UInt16 getClassGroupId (void)

Static Public Attributes

static const osg::BitVector SkyColorFieldMask
static const osg::BitVector SkyAngleFieldMask
static const osg::BitVector GroundColorFieldMask
static const osg::BitVector GroundAngleFieldMask
static const osg::BitVector SphereResFieldMask
static const osg::BitVector BackTextureFieldMask
static const osg::BitVector BottomTextureFieldMask
static const osg::BitVector FrontTextureFieldMask
static const osg::BitVector LeftTextureFieldMask
static const osg::BitVector RightTextureFieldMask
static const osg::BitVector TopTextureFieldMask
static const osg::BitVector BoxInsideFieldMask
static const osg::BitVector TopTexCoordFieldMask
static const osg::BitVector BottomTexCoordFieldMask
static const osg::BitVector RightTexCoordFieldMask
static const osg::BitVector LeftTexCoordFieldMask
static const osg::BitVector FrontTexCoordFieldMask
static const osg::BitVector BackTexCoordFieldMask
static const osg::BitVector MTInfluenceMask
static const BitVector AttachmentsFieldMask
static const BitVector NextFieldMask
CoredNodePtr helper
static const bool isNodeCore = false

Protected Member Functions

Constructors
* SkyBackgroundBase (void)
 SkyBackgroundBase (const SkyBackgroundBase &source)
Destructors
*virtual ~SkyBackgroundBase (void)
Sync
*void executeSyncImpl (SkyBackgroundBase *pOther, const BitVector &whichField)
virtual void executeSync (FieldContainer &other, const BitVector &whichField)
Sync
*void executeSyncImpl (BackgroundBase *pOther, const BitVector &whichField)
Sync
void executeSyncImpl (AttachmentContainer *pOther, const BitVector &whichField)
Sync
void executeSyncImpl (FieldContainer *pOther, const BitVector &whichField)
Pointer
*AttachmentContainerPtr getPtr (void)
MT Edit
template<class FieldTypeT>
*void beginEditX (const BitVector &whichField, FieldTypeT &field)
template<class FieldTypeT>
void endEditX (const BitVector &whichField, FieldTypeT &field)
MT Construction
*void onCreate (const FieldContainer *source=NULL)
void onCreateAspect (const FieldContainer *aspect0, const FieldContainer *source=NULL)
MT Destruction
*virtual void onDestroy (void)

Static Protected Member Functions

Create Fieldcontainer
template<class ObjectPtrT>
*static void newPtr (ObjectPtrT &result, const typename ObjectPtrT::StoredObjectType *prototypeP)
template<class ObjectPtrT>
static void newPtr (ObjectPtrT &result)

Protected Attributes

Fields
*MFColor4f _mfSkyColor
MFReal32 _mfSkyAngle
MFColor4f _mfGroundColor
MFReal32 _mfGroundAngle
SFUInt32 _sfSphereRes
SFTextureChunkPtr _sfBackTexture
SFTextureChunkPtr _sfBottomTexture
SFTextureChunkPtr _sfFrontTexture
SFTextureChunkPtr _sfLeftTexture
SFTextureChunkPtr _sfRightTexture
SFTextureChunkPtr _sfTopTexture
SFBool _sfBoxInside
MFVec3f _mfTopTexCoord
MFVec3f _mfBottomTexCoord
MFVec3f _mfRightTexCoord
MFVec3f _mfLeftTexCoord
MFVec3f _mfFrontTexCoord
MFVec3f _mfBackTexCoord
Fields
*SFAttachmentMap _attachmentMap
Member
*UInt32 _shares

Private Types

typedef Background Inherited

Private Member Functions

void operator= (const SkyBackgroundBase &source)

Static Private Attributes

static FieldDescription * _desc []
 SkyBackground description.
static FieldContainerType _type

Friends

class FieldContainer

Detailed Description

Definition at line 98 of file OSGSkyBackgroundBase.h.

Member Typedef Documentation

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

Reimplemented from osg::Background.

Reimplemented in osg::SkyBackground.

Definition at line 102 of file OSGSkyBackgroundBase.h.

typedef SkyBackgroundPtr osg::SkyBackgroundBase::Ptr
 

Reimplemented from osg::BackgroundBase.

Definition at line 107 of file OSGSkyBackgroundBase.h.

Member Enumeration Documentation

anonymous enum
 

Enumerator:
SkyColorFieldId 
SkyAngleFieldId 
GroundColorFieldId 
GroundAngleFieldId 
SphereResFieldId 
BackTextureFieldId 
BottomTextureFieldId 
FrontTextureFieldId 
LeftTextureFieldId 
RightTextureFieldId 
TopTextureFieldId 
BoxInsideFieldId 
TopTexCoordFieldId 
BottomTexCoordFieldId 
RightTexCoordFieldId 
LeftTexCoordFieldId 
FrontTexCoordFieldId 
BackTexCoordFieldId 
NextFieldId 

Reimplemented from osg::AttachmentContainer.

Definition at line 109 of file OSGSkyBackgroundBase.h.

00110     {
00111         SkyColorFieldId       = Inherited::NextFieldId,
00112         SkyAngleFieldId       = SkyColorFieldId       + 1,
00113         GroundColorFieldId    = SkyAngleFieldId       + 1,
00114         GroundAngleFieldId    = GroundColorFieldId    + 1,
00115         SphereResFieldId      = GroundAngleFieldId    + 1,
00116         BackTextureFieldId    = SphereResFieldId      + 1,
00117         BottomTextureFieldId  = BackTextureFieldId    + 1,
00118         FrontTextureFieldId   = BottomTextureFieldId  + 1,
00119         LeftTextureFieldId    = FrontTextureFieldId   + 1,
00120         RightTextureFieldId   = LeftTextureFieldId    + 1,
00121         TopTextureFieldId     = RightTextureFieldId   + 1,
00122         BoxInsideFieldId      = TopTextureFieldId     + 1,
00123         TopTexCoordFieldId    = BoxInsideFieldId      + 1,
00124         BottomTexCoordFieldId = TopTexCoordFieldId    + 1,
00125         RightTexCoordFieldId  = BottomTexCoordFieldId + 1,
00126         LeftTexCoordFieldId   = RightTexCoordFieldId  + 1,
00127         FrontTexCoordFieldId  = LeftTexCoordFieldId   + 1,
00128         BackTexCoordFieldId   = FrontTexCoordFieldId  + 1,
00129         NextFieldId           = BackTexCoordFieldId   + 1
00130     };

Constructor & Destructor Documentation

SkyBackgroundBase::SkyBackgroundBase (  void   )  [protected]
 

Definition at line 361 of file OSGSkyBackgroundBase.cpp.

00361                                          :
00362     _mfSkyColor               (), 
00363     _mfSkyAngle               (), 
00364     _mfGroundColor            (), 
00365     _mfGroundAngle            (), 
00366     _sfSphereRes              (UInt32(8)), 
00367     _sfBackTexture            (TextureChunkPtr(NullFC)), 
00368     _sfBottomTexture          (TextureChunkPtr(NullFC)), 
00369     _sfFrontTexture           (TextureChunkPtr(NullFC)), 
00370     _sfLeftTexture            (TextureChunkPtr(NullFC)), 
00371     _sfRightTexture           (TextureChunkPtr(NullFC)), 
00372     _sfTopTexture             (TextureChunkPtr(NullFC)), 
00373     _sfBoxInside              (bool(true)), 
00374     _mfTopTexCoord            (), 
00375     _mfBottomTexCoord         (), 
00376     _mfRightTexCoord          (), 
00377     _mfLeftTexCoord           (), 
00378     _mfFrontTexCoord          (), 
00379     _mfBackTexCoord           (), 
00380     Inherited() 
00381 {
00382 }

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

Definition at line 388 of file OSGSkyBackgroundBase.cpp.

00388                                                                     :
00389     _mfSkyColor               (source._mfSkyColor               ), 
00390     _mfSkyAngle               (source._mfSkyAngle               ), 
00391     _mfGroundColor            (source._mfGroundColor            ), 
00392     _mfGroundAngle            (source._mfGroundAngle            ), 
00393     _sfSphereRes              (source._sfSphereRes              ), 
00394     _sfBackTexture            (source._sfBackTexture            ), 
00395     _sfBottomTexture          (source._sfBottomTexture          ), 
00396     _sfFrontTexture           (source._sfFrontTexture           ), 
00397     _sfLeftTexture            (source._sfLeftTexture            ), 
00398     _sfRightTexture           (source._sfRightTexture           ), 
00399     _sfTopTexture             (source._sfTopTexture             ), 
00400     _sfBoxInside              (source._sfBoxInside              ), 
00401     _mfTopTexCoord            (source._mfTopTexCoord            ), 
00402     _mfBottomTexCoord         (source._mfBottomTexCoord         ), 
00403     _mfRightTexCoord          (source._mfRightTexCoord          ), 
00404     _mfLeftTexCoord           (source._mfLeftTexCoord           ), 
00405     _mfFrontTexCoord          (source._mfFrontTexCoord          ), 
00406     _mfBackTexCoord           (source._mfBackTexCoord           ), 
00407     Inherited                 (source)
00408 {
00409 }

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

Definition at line 413 of file OSGSkyBackgroundBase.cpp.

00414 {
00415 }

Member Function Documentation

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

Reimplemented from osg::BackgroundBase.

Definition at line 58 of file OSGSkyBackgroundBase.inl.

References _type.

Referenced by create().

00059 {
00060     return _type; 
00061 }

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

Reimplemented from osg::BackgroundBase.

Definition at line 65 of file OSGSkyBackgroundBase.inl.

References _type, and osg::TypeBase::getId().

00066 {
00067     return _type.getId(); 
00068 }

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

Reimplemented from osg::BackgroundBase.

Definition at line 293 of file OSGSkyBackgroundBase.cpp.

References _type.

00294 {
00295     return _type; 
00296 }

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

Reimplemented from osg::BackgroundBase.

Definition at line 298 of file OSGSkyBackgroundBase.cpp.

References _type.

00299 {
00300     return _type;
00301 }

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

Reimplemented from osg::BackgroundBase.

Definition at line 313 of file OSGSkyBackgroundBase.cpp.

00314 { 
00315     return sizeof(SkyBackground); 
00316 }

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

Definition at line 101 of file OSGSkyBackgroundBase.inl.

References _mfSkyColor.

00102 {
00103     return &_mfSkyColor;
00104 }

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

Definition at line 108 of file OSGSkyBackgroundBase.inl.

References _mfSkyAngle.

00109 {
00110     return &_mfSkyAngle;
00111 }

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

Definition at line 115 of file OSGSkyBackgroundBase.inl.

References _mfGroundColor.

00116 {
00117     return &_mfGroundColor;
00118 }

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

Definition at line 122 of file OSGSkyBackgroundBase.inl.

References _mfGroundAngle.

00123 {
00124     return &_mfGroundAngle;
00125 }

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

Definition at line 129 of file OSGSkyBackgroundBase.inl.

References _sfSphereRes.

00130 {
00131     return &_sfSphereRes;
00132 }

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

Definition at line 136 of file OSGSkyBackgroundBase.inl.

References _sfBackTexture.

00137 {
00138     return &_sfBackTexture;
00139 }

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

Definition at line 143 of file OSGSkyBackgroundBase.inl.

References _sfBottomTexture.

00144 {
00145     return &_sfBottomTexture;
00146 }

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

Definition at line 150 of file OSGSkyBackgroundBase.inl.

References _sfFrontTexture.

00151 {
00152     return &_sfFrontTexture;
00153 }