osg::DynFieldAttachment< AttachmentDescT > Class Template Reference
[Field Container]

#include <OSGAttachmentImpl.h>

List of all members.

General Fieldcontainer Declaration
virtual osg::FieldContainerType &	getType (void)
virtual const osg::FieldContainerType &	getType (void) const
virtual osg::FieldContainerPtr	shallowCopy (void) const
virtual osg::UInt32	getContainerSize (void) const
static osg::FieldContainerType &	getClassType (void)
static osg::UInt32	getClassTypeId (void)
static PtrType	create (void)
static PtrType	createEmpty (void)
Public Types
typedef DynFieldAttachment < AttachmentDescT >	Self
typedef AttachmentDescT::ParentPtr	ParentPtrType
typedef FCPtr< ParentPtrType, Self >	PtrType
Public Member Functions
Dynamic Field Access
UInt32	addField (const FieldDescription &fieldDesc)
void	subField (UInt32 fieldId)
Field *	getDynamicField (UInt32 index)
Clone
FieldContainerPtr	emptyCopy (void)
FieldContainerPtr	clone (void)
Dump
virtual void	dump (UInt32 uiIndent=0, const BitVector bvFlags=0) const
Protected Types
typedef AttachmentDescT::Parent	Inherited
Protected Member Functions
Constructors
	DynFieldAttachment (void)
	DynFieldAttachment (const DynFieldAttachment &source)
Destructors
virtual	~DynFieldAttachment (void)
Protected Attributes
Member
FieldContainerType	_localType
std::vector< Field * >	_dynFieldsV
Static Protected Attributes
Type information
static FieldContainerType	_type
Private Member Functions
void	operator= (const DynFieldAttachment &source)
	prohibit default functions (move to 'public' if needed)
Friends
class	FieldContainer

---

Detailed Description

template<class AttachmentDescT>
class osg::DynFieldAttachment< AttachmentDescT >

Template to build simple attachment classes which store an arbitrary number of fields.

Definition at line 382 of file OSGAttachmentImpl.h.

---

Member Typedef Documentation

template<class AttachmentDescT>

typedef DynFieldAttachment<AttachmentDescT> osg::DynFieldAttachment< AttachmentDescT >::Self

Definition at line 388 of file OSGAttachmentImpl.h.

template<class AttachmentDescT>

typedef AttachmentDescT::ParentPtr osg::DynFieldAttachment< AttachmentDescT >::ParentPtrType

Definition at line 390 of file OSGAttachmentImpl.h.

template<class AttachmentDescT>

typedef FCPtr<ParentPtrType, Self > osg::DynFieldAttachment< AttachmentDescT >::PtrType

Definition at line 392 of file OSGAttachmentImpl.h.

template<class AttachmentDescT>

typedef AttachmentDescT::Parent osg::DynFieldAttachment< AttachmentDescT >::Inherited [protected]

Definition at line 431 of file OSGAttachmentImpl.h.

---

Constructor & Destructor Documentation

template<class AttachmentDescT>

osg::DynFieldAttachment< AttachmentDescT >::DynFieldAttachment

(

void

)

[inline, protected]

Definition at line 471 of file OSGAttachmentImpl.inl.

                                                            :
     Inherited (     ),
    _localType (_type),
    _dynFieldsV(     )
{
}

template<class AttachmentDescT>

osg::DynFieldAttachment< AttachmentDescT >::DynFieldAttachment

(

const DynFieldAttachment< AttachmentDescT > &

source

)

[inline, protected]

Definition at line 479 of file OSGAttachmentImpl.inl.

                                      :

     Inherited ( source            ),
    _localType (_type              ),
    _dynFieldsV( source._dynFieldsV) // Do a real copy soon ;-)
{
}

template<class AttachmentDescT>

osg::DynFieldAttachment< AttachmentDescT >::~DynFieldAttachment

(

void

)

[inline, protected, virtual]

Definition at line 492 of file OSGAttachmentImpl.inl.

{
}

---

Member Function Documentation

template<class AttachmentDescT>

virtual osg ::FieldContainerType& osg::DynFieldAttachment< AttachmentDescT >::getType

(

void

)

[virtual]

Referenced by osg::DynFieldAttachment< AttachmentDescT >::dump().

template<class AttachmentDescT>

const FieldContainerType & osg::DynFieldAttachment< AttachmentDescT >::getType

(

void

)

const [inline, virtual]

Definition at line 318 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_localType.

{
    return _localType;
}

template<class AttachmentDescT>

