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

osg::TextureBackgroundBase Class Reference

TextureBackground Base Class.

#include <OSGTextureBackgroundBase.h>

Inheritance diagram for osg::TextureBackgroundBase:

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

Public Types

typedef TextureBackgroundPtr Ptr
enum  {
  ColorFieldId = Inherited::NextFieldId, TextureFieldId = ColorFieldId + 1, TexCoordsFieldId = TextureFieldId + 1, RadialDistortionFieldId = TexCoordsFieldId + 1,
  CenterOfDistortionFieldId = RadialDistortionFieldId + 1, HorFieldId = CenterOfDistortionFieldId + 1, VertFieldId = HorFieldId + 1, NextFieldId = VertFieldId + 1
}

Public Member Functions

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 *SFAttachmentMapgetSFAttachments (void)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8getTypeName (void) const
Generic Field Access *FieldgetField (UInt32 fieldId)
FieldgetField (const Char8 *fieldName)
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 *SFAttachmentMapgetSFAttachments (void)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8getTypeName (void) const
Generic Field Access *FieldgetField (UInt32 fieldId)
FieldgetField (const Char8 *fieldName)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8getTypeName (void) const
Generic Field Access *FieldgetField (UInt32 fieldId)
FieldgetField (const Char8 *fieldName)
FieldContainer Get
*virtual FieldContainerTypegetType (void)
virtual const FieldContainerTypegetType (void) const
virtual UInt32 getContainerSize (void) const
Field Get
*SFColor4fgetSFColor (void)
 Get the TextureBackground::_sfColor field.
SFTextureChunkPtrgetSFTexture (void)
 Get the TextureBackground::_sfTexture field.
MFPnt2fgetMFTexCoords (void)
 Get the TextureBackground::_mfTexCoords field.
SFReal32getSFRadialDistortion (void)
 Get the TextureBackground::_sfRadialDistortion field.
SFVec2fgetSFCenterOfDistortion (void)
 Get the TextureBackground::_sfCenterOfDistortion field.
SFUInt16getSFHor (void)
 Get the TextureBackground::_sfHor field.
SFUInt16getSFVert (void)
 Get the TextureBackground::_sfVert field.
Color4fgetColor (void)
 Get the value of the TextureBackground::_sfColor field.
const Color4fgetColor (void) const
 Get the value of the TextureBackground::_sfColor field.
TextureChunkPtrgetTexture (void)
 Get the value of the TextureBackground::_sfTexture field.
const TextureChunkPtrgetTexture (void) const
 Get the value of the TextureBackground::_sfTexture field.
Real32getRadialDistortion (void)
 Get the value of the TextureBackground::_sfRadialDistortion field.
const Real32getRadialDistortion (void) const
 Get the value of the TextureBackground::_sfRadialDistortion field.
Vec2fgetCenterOfDistortion (void)
 Get the value of the TextureBackground::_sfCenterOfDistortion field.
const Vec2fgetCenterOfDistortion (void) const
 Get the value of the TextureBackground::_sfCenterOfDistortion field.
UInt16getHor (void)
 Get the value of the TextureBackground::_sfHor field.
const UInt16getHor (void) const
 Get the value of the TextureBackground::_sfHor field.
UInt16getVert (void)
 Get the value of the TextureBackground::_sfVert field.
const UInt16getVert (void) const
 Get the value of the TextureBackground::_sfVert field.
Pnt2fgetTexCoords (const UInt32 index)
 Get the value of the index element the TextureBackground::_mfTexCoords field.
MFPnt2fgetTexCoords (void)
 Get the TextureBackground::_mfTexCoords field.
const MFPnt2fgetTexCoords (void) const
 Get the TextureBackground::_mfTexCoords field.
Field Set
*void setColor (const Color4f &value)
 Set the value of the TextureBackground::_sfColor field.
void setTexture (const TextureChunkPtr &value)
 Set the value of the TextureBackground::_sfTexture field.
void setRadialDistortion (const Real32 &value)
 Set the value of the TextureBackground::_sfRadialDistortion field.
void setCenterOfDistortion (const Vec2f &value)
 Set the value of the TextureBackground::_sfCenterOfDistortion field.
