OpenSceneGraph/include/osg/Switch
Robert Osfield 6a67be2e32 Introduced CMake option OSG_PROVIDE_READFILE option that defaults to ON, but when switched to OFF disables the building of the osgDB::read*File() methods,
forcing users to use osgDB::readRef*File() methods.  The later is preferable as it closes a potential threading bug when using paging databases in conjunction
with the osgDB::Registry Object Cache.  This threading bug occurs when one thread gets an object from the Cache via an osgDB::read*File() call where only
a pointer to the object is passed back, so taking a reference to the object is delayed till it gets reassigned to a ref_ptr<>, but at the same time another
thread calls a flush of the Object Cache deleting this object as it's referenceCount is now zero.  Using osgDB::readREf*File() makes sure the a ref_ptr<> is
passed back and the referenceCount never goes to zero.

To ensure the OSG builds when OSG_PROVIDE_READFILE is to OFF the many cases of osgDB::read*File() usage had to be replaced with a ref_ptr<> osgDB::readRef*File()
usage.  The avoid this change causing lots of other client code to be rewritten to handle the use of ref_ptr<> in place of C pointer I introduced a serious of
templte methods in various class to adapt ref_ptr<> to the underly C pointer to be passed to old OSG API's, example of this is found in include/osg/Group:

    bool addChild(Node* child); // old method which can only be used with a Node*

    tempalte<class T> bool addChild(const osg::ref_ptr<T>& child) { return addChild(child.get()); } // adapter template method

These changes together cover 149 modified files, so it's a large submission. This extent of changes are warrent to make use of the Object Cache
and multi-threaded loaded more robust.



git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/branches/OpenSceneGraph-3.4@15165 16af8721-9629-0410-8352-f15c8da7e697
2015-10-22 14:14:53 +00:00

102 lines
3.0 KiB
C++

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#ifndef OSG_SWITCH
#define OSG_SWITCH 1
#include <osg/Group>
namespace osg {
/** Switch is a Group node that allows switching between children.
* Typical uses would be for objects which might need to be rendered
* differently at different times, for instance a switch could be used
* to represent the different states of a traffic light.
*/
class OSG_EXPORT Switch : public Group
{
public :
Switch();
/** Copy constructor using CopyOp to manage deep vs shallow copy. */
Switch(const Switch&,const CopyOp& copyop=CopyOp::SHALLOW_COPY);
virtual Switch* asSwitch() { return this; }
virtual const Switch* asSwitch() const { return this; }
META_Node(osg, Switch);
virtual void traverse(NodeVisitor& nv);
void setNewChildDefaultValue(bool value) { _newChildDefaultValue = value; }
bool getNewChildDefaultValue() const { return _newChildDefaultValue; }
using osg::Group::addChild;
using osg::Group::insertChild;
virtual bool addChild( Node *child );
virtual bool addChild( Node *child, bool value );
virtual bool insertChild( unsigned int index, Node *child );
virtual bool insertChild( unsigned int index, Node *child, bool value );
virtual bool removeChildren(unsigned int pos,unsigned int numChildrenToRemove);
void setValue(unsigned int pos,bool value);
bool getValue(unsigned int pos) const;
void setChildValue(const Node* child,bool value);
bool getChildValue(const Node* child) const;
/** Set all the children off (false), and set the new default child
* value to off (false). */
bool setAllChildrenOff();
/** Set all the children on (true), and set the new default child
* value to on (true). */
bool setAllChildrenOn();
/** Set a single child on, switch off all other children. */
bool setSingleChildOn(unsigned int pos);
typedef std::vector<bool> ValueList;
void setValueList(const ValueList& values) { _values=values; }
const ValueList& getValueList() const { return _values; }
virtual BoundingSphere computeBound() const;
protected :
virtual ~Switch() {}
// This is effectively a bit mask.
bool _newChildDefaultValue;
ValueList _values;
};
}
#endif