static osg ::FieldContainerType& osg::DynFieldAttachment< AttachmentDescT >::getClassType

(

void

)

[static]

Referenced by osg::Image::attachmentCount(), osg::Image::findAttachmentField(), osg::VRMLNodeDesc::getFieldAndDesc(), osg::Image::hasAttachment(), and osg::Image::setAttachmentField().

template<class AttachmentDescT>

static osg ::UInt32 osg::DynFieldAttachment< AttachmentDescT >::getClassTypeId

(

void

)

[static]

template<class AttachmentDescT>

static PtrType osg::DynFieldAttachment< AttachmentDescT >::create

(

void

)

[static]

Referenced by osg::VRMLViewpointDesc::init(), osg::VRMLInlineDesc::init(), osg::VRMLExtrusionDesc::init(), osg::VRMLGroupDesc::init(), osg::VRMLSwitchDesc::init(), osg::VRMLLODDesc::init(), osg::VRMLAppearanceDesc::init(), osg::VRMLGeometryObjectDesc::init(), osg::VRMLGeometryPartDesc::init(), osg::VRMLGeometryPointSetDesc::init(), osg::VRMLGeometryDesc::init(), osg::VRMLShapeDesc::init(), osg::VRMLNodeDesc::init(), and osg::Image::setAttachmentField().

template<class AttachmentDescT>

static PtrType osg::DynFieldAttachment< AttachmentDescT >::createEmpty

(

void

)

[static]

template<class AttachmentDescT>

virtual osg ::FieldContainerPtr osg::DynFieldAttachment< AttachmentDescT >::shallowCopy

(

void

)

const [virtual]

template<class AttachmentDescT>

virtual osg ::UInt32 osg::DynFieldAttachment< AttachmentDescT >::getContainerSize

(

void

)

const [virtual]

template<class AttachmentDescT>

UInt32 osg::DynFieldAttachment< AttachmentDescT >::addField

(

const FieldDescription &

fieldDesc

)

[inline]

Definition at line 327 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_dynFieldsV, osg::DynFieldAttachment< AttachmentDescT >::_localType, osg::FieldContainerType::addDescription(), osg::FieldFactory::createField(), osg::FieldContainerType::getFieldDescription(), osg::FieldDescription::getTypeId(), osg::FieldDescription::setFieldId(), osg::FieldDescription::setFieldMask(), and osg::FieldFactory::the().

{
    UInt32            returnValue = 0;
    Field            *fieldP      = NULL;
    FieldDescription *descP       = NULL;

    returnValue = _localType.addDescription(fieldDesc);

    if(returnValue != 0)
    {
        descP = _localType.getFieldDescription(returnValue);

        if(descP != NULL)
        {
            descP->setFieldId  (returnValue);
            descP->setFieldMask(
                        TypeTraits<BitVector>::One << returnValue);

            fieldP = FieldFactory::the().createField(fieldDesc.getTypeId());

            if(_dynFieldsV.size() <=
               returnValue - Inherited::NextFieldId)
            {
                _dynFieldsV.resize((returnValue -
                                    Inherited::NextFieldId) + 1);
            }

            _dynFieldsV[returnValue - Inherited::NextFieldId] = fieldP;
        }
    }

    return returnValue;
}

template<class AttachmentDescT>

void osg::DynFieldAttachment< AttachmentDescT >::subField

(

UInt32

fieldId

)

[inline]

Definition at line 363 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_dynFieldsV, osg::DynFieldAttachment< AttachmentDescT >::_localType, and osg::FieldContainerType::subDescription().

{
    if(_localType.subDescription(fieldId) == true)
    {
        std::vector<Field *>::iterator vIt = _dynFieldsV.begin();

        vIt += fieldId - Inherited::NextFieldId;

        if(vIt != _dynFieldsV.end())
        {
            delete (*vIt);

            (*vIt) = NULL;
        }
    }
}

template<class AttachmentDescT>

Field * osg::DynFieldAttachment< AttachmentDescT >::getDynamicField

(

UInt32

index

)

[inline]

Definition at line 381 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_dynFieldsV.

Referenced by osg::VRMLViewpointDesc::init(), osg::VRMLNodeDesc::prototypeAddField(), and osg::Image::setAttachmentField().

{
    return _dynFieldsV[index - Inherited::NextFieldId];
}

template<class AttachmentDescT>

FieldContainerPtr osg::DynFieldAttachment< AttachmentDescT >::emptyCopy

(

void

)

[inline]

Definition at line 391 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_localType, osg::FieldContainerType::getFieldDescription(), and osg::FieldContainerType::getNumFieldDescs().

