IDxMaterial3 Class Reference

#include <IDxMaterial.h>

Inheritance diagram for IDxMaterial3:

Public Member Functions
virtual IEffectParser *	GetCurrentParser ()=0
	Access to the current active parser for the loaded effect file. More...
virtual INode *	GetLightNode (D3DXHANDLE handle)=0
	Get the active light node based on the D3DXHANDLE. More...
virtual IParameterManager *	GetCurrentParameterManager ()=0
	Get the active Parameter Manager. More...
virtual int	GetNumberOfTechniques ()=0
	Get total number of Techniques. More...
virtual const MCHAR *	GetTechniqueName (int index)=0
	Get the technique name. More...
virtual const MCHAR *	GetCurrentTechniqueName ()=0
	Get the active technique name. More...
virtual ILightManager *	GetCurrentLightManager ()=0
	Get the active light manager. More...
Public Member Functions inherited from IDxMaterial2
virtual int	GetBitmapMappingChannel (int index)=0
	Get the Mapping channel defined for the texture. More...
virtual BitmapTypes	GetBitmapUsage (int index)=0
	Get the usage of the bitmap. More...
virtual void	SetMappingChannel (int bitmapIndex, int mapChannel)=0
	Set the mapping channel for the bitmap. More...
Public Member Functions inherited from IDxMaterial
virtual void	ReloadDXEffect ()=0
	Reloads the current active effect. More...
virtual int	GetNumberOfEffectBitmaps ()=0
	Returns the number of bitmaps used by the currently loaded effect. More...
virtual PBBitmap *	GetEffectBitmap (int index)=0
	Gets the bitmap used by the effect. More...
virtual void	SetEffectBitmap (int index, PBBitmap *bmap)=0
	Set the bitmap used by the effect. More...
virtual const MaxSDK::AssetManagement::AssetUser &	GetEffectFile ()=0
	Get the Dx Effect file AssetUser. More...
virtual void	SetEffectFile (const MaxSDK::AssetManagement::AssetUser &file)=0
	Set the Dx Effect file AssetUser. More...
virtual PBBitmap *	GetSoftwareRenderBitmap ()=0
	Get the bitmap used for the software rendering overrride. More...
virtual void	SetSoftwareRenderBitmap (PBBitmap *bmap)=0
	Set the bitmap to be used by the Renderer. More...
virtual int	GetNumberOfLightParams ()=0
	Get the number of light based parameters. More...
virtual INode *	GetLightNode (int index)=0
	The actual node used by the parameter. More...
virtual const MCHAR *	GetLightParameterName (int index)=0
	The name of the parameter in the Effect file. More...
virtual LightSemantics	GetLightSemantic (int index)=0
	The light semantic as defined in the effect file. More...
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual FPInterfaceDesc *	GetDesc ()=0
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from IDxMaterial2
enum	BitmapTypes {   UNKNOWN_MAP, DIFFUSE_MAP, BUMP_MAP, SPECULAR_MAP,   OPACITY_MAP, DISPLACEMENT_MAP, LIGHTMAP_MAP, NORMAL_MAP,   REFLECTION_MAP }
Public Types inherited from IDxMaterial
enum	LightSemantics {   LIGHT_COLOR, LIGHT_DIRECTION, LIGHT_POSITION, LIGHT_FALLOFF,   LIGHT_HOTSPOT, LIGHT_ATTENUATION }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
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...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_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...
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Function Documentation

virtual IEffectParser* GetCurrentParser ( )

pure virtual

Access to the current active parser for the loaded effect file.

Returns

The current parser

virtual INode* GetLightNode ( D3DXHANDLE  handle )

pure virtual

Get the active light node based on the D3DXHANDLE.

Parameters

handle

The handle based on the effect file

Returns

The light node

virtual IParameterManager* GetCurrentParameterManager ( )

pure virtual

Get the active Parameter Manager.

Returns

The current parameter manager owned by the material

virtual int GetNumberOfTechniques ( )

pure virtual

Get total number of Techniques.

Returns the total number of validated techniques used by the DirectX Shader material

Returns

The number of techniques

virtual const MCHAR* GetTechniqueName ( int  index )

pure virtual

Get the technique name.

virtual const MCHAR* GetCurrentTechniqueName ( )

pure virtual

Get the active technique name.

virtual ILightManager* GetCurrentLightManager ( )

pure virtual

Get the active light manager.

Provides access to the light manager maintained by the material. This provides access to various light data like position, color and attenuation

Returns

The current active light manager