osg::GraphOp Class Reference
[Rendering Backend, Geometry]

#include <OSGGraphOp.h>

Inheritance diagram for osg::GraphOp:

List of all members.

Public Member Functions
Constructors
	GraphOp (const char *name="")
virtual GraphOp *	create (void)=0
Destructors
virtual	~GraphOp (void)
Parameters
virtual void	setParams (const std::string params)=0
virtual std::string	usage (void)=0
Main methods
virtual bool	traverse (NodePtr &root)
const std::string &	getName (void)
void	setName (const char *name)
Exclusion
void	addToExcludeList (NodePtr &node)
void	addToExcludeList (const std::string &name)
void	removeFromExcludeList (NodePtr &node)
void	removeFromExcludeList (const std::string &name)
void	clearExcludeList (void)
bool	isInExcludeListNodes (NodePtr &node)
bool	isInExcludeListNames (const std::string &name)
bool	isInExcludeList (NodePtr &node)
Static Public Member Functions
Class Get
static const char *	getClassname (void)
Protected Member Functions
virtual Action::ResultE	traverseEnter (NodePtr &node)=0
virtual Action::ResultE	traverseLeave (NodePtr &node, Action::ResultE res)=0
Protected Attributes
std::list< NodePtr >	_excludeListNodes
std::list< std::string >	_excludeListNames
Private Attributes
std::string	_name
Classes
class	ParamSet

---

Detailed Description

GraphOp class

A base class used to traverse geometries.

Parameters are generally passed using the setParams() method (or indirectly from constructing a GraphOpSeq via string) and follow the following conventions:

• Parameters are a key=value pair (e.g. max_polygons=1000). Note that there can be no spaces around the =, and that parameter values cannot contain spaces or ')' either right now.
• Special case: boolean parameters. If just the name is given, this is considered equivalent to True.
• Multiple parameters are separated by spaces.

Calling usage() gives a short textual desription of the purpose and parameters of a GraphOp.

Definition at line 60 of file OSGGraphOp.h.

---

Constructor & Destructor Documentation

GraphOp::GraphOp

(

const char *

name = ""

)

Definition at line 85 of file OSGGraphOp.cpp.

                                : 
    _name(name), _excludeListNodes(), _excludeListNames()
{
}

GraphOp::~GraphOp

(

void

)

[virtual]

Definition at line 90 of file OSGGraphOp.cpp.

{
}

---

Member Function Documentation

static const char* osg::GraphOp::getClassname

(

void

)

[inline, static]

Reimplemented in osg::GeoTypeGraphOp, osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SingleTypeGraphOp< Type >, osg::SplitGraphOp, osg::StripeGraphOp, osg::VerifyGeoGraphOp, osg::VerifyGraphOp, and osg::SingleTypeGraphOp< osg::Geometry >.

Definition at line 69 of file OSGGraphOp.h.

{ return "GraphOp"; };

virtual GraphOp* osg::GraphOp::create

(

void

)

[pure virtual]

Implemented in osg::GeoTypeGraphOp, osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SplitGraphOp, osg::StripeGraphOp, osg::VerifyGeoGraphOp, and osg::VerifyGraphOp.

Referenced by osg::GraphOpFactory::create().

virtual void osg::GraphOp::setParams

(

const std::string

params

)

[pure virtual]

Implemented in osg::GeoTypeGraphOp, osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SplitGraphOp, osg::StripeGraphOp, osg::VerifyGeoGraphOp, and osg::VerifyGraphOp.

Referenced by osg::GraphOpSeq::setGraphOps().

virtual std::string osg::GraphOp::usage

(

void

)

[pure virtual]

Implemented in osg::GeoTypeGraphOp, osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SplitGraphOp, osg::StripeGraphOp, osg::VerifyGeoGraphOp, and osg::VerifyGraphOp.

bool GraphOp::traverse

(

NodePtr &

root

)

[virtual]

Reimplemented in osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::SharePtrGraphOp, osg::SplitGraphOp, and osg::VerifyGraphOp.

Definition at line 94 of file OSGGraphOp.cpp.

References osg::Action::Continue, osg::osgTypedMethodFunctor1ObjPtrCPtrRef(), osg::osgTypedMethodFunctor2ObjPtrCPtrRef(), traverseEnter(), and traverseLeave().

Referenced by osg::VerifyGraphOp::traverse(), osg::MaterialMergeGraphOp::traverse(), and osg::MakeTransparentGraphOp::traverse().

{
    Action::ResultE res;
    res = ::traverse(node,
          osgTypedMethodFunctor1ObjPtrCPtrRef<Action::ResultE,
          GraphOp,
          NodePtr>(this,&GraphOp::traverseEnter),
          osgTypedMethodFunctor2ObjPtrCPtrRef<Action::ResultE,
          GraphOp,
          NodePtr,
          Action::ResultE>(this,&GraphOp::traverseLeave));

    if (res == Action::Continue) 
        return true;
    else 
        return false;
}

const std::string & GraphOp::getName

