osg::StateChunkClass Class Reference
[OpenGL State Handling]

The classification class for StateChunks, see StateChunkClass for a description. More...

#include <OSGStateChunk.h>

List of all members.

Class Access
typedef std::vector < std::string > ::const_iterator	iterator
static const Char8 *	getName (UInt32 index)
static Int32	getNumSlots (UInt32 index)
static UInt32	getUsedSlots (void)
static iterator	begin ()
static iterator	end ()
Public Member Functions
Constructor
	StateChunkClass (Char8 *name, UInt32 numslots=1)
Instance Access
UInt32	getId (void) const
const Char8 *	getName (void) const
Int32	getNumSlots (void) const
Protected Member Functions
void	swap (StateChunkClass &other)
Private Attributes
UInt32	_classId
Static Private Attributes
static std::vector< std::string > *	_classNames = NULL
static std::vector< UInt32 > *	_numslots = NULL
Friends
class	TextureTransformChunk

---

Detailed Description

See StateChunkClass for the conceptual background.

Definition at line 60 of file OSGStateChunk.h.

---

Member Typedef Documentation

osg::StateChunkClass::iterator

Iterator type to access the chunk class list.

Definition at line 88 of file OSGStateChunk.h.

---

Constructor & Destructor Documentation

StateChunkClass::StateChunkClass	(	Char8 *	name,
		UInt32	numslots = 1
	)

Constructor. The name is mandatory, the number of concurrently active slots is optional, default is 1.

Definition at line 106 of file OSGStateChunk.cpp.

References _classId, _classNames, and _numslots.

{
    if(!_classNames)
    {
        _classNames = new std::vector<std::string>(0);
        _numslots   = new std::vector<     UInt32>(0);
    }

    _classId = _classNames->size();

    for(unsigned i = 0; i < numslots; i++)
    {
        _classNames->push_back(std::string(name));
        _numslots->push_back (numslots);
    }
}

---

Member Function Documentation

UInt32 StateChunkClass::getId

(

void

)

const

Definition at line 123 of file OSGStateChunk.cpp.

References _classId.

Referenced by osg::State::chunkPresent(), osg::StateChunk::getClassId(), osg::VertexProgramChunk::getStaticClassId(), osg::TransformChunk::getStaticClassId(), osg::TextureTransformChunk::getStaticClassId(), osg::TextureChunk::getStaticClassId(), osg::TexGenChunk::getStaticClassId(), osg::StencilChunk::getStaticClassId(), osg::StateChunk::getStaticClassId(), osg::SHLChunk::getStaticClassId(), osg::SClipPlaneChunk::getStaticClassId(), osg::RegisterCombinersChunk::getStaticClassId(), osg::ProgramChunk::getStaticClassId(), osg::PolygonChunk::getStaticClassId(), osg::PointChunk::getStaticClassId(), osg::MaterialChunk::getStaticClassId(), osg::LogicOpChunk::getStaticClassId(), osg::LineChunk::getStaticClassId(), osg::LightModelChunk::getStaticClassId(), osg::LightChunk::getStaticClassId(), osg::FragmentProgramChunk::getStaticClassId(), osg::DepthChunk::getStaticClassId(), osg::CubeTextureChunk::getStaticClassId(), osg::ColorMaskChunk::getStaticClassId(), osg::ClipPlaneChunk::getStaticClassId(), osg::BlendChunk::getStaticClassId(), and swap().

{
    return _classId;
}

const Char8 * StateChunkClass::getName

(

void

)

const

Definition at line 128 of file OSGStateChunk.cpp.

References _classId, and _classNames.

Referenced by swap().

{
    return(*_classNames)[_classId].c_str();
}

Int32 StateChunkClass::getNumSlots

(

void

)

const

Definition at line 133 of file OSGStateChunk.cpp.

References _classId, and _numslots.

Referenced by osg::State::activate(), osg::State::changeFrom(), osg::State::chunkPresent(), osg::State::deactivate(), osg::State::subChunk(), and swap().

{
    return(*_numslots)[_classId];
}

const Char8 * StateChunkClass::getName

(

UInt32

index

)

[static]

Access the name for the class whose id is index.

Definition at line 141 of file OSGStateChunk.cpp.

References _classNames.

{
    if(index >=(*_classNames).size())
            return "<Unknown StatChunkClass!>";

    return(*_classNames)[index].c_str();
}

Int32 StateChunkClass::getNumSlots

(

UInt32

index

)

[static]

Access the number of slots for the class whose id is index.

Definition at line 152 of file OSGStateChunk.cpp.

