ClipNode.h

Go to the documentation of this file.

/* -*-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_CLIPNODE
#define OSG_CLIPNODE 1

#include <osg/Group>
#include <osg/ClipPlane>

namespace osg {

class OSG_EXPORT ClipNode : public Group
{

    public:

        typedef std::vector<ref_ptr<ClipPlane> > ClipPlaneList;


        ClipNode();

        ClipNode(const ClipNode& es, const CopyOp& copyop=CopyOp::SHALLOW_COPY);

        META_Node(osg, ClipNode);

        enum ReferenceFrame
        {
            RELATIVE_RF,
            ABSOLUTE_RF
        };

        void setReferenceFrame(ReferenceFrame rf);

        ReferenceFrame getReferenceFrame() const { return _referenceFrame; }


        void createClipBox(const BoundingBox& bb,unsigned int clipPlaneNumberBase=0);

        bool addClipPlane(ClipPlane* clipplane);

        bool removeClipPlane(ClipPlane* clipplane);

        bool removeClipPlane(unsigned int pos);

        inline unsigned int getNumClipPlanes() const { return _planes.size(); }


        inline ClipPlane* getClipPlane(unsigned int pos) { return _planes[pos].get(); }

        inline const ClipPlane* getClipPlane(unsigned int pos) const { return _planes[pos].get(); }

        inline void setClipPlaneList(const ClipPlaneList& cpl) { _planes=cpl; }

        inline ClipPlaneList& getClipPlaneList() { return _planes; }

        inline const ClipPlaneList& getClipPlaneList() const { return _planes; }

        void setStateSetModes(StateSet&,StateAttribute::GLModeValue) const;

        void setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON);

        virtual BoundingSphere computeBound() const;

    protected:

        virtual ~ClipNode();

        StateAttribute::GLModeValue     _value;
        ClipPlaneList                   _planes;

        ReferenceFrame                  _referenceFrame;
};

}

#endif