(

void

)

Definition at line 112 of file OSGGraphOp.cpp.

References _name.

Referenced by osg::GraphOpFactory::registerOp(), and osg::GraphOpFactory::unRegisterOp().

{
    return _name;
};

void GraphOp::setName

(

const char *

name

)

Definition at line 117 of file OSGGraphOp.cpp.

References _name.

{
    _name = name;
};

void GraphOp::addToExcludeList

(

NodePtr &

node

)

Definition at line 124 of file OSGGraphOp.cpp.

References _excludeListNodes, and isInExcludeListNodes().

Referenced by osg::MergeGraphOp::excludeListLeave(), and osg::GraphOpSeq::setGraphOps().

{
    if (!isInExcludeListNodes(node))
        _excludeListNodes.push_back(node);
}

void GraphOp::addToExcludeList

(

const std::string &

name

)

Definition at line 130 of file OSGGraphOp.cpp.

References _excludeListNames, and isInExcludeListNames().

{
    if (!isInExcludeListNames(name))
        _excludeListNames.push_back(name);
}

void GraphOp::removeFromExcludeList

(

NodePtr &

node

)

Definition at line 136 of file OSGGraphOp.cpp.

References _excludeListNodes.

{
    _excludeListNodes.remove(node);
}

void GraphOp::removeFromExcludeList

(

const std::string &

name

)

Definition at line 141 of file OSGGraphOp.cpp.

References _excludeListNames.

{
    _excludeListNames.remove(name);
}

void GraphOp::clearExcludeList

(

void

)

Definition at line 146 of file OSGGraphOp.cpp.

References _excludeListNames, and _excludeListNodes.

{
    _excludeListNames.clear();
    _excludeListNodes.clear();
}

bool GraphOp::isInExcludeListNodes

(

NodePtr &

node

)

Definition at line 152 of file OSGGraphOp.cpp.

References _excludeListNodes.

Referenced by addToExcludeList(), and isInExcludeList().

{
    std::list<NodePtr>::iterator list_iter;
    list_iter = std::find(_excludeListNodes.begin(),_excludeListNodes.end(),node);

    if (list_iter==_excludeListNodes.end()) 
        return false;
    else 
        return true;
}

bool GraphOp::isInExcludeListNames

(

const std::string &

name

)

Definition at line 163 of file OSGGraphOp.cpp.

References _excludeListNames.

Referenced by addToExcludeList(), and isInExcludeList().

{
    std::list<std::string>::iterator namelist_iter;
    namelist_iter = std::find(_excludeListNames.begin(),_excludeListNames.end(),name);

    if (namelist_iter==_excludeListNames.end()) 
        return false;
    else 
        return true;
}

bool GraphOp::isInExcludeList

(

NodePtr &

node

)

Definition at line 174 of file OSGGraphOp.cpp.

References osg::getName(), isInExcludeListNames(), and isInExcludeListNodes().

Referenced by osg::MergeGraphOp::processGeometries(), osg::MergeGraphOp::processGroups(), osg::MergeGraphOp::processTransformations(), osg::SplitGraphOp::splitNode(), and osg::SplitGraphOp::traverseLeave().

{
    if (isInExcludeListNodes(node) || (OSG::getName(node)!=NULL && isInExcludeListNames(OSG::getName(node))))
        return true;
    else
        return false;
}

virtual Action::ResultE osg::GraphOp::traverseEnter

(

NodePtr &

node

)

[protected, pure virtual]

Implemented in osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SingleTypeGraphOp< Type >, osg::SplitGraphOp, osg::VerifyGraphOp, and osg::SingleTypeGraphOp< osg::Geometry >.

Referenced by traverse().

virtual Action::ResultE osg::GraphOp::traverseLeave	(	NodePtr &	node,
		Action::ResultE	res
	)			[protected, pure virtual]

Implemented in osg::MakeTransparentGraphOp, osg::MaterialMergeGraphOp, osg::MergeGraphOp, osg::PruneGraphOp, osg::SharePtrGraphOp, osg::SingleTypeGraphOp< Type >, osg::SplitGraphOp, osg::VerifyGraphOp, and osg::SingleTypeGraphOp< osg::Geometry >.

Referenced by traverse().

---

Member Data Documentation

std::list<NodePtr> osg::GraphOp::_excludeListNodes [protected]

Definition at line 161 of file OSGGraphOp.h.

Referenced by addToExcludeList(), clearExcludeList(), isInExcludeListNodes(), osg::MergeGraphOp::mergeOnce(), and removeFromExcludeList().

std::list<std::string> osg::GraphOp::_excludeListNames [protected]

Definition at line 162 of file OSGGraphOp.h.

Referenced by addToExcludeList(), clearExcludeList(), isInExcludeListNames(), and removeFromExcludeList().

std::string osg::GraphOp::_name [private]

Definition at line 166 of file OSGGraphOp.h.

Referenced by getName(), and setName().

---

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

• OSGGraphOp.h
• OSGGraphOp.cpp