Class: TSceneAttributeIterator

Declaration: SceneBundle.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Allows TSceneBundle clients to iterate through the list of extended attributes in the TSceneBundle. You iterate by calling TSceneAttributeIterator::Next until it returns NIL. The TSceneAttributeIterator accesses only the extended attributes (those that are descended from TGrafAttribute), not the standard attributes (each of which is accessed by its own TSceneBundle member function). For each attribute, the iterator returns a constant TGrafAttribute pointer. However, the attributes are actually descendants of TGrafAttribute, and you might need to invoke members of the particular TGrafAttribute derived class. If so, (1) determine the attribute's class by invoking its GetName member function, and (2) type cast the pointer into a pointer to the correct class. A TSceneAttributeIterator is created either by TSceneBundle::CreateSceneAttributeIterator or by a constructor.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSceneAttributeIterator::TSceneAttributeIterator

TSceneAttributeIterator (const TSceneBundle *)
TSceneAttributeIterator ()

Interface Category:

API.

Purpose:

Constructor that specifies which TSceneBundle to generate the iterator for.
Default constructor.

Calling Context:

Call this function directly.
Called by the stream-in operators. You can call this function directly.

Parameters:

const TSceneBundle * -The scene bundle to generate the iterator for.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSceneAttributeIterator::~TSceneAttributeIterator

virtual ~ TSceneAttributeIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSceneAttributeIterator::Reset

virtual void Reset ()

Interface Category:

API.

Purpose:

Resets the iterator to return the first extended attribute in its list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSceneAttributeIterator::First

virtual const TGrafAttribute * First ()

Interface Category:

API.

Purpose:

Returns the first extended attribute in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a constant pointer to a TGrafAttribute object that is the first extended attribute stored in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSceneAttributeIterator::Next

virtual const TGrafAttribute * Next ()

Interface Category:

API.

Purpose:

Returns the next extended attribute object stored in the list. After calling TSceneAttribute::First or TSceneAttribute::Reset, keep calling TSceneAttributeIterator::Next until NIL is returned in order to iterate over all members of the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a constant pointer to a TGrafAttribute object that is the next extended attribute stored in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.