osg::OSGWriter Class Reference

Brief OSGWriter.

#include <OSGOSGWriter.h>

List of all members.

Member
FCInfoHelperMap	_visitedFCMap
StandardStringConversionState	_state
Indenter	_indent
std::ostream &	_outStream
void	visitContainer (const FieldContainerPtr pFC)
void	visitField (const Field *pF)
void	writeContainer (const FieldContainerPtr pFC)
void	writeField (const Field *pF, const FieldDescription *fieldDesc)
Public Member Functions
Constructors
	OSGWriter (std::ostream &stream, UInt32 indentStep=4)
Destructor
	~OSGWriter (void)
Write
void	write (FieldContainerPtr container)
void	write (std::vector< FieldContainerPtr > containers)
Protected Types
typedef std::map < FieldContainerPtr, FCInfoHelper >	FCInfoHelperMap
Static Protected Attributes
static const UInt32	DefaultSFWidth = TypeTraits<UInt32>::getMax()
static const UInt32	DefaultMFWidth = 60
Private Member Functions
	OSGWriter (const OSGWriter &source)
	prohibit default function (move to 'public' if needed)
void	operator= (const OSGWriter &source)
	prohibit default function (move to 'public' if needed)
Classes
struct	FCInfoHelper

---

Detailed Description

Definition at line 65 of file OSGOSGWriter.h.

---

Member Typedef Documentation

typedef std::map<FieldContainerPtr, FCInfoHelper> osg::OSGWriter::FCInfoHelperMap [protected]

Definition at line 109 of file OSGOSGWriter.h.

---

Constructor & Destructor Documentation

OSGWriter::OSGWriter	(	std::ostream &	stream,
		UInt32	indentStep = 4
	)

Constructor. Set members to initial values.

Definition at line 75 of file OSGOSGWriter.cpp.

                                                          :
    _visitedFCMap(                 ),
    _state       (0, DefaultSFWidth),
    _indent      (0, indentStep    ),
    _outStream   (stream           )
{
}

OSGWriter::~OSGWriter

(

void

)

Destructor. There are no dynamic members to destroy.

Definition at line 88 of file OSGOSGWriter.cpp.

{
}

osg::OSGWriter::OSGWriter

(

const OSGWriter &

source

)

[private]

---

Member Function Documentation

void OSGWriter::write

(

FieldContainerPtr

container

)

Write a single FieldContainer with all its "children", i.e. everything that can be reached via Ptr-Fields.

Definition at line 98 of file OSGOSGWriter.cpp.

References _indent, _outStream, _visitedFCMap, osg::Indenter::setIndent(), visitContainer(), and writeContainer().

Referenced by osg::OSGSceneFileType::write().

{
    _visitedFCMap.clear();
    _indent.setIndent(0);

    _outStream << "#OSG V1.0 " << std::endl;

    visitContainer(container);
    writeContainer(container);
}

void OSGWriter::write

(

std::vector< FieldContainerPtr >

containers

)

Write all FieldContainers in containers with their "children", i.e. everything that can be reached via Ptr-Fields.

Definition at line 113 of file OSGOSGWriter.cpp.

References _indent, _outStream, _visitedFCMap, osg::Indenter::setIndent(), visitContainer(), and writeContainer().

{
    _visitedFCMap.clear();
    _indent.setIndent(0);

    _outStream << "#OSG V1.0 " << std::endl;

    std::vector<FieldContainerPtr>::reverse_iterator iter;

    for(iter = containers.rbegin(); iter != containers.rend(); ++iter)
    {
        visitContainer( *iter );
    }

    for(iter = containers.rbegin(); iter != containers.rend(); ++iter)
    {
        writeContainer( *iter );
    }
}

void OSGWriter::visitContainer

(

const FieldContainerPtr

pFC

)

[protected]

Definition at line 166 of file OSGOSGWriter.cpp.

References _visitedFCMap, osg::FieldContainerType::getFieldDescription(), osg::FieldContainerType::getNumFieldDescs(), osg::FieldDescription::isInternal(), osg::NullFC, SWARNING, and visitField().

Referenced by visitField(), and write().

{

    if(pFC == NullFC)
    {
        return;
    }

    typedef std::pair<FCInfoHelperMap::iterator, bool> MapInsertInfo;

    std::string containerName;
    const FieldContainerType& fcType    = pFC->getType();
    UInt32              numFields = fcType.getNumFieldDescs();
    MapInsertInfo       insertInfo;

    insertInfo = _visitedFCMap.insert(std::make_pair(pFC, FCInfoHelper()));
    if(insertInfo.second == true)
    {
        //the FC was NOT visited before
        for(UInt32 field=1; field<=numFields; field++)
        {
            const FieldDescription* fieldDesc =
                fcType.getFieldDescription(field);
            if(fieldDesc->isInternal())
            {
                continue;
            }
            visitField(pFC->getField(field));
        }
    }
    else
    {
        //the FC was in the map => FC is shared
        FCInfoHelperMap::iterator iter = _visitedFCMap.find(pFC);
        if(iter == _visitedFCMap.end())
        {
            SWARNING << "OSGWriter::visitContainer(): FieldContainerPtr "
                     << "not found in map" << std::endl;
            return;
        }
        if(iter->second.hasName == false)
        {
            iter->second.setName(pFC);
            iter->second.hasName = true;
        }
    }
}

