Detailed Description

See also:: Class InterfaceServer, Class INode, Class Object, Class Modifier, Class IDerivedObject, Class ModContext, Class NotifyCollapseEnumProc.

Description:: This class and its associated global functions are available in release 4.0 and later only.

This is the callback object for the global geometry pipeline enumeration functions. The single proc() method of this class is called as the enumeration takes place.

The following functions are not methods of this class but are available for use with it to begin the enumeration:

These all start a pipeline enumeration down the pipeline towards the baseobject and over the baseobjects' branches in case it is a compound object. A pipleine enumeration can be started from a Node, an Object or from a Modifier.

#include <modstack.h>

Inheritance diagram for GeomPipelineEnumProc:

[legend]

Public Member Functions
virtual PipeEnumResult	proc (ReferenceTarget object, IDerivedObject derObj, int index)=0

Member Function Documentation

virtual PipeEnumResult proc	(	ReferenceTarget *	object,
		IDerivedObject *	derObj,
		int	index
	)		`[pure virtual]`

Remarks:: This is the callback procedure for pipeline enumeration. The ReferenceTarget passed to the proc can be a Node, Modifier or Object. In case it is a Modifier the parameter derObj contains the DerivedObject and the index is the index of this modifier in the DerivedObject. In all other cases derObj is NULL and index is 0.

Parameters:: ReferenceTarget *object

Points to the item in the geometry pipeline. This can be a Node, Modifier or Object.

IDerivedObject *derObj

If object above is a Modifier this points to the derived object.

int index

If object aive is a Modifier this is the index of this modifier in the DerivedObject.

Returns:: One of the following values which determines how the enumeration proceeds:

PIPE_ENUM_CONTINUE

Specifies to continue the enumeration.

PIPE_ENUM_STOP

Specifies to halt the enumeration.