nn::nex::SelectionIteratorTemplate Class

Syntax

template <class DO>
class SelectionIteratorTemplate : public nn::nex::IteratorOverDOs

Template Arguments

Name Description
DO Specifies a duplicated object class.

Description

Template class for enumerating the specified duplicated object classes.

This iterator template provides an iterator feature for repeatedly traversing only the specified duplicated object class. Using this class allows you to execute the same processes (such as physics calculations, AI, rendering process, and so on) repeatedly on all instances of a particular duplicated object class that exist in a session.

Although you may use this template directly, iterators have been typedefed for each duplicated object class under the name SelectionIterator, so you can also use this name. For example, the iterator for the Avatar class is Avatar::SelectionIterator.

Member Functions

SelectionIteratorTemplate Instructs the system to repeatedly traverse all instances of duplicated objects of the class specified by the template argument duplicated object and initializes an iterator.
operator-> Gets a pointer to the duplicated object pointed to by the current iterator.
operator * Gets a pointer to the duplicated object pointed to by the current iterator.
GetDOPtr Gets a pointer to the duplicated object pointed to by the current iterator.
GotoStart Forcibly returns the iterator to the start of the duplicated object list. (Inherits IteratorOverDOs)
GotoEnd Forcibly returns the iterator to the end of the duplicated object list. (Inherits IteratorOverDOs)
Count Gets the number of duplicated objects that the iterator repeats through. (Inherits IteratorOverDOs)
operator++ Advances the iterator to point to the next duplicated object. (Inherits IteratorOverDOs)
GetHandle Gets the duplicated object handle that this iterator is currently pointing to. (Inherits IteratorOverDOs)
EndReached Gets whether the iterator has arrived at the end of the list. (Inherits IteratorOverDOs)
Find Searches within this iterator for the duplicated object to be accessed by the given duplicated object handle. (Inherits IteratorOverDOs)

Class Hierarchy

nn::nex::RootObject
  nn::nex::IteratorOverDOs
    nn::nex::SelectionIteratorTemplate

Revision History

2011/01/28
Initial version.

CONFIDENTIAL