{
    PtrType returnValue = DynFieldAttachment<AttachmentDescT>::createEmpty();

    for(UInt32 i  = Inherited::NextFieldId;
               i <= _localType.getNumFieldDescs();
               i++)
    {
        returnValue->addField(*(_localType.getFieldDescription(i)));
    }

    return returnValue;
}

template<class AttachmentDescT>

FieldContainerPtr osg::DynFieldAttachment< AttachmentDescT >::clone

(

void

)

[inline]

Definition at line 406 of file OSGAttachmentImpl.inl.

References osg::DynFieldAttachment< AttachmentDescT >::_dynFieldsV, osg::DynFieldAttachment< AttachmentDescT >::_localType, osg::FieldContainerType::getFieldDescription(), and osg::FieldContainerType::getNumFieldDescs().

{
    PtrType returnValue = DynFieldAttachment<AttachmentDescT>::createEmpty();
    UInt32  i;

    for(i  = Inherited::NextFieldId;
        i <= _localType.getNumFieldDescs();
        i++)
    {
        returnValue->addField(*(_localType.getFieldDescription(i)));
    }

    for(i  = Inherited::NextFieldId;
        i <= _localType.getNumFieldDescs();
        i++)
    {
        returnValue->getDynamicField(i)->setAbstrValue(
            *(_dynFieldsV[i - Inherited::NextFieldId]));
    }

    return returnValue;
}

template<class AttachmentDescT>

void osg::DynFieldAttachment< AttachmentDescT >::dump	(	UInt32	uiIndent = 0,
		const BitVector	bvFlags = 0
	)			const [inline, virtual]

Definition at line 433 of file OSGAttachmentImpl.inl.

References osg::FieldDescription::getCName(), osg::FieldContainerType::getFieldDescription(), osg::FieldDescription::getFieldId(), osg::FieldContainerType::getNumFieldDescs(), osg::DynFieldAttachment< AttachmentDescT >::getType(), osg::indentLog(), and PLOG.

{
    PtrType thisP(*this);

    indentLog(uiIndent, PLOG);
    PLOG << "DynFieldAttachment"
         << "(" 
         << thisP.getFieldContainerId()
         << ")" 
         << std::endl;

    indentLog(uiIndent, PLOG);
    PLOG << "{" << std::endl;

    uiIndent += 4;

    for(UInt32 i = 1; i <= getType().getNumFieldDescs(); i++)
    {
        indentLog(uiIndent, PLOG);
        PLOG <<      getType().getFieldDescription(i)->getCName ()
             << " ("
             << const_cast<Self *>(this)->getField(
                     getType().getFieldDescription(i)->getFieldId())
             << ")"
             << std::endl;
    }

    uiIndent -= 4;

    indentLog(uiIndent, PLOG);
    PLOG << "}" << std::endl;
}

template<class AttachmentDescT>

void osg::DynFieldAttachment< AttachmentDescT >::operator=

(

const DynFieldAttachment< AttachmentDescT > &

source

)

[private]

---

Friends And Related Function Documentation

template<class AttachmentDescT>

friend class FieldContainer [friend]

Definition at line 468 of file OSGAttachmentImpl.h.

---

Member Data Documentation

template<class AttachmentDescT>

FieldContainerType osg::DynFieldAttachment< AttachmentDescT >::_type [static, protected]

Definition at line 437 of file OSGAttachmentImpl.h.

template<class AttachmentDescT>

FieldContainerType osg::DynFieldAttachment< AttachmentDescT >::_localType [protected]

Definition at line 444 of file OSGAttachmentImpl.h.

Referenced by osg::DynFieldAttachment< AttachmentDescT >::addField(), osg::DynFieldAttachment< AttachmentDescT >::clone(), osg::DynFieldAttachment< AttachmentDescT >::emptyCopy(), osg::DynFieldAttachment< AttachmentDescT >::getType(), and osg::DynFieldAttachment< AttachmentDescT >::subField().

template<class AttachmentDescT>

std::vector<Field *> osg::DynFieldAttachment< AttachmentDescT >::_dynFieldsV [protected]

Definition at line 446 of file OSGAttachmentImpl.h.

Referenced by osg::DynFieldAttachment< AttachmentDescT >::addField(), osg::DynFieldAttachment< AttachmentDescT >::clone(), osg::DynFieldAttachment< AttachmentDescT >::getDynamicField(), and osg::DynFieldAttachment< AttachmentDescT >::subField().

---

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

• OSGAttachmentImpl.h
• OSGAttachmentImpl.inl