IGameMorpher Class Reference

IGameMorpher Class Referenceabstract

#include <IGameModifier.h>

Class Description

An IGame wrapper around the Morph Compound Object and the Morpher Modifier.

+ Inheritance diagram for IGameMorpher:

Public Types

enum  MorphType { MORPHER_OBJECT, MORPHER_MODIFIER }
 A morph type. More...
 
- Public Types inherited from IGameModifier
enum  ModType { IGAME_SKINNING, IGAME_MORPHER, IGAME_GENERAL }
 IGame modifier types. More...
 

Public Member Functions

virtual int GetNumberOfMorphTargets ()=0
 Get the number of morph targets. More...
 
virtual IGameNodeGetMorphTarget (int index)=0
 Get the morph target used by the morpher. More...
 
virtual IGameControlGetMorphWeight (int index)=0
 Get the weight associated with the target. More...
 
virtual MorphType GetMorphType ()=0
 Get the morpher type. More...
 
 IGameMorpher (Modifier *mod, INode *node)
 The IGameMorpher constructor. More...
 
- Public Member Functions inherited from IGameModifier
 IGameModifier (Modifier *mod, INode *node)
 The IGameModifier constructor. More...
 
virtual ModType GetModifierType ()=0
 Get IGameModifier type. More...
 
virtual const MCHARGetUIName ()
 Get the modifier Name. More...
 
virtual const MCHARGetInternalName ()
 Get the modifier Name. More...
 
virtual ModifierGetMaxModifier ()
 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 IPropertyContainerGetIPropertyContainer ()
 Retrieve the Property Container. More...
 
virtual bool IsEntitySupported ()
 Is the Entity directly supported. More...
 
virtual const MCHARGetClassName ()=0
 Retrieves the name of the entity class. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Member Enumeration Documentation

enum MorphType

A morph type.

This provides details about the type of morph operator being accessed

Enumerator
MORPHER_OBJECT 

A Morph Compound Object.

MORPHER_MODIFIER 

A Morph Modifier.

273  {
276  };
A Morph Compound Object.
Definition: IGameModifier.h:274
A Morph Modifier.
Definition: IGameModifier.h:275

Constructor & Destructor Documentation

IGameMorpher ( Modifier mod,
INode node 
)
inline

The IGameMorpher constructor.

Parameters
*modThe 3ds Max modifier to initialise
*nodeThe 3ds Max node to initialise
315 :IGameModifier(mod, node){};
IGameModifier(Modifier *mod, INode *node)
The IGameModifier constructor.

Member Function Documentation

virtual int GetNumberOfMorphTargets ( )
pure virtual

Get the number of morph targets.

The number of targets used by the morpher. There is a slight difference between the morph methods. The compound morpher include the original object as a target, where as the morpher modifier only show the actual physical targets. So to provide the same result the compound will show one more target

Returns
The number of morph targets
virtual IGameNode* GetMorphTarget ( int  index)
pure virtual

Get the morph target used by the morpher.

This method provides the actual morph target used by the system. In the case of the compound object, it does its best to find the node but, the compound morpher only exposes the actual "Object" and in 3ds Max the object could have multiple nodes.

Parameters
indexThe index of the target to retrieve
Returns
An IGameNode representing the target
virtual IGameControl* GetMorphWeight ( int  index)
pure virtual

Get the weight associated with the target.

Parameters
indexThe index of the target whose weight is being accessed
Returns
An IGameControl. The actual value of the keys provides the weight value - this value can not be consider normalised
virtual MorphType GetMorphType ( )
pure virtual

Get the morpher type.

The type of morpher represented by this interface

Returns
The morpher type. It can be one of the following
MORPHER_OBJECT
MORPHER_MODIFIER
See also
IGameMorpher::MorphType