void setHor (const UInt16 &value)
 Set the value of the TextureBackground::_sfHor field.
void setVert (const UInt16 &value)
 Set the value of the TextureBackground::_sfVert 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 *SFAttachmentMapgetSFAttachments (void)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8getTypeName (void) const
Generic Field Access *FieldgetField (UInt32 fieldId)
FieldgetField (const Char8 *fieldName)
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 *SFAttachmentMapgetSFAttachments (void)
Get Instance Type Information
UInt32 getTypeId (void) const
UInt16 getGroupId (void) const
const Char8getTypeName (void) const
Generic Field Access *FieldgetField (UInt32 fieldId)
FieldgetField (const Char8 *fieldName)

Static Public Member Functions

Get Class Type Information
static UInt16 getClassGroupId (void)
Get Class Type Information
static UInt16 getClassGroupId (void)
Get Class Type Information
static UInt16 getClassGroupId (void)
Class Get
*static FieldContainerTypegetClassType (void)
 access the type of the class
static UInt32 getClassTypeId (void)
 access the numerical type of the class
Construction
*static TextureBackgroundPtr create (void)
 create a new instance of the class
static TextureBackgroundPtr createEmpty (void)
 create an empty new instance of the class, do not copy the prototype
Class Get
*static const Char8getClassname (void)
Get Class Type Information
static UInt16 getClassGroupId (void)
Get Class Type Information
static UInt16 getClassGroupId (void)

Static Public Attributes

static const osg::BitVector ColorFieldMask
static const osg::BitVector TextureFieldMask
static const osg::BitVector TexCoordsFieldMask
static const osg::BitVector RadialDistortionFieldMask
static const osg::BitVector CenterOfDistortionFieldMask
static const osg::BitVector HorFieldMask
static const osg::BitVector VertFieldMask
static const osg::BitVector MTInfluenceMask
static const BitVector AttachmentsFieldMask
static const BitVector NextFieldMask
CoredNodePtr helper
static const bool isNodeCore = false
CoredNodePtr helper
static const bool isNodeCore = false
CoredNodePtr helper
static const bool isNodeCore = false
CoredNodePtr helper
static const bool isNodeCore = false
CoredNodePtr helper
static const bool isNodeCore = false

Protected Member Functions

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)
Sync
void executeSyncImpl (AttachmentContainer *pOther, const BitVector &whichField)
Sync
void executeSyncImpl (FieldContainer *pOther, const BitVector &whichField)
MT Construction
*void onCreate (const FieldContainer *source=NULL)
void onCreateAspect (const FieldContainer *aspect0, const FieldContainer *source=NULL)
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)
Sync
void executeSyncImpl (FieldContainer *pOther, const BitVector &whichField)
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)
Constructors
TextureBackgroundBase (void)
 TextureBackgroundBase (const TextureBackgroundBase &source)
Destructors
*virtual ~TextureBackgroundBase (void)
Sync
*void executeSyncImpl (TextureBackgroundBase *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)
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)
Create Fieldcontainer
template<class ObjectPtrT>
*static void newPtr (ObjectPtrT &result, const typename ObjectPtrT::StoredObjectType *prototypeP)
template<class ObjectPtrT>
static void newPtr (ObjectPtrT &result)
Create Fieldcontainer
template<class ObjectPtrT>
*static void newPtr (ObjectPtrT &result, const typename ObjectPtrT::StoredObjectType *prototypeP)
template<class ObjectPtrT>
static void newPtr (ObjectPtrT &result)
Create Fieldcontainer
template<class ObjectPtrT>
*static void newPtr (ObjectPtrT &result, const typename ObjectPtrT::StoredObjectType *prototypeP)
template<class ObjectPtrT>
static void newPtr (ObjectPtrT &result)
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
*SFAttachmentMap _attachmentMap
Member
*UInt32 _shares
Fields
*SFAttachmentMap _attachmentMap
Member
*UInt32 _shares
Member
*UInt32 _shares
Fields
*SFColor4f _sfColor
SFTextureChunkPtr _sfTexture
MFPnt2f _mfTexCoords
SFReal32 _sfRadialDistortion
SFVec2f _sfCenterOfDistortion
SFUInt16 _sfHor
SFUInt16 _sfVert
Fields
*SFAttachmentMap _attachmentMap
Member
*UInt32 _shares
Fields
*SFAttachmentMap _attachmentMap
Member
*UInt32 _shares

