OpenSceneGraph/include/osg/ClipNode
Robert Osfield 12226e4371 Converted the instances of const built in types being returned from methods
and passed as paramters into straight forward non const built in types,
i.e. const bool foogbar(const int) becomes bool foobar(int).
2002-09-02 12:31:35 +00:00

79 lines
2.5 KiB
Plaintext

//C++ header - Open Scene Graph - Copyright (C) 1998-2002 Robert Osfield
//Distributed under the terms of the GNU Library General Public License (LGPL)
//as published by the Free Software Foundation.
#ifndef OSG_CLIPNODE
#define OSG_CLIPNODE 1
#include <osg/Group>
#include <osg/ClipPlane>
namespace osg {
/** Leaf Node for defining the position of ClipPlanes in the scene.*/
class SG_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);
/** Create a 6 clip planes to create a clip box.*/
void createClipBox(const BoundingBox& bb,unsigned int clipPlaneNumberBase=0);
/** Add a ClipPlane to a ClipNode. Return true if plane is added,
* return false if plane already exists in ClipNode, or clipplane is false.*/
bool addClipPlane(ClipPlane* clipplane);
/** Remove ClipPlane from a ClipNode. Return true if plane is removed,
* return false if plane does not exists in ClipNode.*/
bool removeClipPlane(ClipPlane* clipplane);
/** Remove ClipPlane, at specified index, from a ClipNode. Return true if plane is removed,
* return false if plane does not exists in ClipNode.*/
bool removeClipPlane(unsigned int pos);
/** return the number of ClipPlanes.*/
inline unsigned int getNumClipPlanes() const { return _planes.size(); }
/** Get ClipPlane at specificed index position.*/
inline ClipPlane* getClipPlane(unsigned int pos) { return _planes[pos].get(); }
/** Get const ClipPlane at specificed index position.*/
inline const ClipPlane* getClipPlane(unsigned int pos) const { return _planes[pos].get(); }
/** Get the ClipPlaneList.*/
inline ClipPlaneList& getClipPlaneList() { return _planes; }
/** Get the const ClipPlaneList.*/
inline const ClipPlaneList& getClipPlaneList() const { return _planes; }
/** Set the GLModes on StateSet associated with the ClipPlanes.*/
void setStateSetModes(StateSet&,StateAttribute::GLModeValue) const;
/** Set up the local StateSet */
void setLocalStateSetModes(StateAttribute::GLModeValue=StateAttribute::ON);
protected:
virtual ~ClipNode();
virtual bool computeBound() const;
StateAttribute::GLModeValue _value;
ClipPlaneList _planes;
};
}
#endif