IViewportShaderManager Class Reference
 
 
 
IViewportShaderManager Class Reference

#include <IViewportManager.h>

Inheritance diagram for IViewportShaderManager:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators IViewportShaderManager2 IViewportShaderManager3

Class Description

An Interface class to access the Viewport Manager.

This Interface allows access to the various components of the Viewport Manager. THis includes finding out how many effects are registered with the system

Public Types

enum   {
  get_num_effects, get_active_effect, is_effect_active, is_manager_active,
  get_effect_name, set_effect, activate_effect
}

Public Member Functions

FPInterfaceDesc GetDesc ()
virtual int  GetNumEffects ()=0
  Get the number of effects registered with the system.
virtual ReferenceTarget GetActiveEffect ()=0
  Get the current active effect.
virtual const MCHAR *  GetEffectName (int i)=0
  Access the UI name for the effect.
virtual ReferenceTarget SetViewportEffect (int i)=0
  Set the actual viewport effect to be used.
virtual void  ActivateEffect (MtlBase *mtl, BOOL State)=0
  Turns on the effect based on the material and state supplied.

Member Enumeration Documentation


Member Function Documentation

FPInterfaceDesc* GetDesc ( ) [virtual]
Remarks:
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual int GetNumEffects ( ) [pure virtual]

Get the number of effects registered with the system.

Returns:
The total number of effects
virtual ReferenceTarget* GetActiveEffect ( ) [pure virtual]

Get the current active effect.

This effect will implement the IDXDataBridge classes

Returns:
A referenceTarget implementing the effect
virtual const MCHAR* GetEffectName ( int  i ) [pure virtual]

Access the UI name for the effect.

Parameters:
i An index of the effect whose name is required
Returns:
A MCHAR containing the name
virtual ReferenceTarget* SetViewportEffect ( int  i ) [pure virtual]

Set the actual viewport effect to be used.

Parameters:
i An index of the effect to set.
Returns:
A pointer to the effect
virtual void ActivateEffect ( MtlBase mtl,
BOOL  State 
) [pure virtual]

Turns on the effect based on the material and state supplied.

THis sets the internal flag on the material that tells the system that a DX shader is present

Parameters:
*mtl THe material to activate
State A boolean value that defines the state of the flag