Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
PluginFunctions::ObjectIterator Class Reference

Core Data Iterator. More...

#include <OpenFlipper/BasePlugin/PluginFunctions.hh>

Public Types

typedef BaseObjectData value_type
 type of the Objects the iterator works on
typedef BaseObjectDatavalue_handle
 handle type (just an int)
typedef value_typereference
 reference type
typedef value_typepointer
 basic pointer type

Public Member Functions

 ObjectIterator (IteratorRestriction _restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
 Use this constructor for iterating through your data. More...
 ObjectIterator (BaseObjectData *pos, IteratorRestriction _restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
 additional constructor starting at a given position
 operator value_handle ()
 return the current position of the iterator
bool operator== (const ObjectIterator &_rhs) const
 compare iterators
bool operator!= (const ObjectIterator &_rhs) const
 compare iterators
ObjectIteratoroperator= (const ObjectIterator &_rhs)
 assign iterators
pointer operator-> ()
ObjectIteratoroperator++ ()
 next element
ObjectIteratoroperator-- ()
 last element
BaseObjectDataoperator* ()
 dereference the iterator More...
BaseObjectDataindex ()
 return current position of the iterator

Private Member Functions

void proceedToNextBaseObjectData (BaseObject *&_object)

Private Attributes

 current position of the iterator
DataType dataType_
 returned data types of the iterator
IteratorRestriction restriction_
 Restriction of the iterator.

Detailed Description

Core Data Iterator.

This is the core iterator for the whole framework. You should use this iterator to access your data.
You can choose if the iterator returns only Target, Source or all objects.
Additionally you can set the type of objects returned by the iterator. The ObjectIterator will only return real Objects. Groups are not considered to be objects

Definition at line 452 of file PluginFunctions.hh.

Constructor & Destructor Documentation

PluginFunctions::ObjectIterator::ObjectIterator ( IteratorRestriction  _restriction = ALL_OBJECTS,
DataType  _dataType = DATA_ALL 

Use this constructor for iterating through your data.

_restrictionUse this parameter to define which objects will be returned.
_dataTypeUse this parameter to select the returned object types. You can use DATA_ALL DATA_POLY_MESH DATA_TRIANGLE_MESH DATA_VOLUME

Definition at line 66 of file

Member Function Documentation

BaseObjectData * PluginFunctions::ObjectIterator::operator* ( )

dereference the iterator

This operator returns a pointer to the current object the iterator points to.

Pointer to the current ObjectData

Definition at line 182 of file

void PluginFunctions::ObjectIterator::proceedToNextBaseObjectData ( BaseObject *&  _object)

Takes an object and goes through the object tree to the next BaseObjectData It stops at the root node.

Definition at line 191 of file

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