void OSGWriter::visitField

(

const Field *

pF

)

[protected]

Definition at line 214 of file OSGOSGWriter.cpp.

References osg::Field::getCardinality(), osg::TypeBase::getCName(), osg::Field::getType(), osg::SField< FieldTypeT, fieldNameSpace >::getValue(), osg::FieldType::MULTI_FIELD, osg::FieldType::SINGLE_FIELD, osg::MField< FieldTypeT, fieldNameSpace >::size(), and visitContainer().

Referenced by visitContainer().

{
    if(pF == NULL)
    {
        return;
    }

    const FieldType& fType       = pF->getType();
//    const DataType & contentType = pF->getContentType();

    //handle SFAttachmentMap as special case here
    //if(fType.isDerivedFrom(SFAttachmentMap::getClassType()))
    if(strstr(fType.getCName(), "AttachmentMap") != NULL)
    {
        //visit the Attachment FCs

        const SFAttachmentMap *sfAttMap = (const SFAttachmentMap*) pF;
              AttachmentMap    attMap   = sfAttMap->getValue();

        AttachmentMap::const_iterator iter = attMap.begin();
        AttachmentMap::const_iterator end  = attMap.end();

        for(; iter!=end; ++iter)
        {
            visitContainer(iter->second);
        }
    }
    //else if(contentType.isDerivedFrom(FieldContainerPtr::getClassType()))
    else if(strstr(fType.getCName(), "Ptr") != NULL)
    {
        //this Field points to FC

        //to access the content of a field one must know the cardinality
        if(pF->getCardinality() == FieldType::SINGLE_FIELD)
        {
            const SFFieldContainerPtr* sfFCPtr =
                (const SFFieldContainerPtr*) pF;
            visitContainer(sfFCPtr->getValue());
        }
        else if(pF->getCardinality() == FieldType::MULTI_FIELD)
        {
            const MFFieldContainerPtr* mfFCPtr =
                (const MFFieldContainerPtr*) pF;
            UInt32 mfSize = mfFCPtr->size();
            for(UInt32 i=0; i < mfSize; i++)
            {
                visitContainer((*(mfFCPtr))[i]);
            }
        }
    }
}

void OSGWriter::writeContainer

(

const FieldContainerPtr

pFC

)

[protected]

Definition at line 266 of file OSGOSGWriter.cpp.

References _indent, _outStream, _visitedFCMap, osg::FieldContainerType::getFieldDescription(), osg::FieldContainerType::getNumFieldDescs(), osg::FieldDescription::isInternal(), osg::NullFC, SWARNING, and writeField().

Referenced by write(), and writeField().

{
    if(pFC == NullFC)
    {
        return;
    }

    const FieldContainerType& fcType    = pFC->getType();
    UInt32              numFields = fcType.getNumFieldDescs();

    FCInfoHelperMap::iterator iter = _visitedFCMap.find(pFC);
    if(iter == _visitedFCMap.end())
    {
        SWARNING << "OSGWriter::writeContainer(): FieldContainerPtr "
                 << "not found in map" << std::endl;
        return;
    }

    if(!iter->second.written)
    {
        //FC is not written yet
        iter->second.written = true;
        if(iter->second.hasName)
        {
            _outStream << _indent                    << "DEF "
                       << iter->second.containerName << " "
                       << pFC->getTypeName()         << " {"
                       << std::endl;
        }
        else{
            _outStream << _indent <<  pFC->getTypeName() << " {"
                       << std::endl;
        }

        _indent++;

        for(UInt32 field=1; field<=numFields; field++)
        {
            const FieldDescription* fieldDesc =
                fcType.getFieldDescription(field);
            if(fieldDesc->isInternal())
            {
                continue;
            }
            writeField(pFC->getField(field), fieldDesc);
        }
        _indent--;
        _outStream << _indent << "}" << std::endl;
    }
    else
    {
        //FC is already written -> its shared -> write reference
        if(!iter->second.hasName)
        {
            SWARNING << "OSGWriter::writeContainer(): FieldContainer is "
                     << "shared, but not named"
                     << std::endl;
            return;
        }

        _outStream << _indent
                   << "USE "
                   << iter->second.containerName 
                   << std::endl;
    }

}

void OSGWriter::writeField	(	const Field *	pF,
		const FieldDescription *	fieldDesc
	)			[protected]

Definition at line 335 of file OSGOSGWriter.cpp.

References _indent, _outStream, _state, DefaultMFWidth, DefaultSFWidth, osg::Field::getCardinality(), osg::TypeBase::getCName(), osg::Indenter::getIndent(), osg::FieldDescription::getName(), osg::Field::getType(), osg::SField< FieldTypeT, fieldNameSpace >::getValue(), osg::Field::getValueByStr(), osg::FieldType::MULTI_FIELD, osg::NullFC, osg::StandardStringConversionState::setIndent(), osg::StandardStringConversionState::setWidth(), osg::FieldType::SINGLE_FIELD, osg::MField< FieldTypeT, fieldNameSpace >::size(), and writeContainer().