Private Types

typedef Background Inherited

Private Member Functions

void operator= (const TextureBackgroundBase &source)

Static Private Attributes

static FieldDescription_desc []
 TextureBackground description.
static FieldContainerType _type

Friends

class FieldContainer

Detailed Description

Definition at line 87 of file OSGTextureBackgroundBase.h.


Member Typedef Documentation

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

Reimplemented from osg::Background.

Reimplemented in osg::TextureBackground.

Definition at line 91 of file OSGTextureBackgroundBase.h.

typedef TextureBackgroundPtr osg::TextureBackgroundBase::Ptr
 

Reimplemented from osg::BackgroundBase.

Definition at line 96 of file OSGTextureBackgroundBase.h.


Member Enumeration Documentation

anonymous enum
 

Enumerator:
ColorFieldId 
TextureFieldId 
TexCoordsFieldId 
RadialDistortionFieldId 
CenterOfDistortionFieldId 
HorFieldId 
VertFieldId 
NextFieldId 

Reimplemented from osg::AttachmentContainer.

Definition at line 98 of file OSGTextureBackgroundBase.h.

00099     {
00100         ColorFieldId              = Inherited::NextFieldId,
00101         TextureFieldId            = ColorFieldId              + 1,
00102         TexCoordsFieldId          = TextureFieldId            + 1,
00103         RadialDistortionFieldId   = TexCoordsFieldId          + 1,
00104         CenterOfDistortionFieldId = RadialDistortionFieldId   + 1,
00105         HorFieldId                = CenterOfDistortionFieldId + 1,
00106         VertFieldId               = HorFieldId                + 1,
00107         NextFieldId               = VertFieldId               + 1
00108     };


Constructor & Destructor Documentation

TextureBackgroundBase::TextureBackgroundBase void   )  [protected]
 

Definition at line 231 of file OSGTextureBackgroundBase.cpp.

00231                                                  :
00232     _sfColor                  (), 
00233     _sfTexture                (), 
00234     _mfTexCoords              (), 
00235     _sfRadialDistortion       (Real32(0)), 
00236     _sfCenterOfDistortion     (Vec2f(0.5, 0.5)), 
00237     _sfHor                    (UInt16(2)), 
00238     _sfVert                   (UInt16(2)), 
00239     Inherited() 
00240 {
00241 }

TextureBackgroundBase::TextureBackgroundBase const TextureBackgroundBase source  )  [protected]
 

Definition at line 247 of file OSGTextureBackgroundBase.cpp.

00247                                                                                 :
00248     _sfColor                  (source._sfColor                  ), 
00249     _sfTexture                (source._sfTexture                ), 
00250     _mfTexCoords              (source._mfTexCoords              ), 
00251     _sfRadialDistortion       (source._sfRadialDistortion       ), 
00252     _sfCenterOfDistortion     (source._sfCenterOfDistortion     ), 
00253     _sfHor                    (source._sfHor                    ), 
00254     _sfVert                   (source._sfVert                   ), 
00255     Inherited                 (source)
00256 {
00257 }

TextureBackgroundBase::~TextureBackgroundBase void   )  [protected, virtual]
 

Definition at line 261 of file OSGTextureBackgroundBase.cpp.

00262 {
00263 }


Member Function Documentation

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

Reimplemented from osg::BackgroundBase.

Definition at line 58 of file OSGTextureBackgroundBase.inl.

References _type.

Referenced by create().

00059 {
00060     return _type; 
00061 } 

osg::UInt32 osg::TextureBackgroundBase::getClassTypeId void   )  [inline, static]
 

Reimplemented from osg::BackgroundBase.

Definition at line 65 of file OSGTextureBackgroundBase.inl.

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

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

FieldContainerType & TextureBackgroundBase::getType void   )  [virtual]
 

