Public Types | Public Member Functions

IGameModifier Class Reference

This reference page is linked to from the following overview topics: 3DXI Modifiers.


Search for all occurrences

Detailed 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

#include <IGameModifier.h>

Inheritance diagram for IGameModifier:
Inheritance graph
[legend]

List of all members.

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.
virtual ModType  GetModifierType ()=0
  Get IGameModifier type.
virtual MCHAR *  GetUIName ()
  Get the modifier Name.
virtual MCHAR *  GetInternalName ()
  Get the modifier Name.
virtual Modifier GetMaxModifier ()
  Access to the 3ds Max modifier.
virtual void  EffectedNodes (Tab< INode * > &nodeList)
  Access to the nodes this modifier is applied to.
virtual bool  IsSkin ()
  Check whether the modifier is a skinning modifier.
virtual bool  IsMorpher ()
  Check whether the modifier is the morpher modifier.
virtual  ~IGameModifier ()

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.


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 MCHAR* GetUIName ( ) [virtual]

Get the modifier Name.

The name as viewed in StackView

Returns:
The name
virtual 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

IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier
IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier IGameModifier