IGameModifier Class Reference

#include <IGameModifier.h>

Class Description

Simple wrapper for 3ds Max modifiers.

This is an IGame wrapper for the basic 3ds Max modifier class. This is provided so that the developer does not need to walk the modifier stack and look for derived objects. An instance of this class is obtained from IGameObject class

See also

IGameObject

Inheritance diagram for IGameModifier:

Public Types
enum	ModType { IGAME_SKINNING, IGAME_MORPHER, IGAME_GENERAL }
	IGame modifier types. More...

Public Member Functions
	IGameModifier (Modifier *mod, INode *node)
	The IGameModifier constructor. More...
virtual ModType	GetModifierType ()=0
	Get IGameModifier type. More...
virtual const MCHAR *	GetUIName ()
	Get the modifier Name. More...
virtual const MCHAR *	GetInternalName ()
	Get the modifier Name. More...
virtual Modifier *	GetMaxModifier ()
	Access to the 3ds Max modifier. More...
virtual void	EffectedNodes (Tab< INode * > &nodeList)
	Access to the nodes this modifier is applied to. More...
virtual bool	IsSkin ()
	Check whether the modifier is a skinning modifier. More...
virtual bool	IsMorpher ()
	Check whether the modifier is the morpher modifier. More...
virtual	~IGameModifier ()
Public Member Functions inherited from IExportEntity
virtual	~IExportEntity ()
	Destructor. More...
virtual IPropertyContainer *	GetIPropertyContainer ()
	Retrieve the Property Container. More...
virtual bool	IsEntitySupported ()
	Is the Entity directly supported. More...
virtual const MCHAR *	GetClassName ()=0
	Retrieves the name of the entity class. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Member Enumeration Documentation

enum ModType

IGame modifier types.

These are the modifiers known to IGame

Enumerator
IGAME_SKINNING	A skinning Modifier.
IGAME_MORPHER	A Morphing based Modifier/Object.
IGAME_GENERAL	A generic 3ds Max modifier.

                {
        IGAME_SKINNING, 
        IGAME_MORPHER,  
        IGAME_GENERAL,  
    };

Constructor & Destructor Documentation

IGameModifier	(	Modifier *	mod,
		INode *	node
	)

The IGameModifier constructor.

Parameters

*mod	The 3ds Max modifier to initialise
*node	The 3ds Max node to initialise

virtual ~IGameModifier ( )

virtual

Member Function Documentation

virtual ModType GetModifierType ( )

pure virtual

Get IGameModifier type.

Return the Type of Modifier IGameModifier represents

Returns

The modifier type, corresponds to IGameModifier::ModType Enum

virtual const MCHAR* GetUIName ( )

virtual

Get the modifier Name.

The name as viewed in StackView

Returns

The name

virtual const MCHAR* GetInternalName ( )

virtual

Get the modifier Name.

The internal name of the modifier

Returns

The name

virtual Modifier* GetMaxModifier ( )

virtual

Access to the 3ds Max modifier.

This is provided so the developer can get to any LocalModData that may have been added to the modifier

Returns

The pointer a standard max modifier.

virtual void EffectedNodes ( Tab< INode * > &  nodeList )

virtual

Access to the nodes this modifier is applied to.

This enumerates all the nodes that are effected by this modifier.

Parameters

&nodeList

The tab to receive the node list. This will always be at least 1 in size, as it will contain the original node.

virtual bool IsSkin ( )

virtual

Check whether the modifier is a skinning modifier.

Returns

TRUE if the modifier is a skinning modifier

virtual bool IsMorpher ( )

virtual

Check whether the modifier is the morpher modifier.

Returns

TRUE if the modifier is the morpher modifier