modstack.h File Reference

#include "coreexp.h"
#include "maxtypes.h"
#include "object.h"

Classes
class	IDerivedObject
class	GeomPipelineEnumProc
class	NotifyCollapseEnumProc
class	NotifyCollapseMaintainCustAttribEnumProc
	Class used by EnumGeomPipeline to notify the pipeline of a collapse as well as maintaing the Custom Attributes. (Obsolete) More...
class	NotifyCollapseMaintainCustAttribEnumProc2
	Class used by EnumGeomPipeline to notify the pipeline of a collapse as well as maintaing the Custom Attributes. More...

Enumerations
enum	PipeEnumResult { PIPE_ENUM_CONTINUE, PIPE_ENUM_STOP }

Functions
CoreExport IDerivedObject *	CreateWSDerivedObject (Object *pob=NULL)
CoreExport IDerivedObject *	CreateDerivedObject (Object *pob=NULL)
CoreExport int	EnumGeomPipeline (GeomPipelineEnumProc *gpep, INode *start, bool includeEmptyDOs=false)
CoreExport int	EnumGeomPipeline (GeomPipelineEnumProc *gpep, Object *start, bool includeEmptyDOs=false)
CoreExport int	EnumGeomPipeline (GeomPipelineEnumProc *gpep, IDerivedObject *start, int modIndex=0, bool includeEmptyDOs=false)

Variables
CoreExport Class_ID	derivObjClassID
CoreExport Class_ID	WSMDerivObjClassID

Enumeration Type Documentation

enum PipeEnumResult

Enumerator
PIPE_ENUM_CONTINUE
PIPE_ENUM_STOP

                    {
    PIPE_ENUM_CONTINUE,
    PIPE_ENUM_STOP
};

Function Documentation

CoreExport IDerivedObject* CreateWSDerivedObject

(

Object *

pob = NULL

)

Remarks

This method creates a world space derived object.

Parameters:

Object *pob=NULL

If non-NULL then the WS derived object will be set up to reference this object.

Returns

A pointer to the derived object.

CoreExport IDerivedObject* CreateDerivedObject

(

Object *

pob = NULL

)

Remarks

This method creates an object space derived object.

Parameters:

Object *pob=NULL

If non-NULL then the derived object will be set up to reference this object.

Returns

A pointer to the derived object.

CoreExport int EnumGeomPipeline	(	GeomPipelineEnumProc *	gpep,
		INode *	start,
		bool	includeEmptyDOs = false
	)

Remarks

The global function begins an enumeration of the geometry pipeline using the specified node.

Parameters:

GeomPipelineEnumProc *gpep

Points to the callback object to process the enumeration.

INode *start

Points to the node to start the enumeration.

bool includeEmptyDOs = false

In case the flag includeEmptyDOs is declared as true, the proc will be called even for DerivedObjects, that don't contain any modifiers. In that case the object pointer will be NULL, the derObj pointer will contain the DerivedObject and the index will be -1.

Returns

One of the following values:

PIPE_ENUM_CONTINUE

PIPE_ENUM_STOP

CoreExport int EnumGeomPipeline	(	GeomPipelineEnumProc *	gpep,
		Object *	start,
		bool	includeEmptyDOs = false
	)

Remarks

The global function begins an enumeration of the geometry pipeline using the specified object.

Parameters:

GeomPipelineEnumProc *gpep

Points to the callback object to process the enumeration.

Object *start

Points to the object to start the enumeration.

bool includeEmptyDOs = false

In case the flag includeEmptyDOs is declared as true, the proc will be called even for DerivedObjects, that don't contain any modifiers. In that case the object pointer will be NULL, the derObj pointer will contain the DerivedObject and the index will be -1.

Returns

One of the following values:

PIPE_ENUM_CONTINUE

PIPE_ENUM_STOP

CoreExport int EnumGeomPipeline	(	GeomPipelineEnumProc *	gpep,
		IDerivedObject *	start,
		int	modIndex = 0,
		bool	includeEmptyDOs = false
	)

Remarks

The global function begins an enumeration of the geometry pipeline using the specified derived object and modifier index. The caller of this method has to provide the IDerviedObject the Modifier is applied to and the index of the Modifier in the IDerivedObject. Developers can use the method Modifier::GetIDerivedObject() in order to get the IDerviedObject and the index, given a modifier and a ModContext.

Parameters:

GeomPipelineEnumProc *gpep

Points to the callback object to process the enumeration.

IDerivedObject *start

Points to the derived object to start the enumeration.

int modIndex = 0

The zero based index of the modifier in the derived object to start with.

bool includeEmptyDOs = false

In case the flag includeEmptyDOs is declared as true, the proc will be called even for DerivedObjects, that don't contain any modifiers. In that case the object pointer will be NULL, the derObj pointer will contain the DerivedObject and the index will be -1.

Returns

One of the following values:

PIPE_ENUM_CONTINUE

PIPE_ENUM_STOP

Variable Documentation

CoreExport Class_ID derivObjClassID

CoreExport Class_ID WSMDerivObjClassID