Reimplemented from osg::BackgroundBase.

Definition at line 172 of file OSGTextureBackgroundBase.cpp.

References _type.

00173 {
00174     return _type; 
00175 } 

const FieldContainerType & TextureBackgroundBase::getType void   )  const [virtual]
 

Reimplemented from osg::BackgroundBase.

Definition at line 177 of file OSGTextureBackgroundBase.cpp.

References _type.

00178 {
00179     return _type;
00180 } 

UInt32 TextureBackgroundBase::getContainerSize void   )  const [virtual]
 

Reimplemented from osg::BackgroundBase.

Definition at line 192 of file OSGTextureBackgroundBase.cpp.

00193 { 
00194     return sizeof(TextureBackground); 
00195 }

SFColor4f * osg::TextureBackgroundBase::getSFColor void   )  [inline]
 

Definition at line 101 of file OSGTextureBackgroundBase.inl.

References _sfColor.

00102 {
00103     return &_sfColor;
00104 }

SFTextureChunkPtr * osg::TextureBackgroundBase::getSFTexture void   )  [inline]
 

Definition at line 108 of file OSGTextureBackgroundBase.inl.

References _sfTexture.

00109 {
00110     return &_sfTexture;
00111 }

MFPnt2f * osg::TextureBackgroundBase::getMFTexCoords void   )  [inline]
 

Definition at line 115 of file OSGTextureBackgroundBase.inl.

References _mfTexCoords.

00116 {
00117     return &_mfTexCoords;
00118 }

SFReal32 * osg::TextureBackgroundBase::getSFRadialDistortion void   )  [inline]
 

Definition at line 122 of file OSGTextureBackgroundBase.inl.

References _sfRadialDistortion.

00123 {
00124     return &_sfRadialDistortion;
00125 }

SFVec2f * osg::TextureBackgroundBase::getSFCenterOfDistortion void   )  [inline]
 

Definition at line 129 of file OSGTextureBackgroundBase.inl.

References _sfCenterOfDistortion.

00130 {
00131     return &_sfCenterOfDistortion;
00132 }

SFUInt16 * osg::TextureBackgroundBase::getSFHor void   )  [inline]
 

Definition at line 136 of file OSGTextureBackgroundBase.inl.

References _sfHor.

00137 {
00138     return &_sfHor;
00139 }

SFUInt16 * osg::TextureBackgroundBase::getSFVert void   )  [inline]
 

Definition at line 143 of file OSGTextureBackgroundBase.inl.

References _sfVert.

00144 {
00145     return &_sfVert;
00146 }

Color4f & osg::TextureBackgroundBase::getColor void   )  [inline]
 

Definition at line 151 of file OSGTextureBackgroundBase.inl.

References _sfColor, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::TextureBackground::clear().

00152 {
00153     return _sfColor.getValue();
00154 }

const Color4f & osg::TextureBackgroundBase::getColor void   )  const [inline]
 

Definition at line 158 of file OSGTextureBackgroundBase.inl.

References _sfColor, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00159 {
00160     return _sfColor.getValue();
00161 }

TextureChunkPtr & osg::TextureBackgroundBase::getTexture void   )  [inline]
 

Definition at line 172 of file OSGTextureBackgroundBase.inl.

References _sfTexture, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::TextureBackground::clear().

00173 {
00174     return _sfTexture.getValue();
00175 }

const TextureChunkPtr & osg::TextureBackgroundBase::getTexture void   )  const [inline]
 

Definition at line 179 of file OSGTextureBackgroundBase.inl.

References _sfTexture, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

00180 {
00181     return _sfTexture.getValue();
00182 }

Real32 & osg::TextureBackgroundBase::getRadialDistortion void   )  [inline]
 

Definition at line 193 of file OSGTextureBackgroundBase.inl.

References _sfRadialDistortion, and osg::SField< FieldTypeT, fieldNameSpace >::getValue().

Referenced by osg::TextureBackground::clear(), and osg::TextureBackground::updateGrid().

00194 {
00195     return _sfRadialDistortion.getValue();
00196 }

const Real32 & osg::TextureBackgroundBase::getRadialDistortion void   )  const [inline]