Referenced by writeContainer().

{

    if(pF == NULL)
    {
        return;
    }

    const FieldType& fType = pF->getType();
//    const DataType&  contentType = pF->getContentType();

    //handle SFAttachmentMap as special case here
    //if(fType.isDerivedFrom(SFAttachmentMap::getClassType()))
    if(strstr(fType.getCName(), "AttachmentMap") != NULL)
    {
        //write Attachments

        const SFAttachmentMap *sfAttMap = (const SFAttachmentMap*) pF;
              AttachmentMap    attMap   = sfAttMap->getValue();

        AttachmentMap::const_iterator iter = attMap.begin();
        AttachmentMap::const_iterator end  = attMap.end();

        _outStream << _indent << fieldDesc->getName() << " [ ";
        _indent++;
        _state.setIndent(_indent.getIndent());
        
        //if the Attachment Map is empty write [] as its content
        if(iter==end)
        {
            _outStream << " ] " << std::endl;
            _indent--; 
        }
        else
        {
            _outStream << std::endl;
        
            for(; iter!=end; ++iter)
            {
                if(iter->second->getInternal().getValue() != true)
                {
                    writeContainer(iter->second);
                }
            }
            _indent--; 
            
            _outStream << _indent << " ] " << std::endl;
        }
    }
    //else if(contentType.isDerivedFrom(FieldContainerPtr::getClassType()))
    else if(strstr(fType.getCName(), "Ptr") != NULL)
    {
        //this Field points to FC

        _state.setIndent(_indent.getIndent());
        _outStream << _indent << fieldDesc->getName();

        //to access the content of a field via a Field*
        //one must know the cardinality
        if(pF->getCardinality() == FieldType::SINGLE_FIELD)
        {
            const SFFieldContainerPtr* sfFCPtr =
                (const SFFieldContainerPtr*) pF;
            if(sfFCPtr->getValue() == NullFC)
            {
                _outStream << " NULL" << std::endl;
            }
            else
            {
                _outStream << std::endl;
                _indent++;
                writeContainer(sfFCPtr->getValue());
                _indent--;
            }
        }
        else if(pF->getCardinality() == FieldType::MULTI_FIELD)
        {
            _outStream << " [" << std::endl;
            _indent++;
            const MFFieldContainerPtr* mfFCPtr =
                (const MFFieldContainerPtr*) pF;
            UInt32 mfSize = mfFCPtr->size();
            for(UInt32 i=0; i < mfSize; i++)
            {
                if((*(mfFCPtr))[i] == NullFC)
                {
                    _outStream << _indent << "NULL" << std::endl;
                }
                else
                {
                    writeContainer((*(mfFCPtr))[i]);
                }
            }
            _indent--;
            _outStream << _indent << "]" << std::endl;
        }
    }
    else
    {
        //this Field contains data -> write it out

        _state.setIndent(_indent.getIndent());
        _outStream << _indent << fieldDesc->getName();

        std::string fieldValue;

        //to access the content of a field via a Field*
        //one must know the cardinality
        if(pF->getCardinality() == FieldType::SINGLE_FIELD)
        {
            _state.setIndent(0);
            _state.setWidth(DefaultSFWidth);
            pF->getValueByStr(fieldValue, _state);
            _outStream << " " << fieldValue << std::endl;
        }
        else if(pF->getCardinality() == FieldType::MULTI_FIELD)
        {
            _outStream << " [" << std::endl;

            _indent++;
            _state.setIndent(_indent.getIndent());
            _state.setWidth(DefaultMFWidth);
            pF->getValueByStr(fieldValue, _state);
            _outStream << fieldValue << std::endl;
            _indent--;

            _outStream << _indent << "]" << std::endl;
        }
    }
}

void osg::OSGWriter::operator=

(

const OSGWriter &

source

)

[private]

---

Member Data Documentation

const UInt32 OSGWriter::DefaultSFWidth = TypeTraits<UInt32>::getMax() [static, protected]

Definition at line 95 of file OSGOSGWriter.h.

Referenced by writeField().

const UInt32 OSGWriter::DefaultMFWidth = 60 [static, protected]

Definition at line 96 of file OSGOSGWriter.h.

Referenced by writeField().

FCInfoHelperMap osg::OSGWriter::_visitedFCMap [protected]

Definition at line 115 of file OSGOSGWriter.h.

Referenced by visitContainer(), write(), and writeContainer().

StandardStringConversionState osg::OSGWriter::_state [protected]

Definition at line 116 of file OSGOSGWriter.h.

Referenced by writeField().

Indenter osg::OSGWriter::_indent [protected]

Definition at line 117 of file OSGOSGWriter.h.

Referenced by write(), writeContainer(), and writeField().

std::ostream& osg::OSGWriter::_outStream [protected]

Definition at line 118 of file OSGOSGWriter.h.

Referenced by write(), writeContainer(), and writeField().

---

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

• OSGOSGWriter.h
• OSGOSGWriter.cpp