References _numslots.

{
    if(index >= (*_numslots).size())
        return -1;

    return (*_numslots)[index];
}

UInt32 osg::StateChunkClass::getUsedSlots

(

void

)

[inline, static]

Iterator type to access the chunk class list.

Definition at line 68 of file OSGStateChunk.inl.

References _numslots.

{
    return StateChunkClass::_numslots->size();
}

StateChunkClass::iterator StateChunkClass::begin

(

void

)

[static]

Iterator to allow access to all known StateChunkClasses.

Definition at line 168 of file OSGStateChunk.cpp.

References _classNames.

{
    return _classNames->begin();
}

StateChunkClass::iterator StateChunkClass::end

(

void

)

[static]

Iterator to allow access to all known StateChunkClasses.

Definition at line 176 of file OSGStateChunk.cpp.

References _classNames.

{
    return _classNames->end();
}

void StateChunkClass::swap

(

StateChunkClass &

other

)

[protected]

Definition at line 181 of file OSGStateChunk.cpp.

References _classId, FINFO, FWARNING, getId(), getName(), and getNumSlots().

Referenced by osg::TextureTransformChunk::checkTexChunkOrder().

{
    FINFO(("Swap %s(%d|%d) %s(%d|%d)\n",
           this->getName(),
           this->getId(),
           this->getNumSlots(),
           other.getName(),
           other.getId(),
           other.getNumSlots()));

    bool bNeighborSwap = false;

    if(this->getNumSlots() != other.getNumSlots())
    {
        if( ( (this->getId() < other.getId() &&
               this->getId() + this->getNumSlots() != other.getId()) ||
              (other.getId() < this->getId() &&
               other.getId() + other.getNumSlots() != this->getId())  ) )
        {
            FWARNING(("Can only swap if #slots is equal or if"
                      "the chunks are neighbors\n"));
            return;
        }
        else
        {
            bNeighborSwap = true;
        }
    }

    std::string thisName      = this->getName    ();
    UInt32      thisNumSlots  = this->getNumSlots();

    std::string otherName     = other.getName    ();
    UInt32      otherNumSlots = other.getNumSlots();

    if(bNeighborSwap == false)
    {
        UInt32 tmp;

        tmp            = this->_classId;
        this->_classId = other._classId;
        other._classId = tmp;
    }
    else
    {
        if(this->_classId < other._classId)
        {
            other._classId  = this->_classId;
            this->_classId += otherNumSlots;
        }
        else
        {
            this->_classId  = other._classId;
            other._classId += thisNumSlots;
       }
    }

    for(UInt32 i = this->getId(); 
               i < this->getId() + thisNumSlots;
             ++i)
    { 
        (*_classNames)[i] = thisName;
        (*_numslots  )[i] = thisNumSlots;
    }

    for(UInt32 i = other.getId(); 
               i < other.getId() + otherNumSlots;
             ++i)
    { 
        (*_classNames)[i] = otherName;
        (*_numslots  )[i] = otherNumSlots;
    }
}

---

Friends And Related Function Documentation

friend class TextureTransformChunk [friend]

Definition at line 98 of file OSGStateChunk.h.

---

Member Data Documentation

osg::StateChunkClass::_classId [private]

The numerical ID associated with each StateChunkClass. It is used to uniquely identify and quickly compare the class.

Dev: The classId is consecutive in the number of slots allocated to the chunk class, i.e. if a class has id 4 and 4 chunks, the next registered class will get id 8. The classId is used as an index into the osg::State's chunk vector, which necessitates this behaviour.

Definition at line 104 of file OSGStateChunk.h.

Referenced by getId(), getName(), getNumSlots(), StateChunkClass(), and swap().

std::vector< std::string > * StateChunkClass::_classNames = NULL [static, private]

The global vector of known StateChunkClasses' names. Use StateChunkClass::getName with the Classes ID to access it.

Dev: See the osg::StateChunkClass::_classId for details.

Definition at line 105 of file OSGStateChunk.h.

Referenced by begin(), end(), getName(), and StateChunkClass().

std::vector< UInt32 > * StateChunkClass::_numslots = NULL [static, private]

The global vector of known StateChunkClasses' number of concurrently active slots. Use StateChunkClass::getNumSlots with the Class's ID to access it.

Dev: See the osg::StateChunkClass::_classId for details.

Definition at line 106 of file OSGStateChunk.h.

Referenced by getNumSlots(), getUsedSlots(), and StateChunkClass().

---

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

• OSGStateChunk.h
• OSGStateChunk.cpp
• OSGStateChunk.inl