IGameFXProperty Class Reference

#include <IGameFX.h>

Class Description

An interface that holds the data for an individual parameter in the D3D effect. This will include global parameters, samplers and transform data.

The IGameFX interface will try to match any parameter with its host data. For the DxMaterial this would be the paramblock that drives basic parameters. For the DxStdMtl the parameters are driven by the host StdMtl2, but all lighting data is patched in so a "binding" node can be access. A binding node is a max node that drives the data. For a light this could be position, direction, color, falloff and hotspot. The semantic will define the usage. A binding token will eventually be used to define by name where the parameter lives in the scenegraph

Deprecated:

From 3ds Max 2015 IGameFXProperty is deprecated. It no longer supports the newer Shader models or Nitrous. Please use the regular Microsoft DirectX SDK and supporting APIs to extract shader data.

Inheritance diagram for IGameFXProperty:

Public Types
enum	IGameFXPropUsage { IGAMEFX_GENERAL, IGAMEFX_SAMPLER, IGAMEFX_LIGHT, IGAMEFX_TEXTURE }

Public Member Functions
MAX_DEPRECATED	~IGameFXProperty ()
	Destructor. More...
MAX_DEPRECATED IGameProperty *	GetIGameProperty ()
	Get the IGameProperty of the effect property. More...
MAX_DEPRECATED IGameFXPropUsage	GetPropertyUsage ()
	This defines what the property is - General means a basic parameter, Sampler means a texture sampler. you can use this to determine whether pipe state exist. More...
MAX_DEPRECATED const MCHAR *	GetFXSemantic ()
	Get the semantic for the parameter. More...
MAX_DEPRECATED int	GetNumberOfFXAnnotations ()
	The number of annotations for the parameter. More...
MAX_DEPRECATED bool	GetFXAnnotation (int index, MSTR *languageType, MSTR *key, MSTR *value)
	A key/Value pair defining the name of value of the annotation. The High level language type id also provided. More...
MAX_DEPRECATED const MCHAR *	GetFXDefaultValue ()
	the default value of the parameter if supplied More...
MAX_DEPRECATED int	GetNumberofFXPipeStates ()
	The number of render states values the parameter has. This would typicaly be based on a Sampler. More...
MAX_DEPRECATED bool	GetPipeStates (int index, MSTR *key, MSTR *value)
	The key/value pair of any pipeline states supported in the effect. At the parameter level this will usually be a Sampler. More...
MAX_DEPRECATED const MCHAR *	GetPropertyName ()
	The name of the property fround in the effect file. More...
MAX_DEPRECATED const MCHAR *	GetPropertyType ()
	The type of the property e.g. float4, int, bool etc.. More...
MAX_DEPRECATED IGameNode *	GetBindingNode ()
	Get the Binding Node. 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 IGameFXPropUsage

Enumerator
IGAMEFX_GENERAL	General property, such a a float or transform param.
IGAMEFX_SAMPLER	A texture sampler, will propabaly have a pipe state.
IGAMEFX_LIGHT	A light property - a binding node is used.
IGAMEFX_TEXTURE	A Texture property - this would be a Bitmap in max.

                         {
        IGAMEFX_GENERAL,    
        IGAMEFX_SAMPLER,    
        IGAMEFX_LIGHT,      
        IGAMEFX_TEXTURE     
    };

Constructor & Destructor Documentation

MAX_DEPRECATED ~IGameFXProperty

(

)

Destructor.

Member Function Documentation

MAX_DEPRECATED IGameProperty* GetIGameProperty

(

)

Get the IGameProperty of the effect property.

The IGameFx interface will try to extract all relevant data between the host material and the effect. Any paramblock data that is used to drive the effect will be stored in an IGameProperty

MAX_DEPRECATED IGameFXPropUsage GetPropertyUsage

(

)

This defines what the property is - General means a basic parameter, Sampler means a texture sampler. you can use this to determine whether pipe state exist.

MAX_DEPRECATED const MCHAR* GetFXSemantic

(

)

Get the semantic for the parameter.

MAX_DEPRECATED int GetNumberOfFXAnnotations

(

)

The number of annotations for the parameter.

MAX_DEPRECATED bool GetFXAnnotation	(	int	index,
		MSTR *	languageType,
		MSTR *	key,
		MSTR *	value
	)

A key/Value pair defining the name of value of the annotation. The High level language type id also provided.

MAX_DEPRECATED const MCHAR* GetFXDefaultValue

(

)

the default value of the parameter if supplied

MAX_DEPRECATED int GetNumberofFXPipeStates

(

)

The number of render states values the parameter has. This would typicaly be based on a Sampler.

MAX_DEPRECATED bool GetPipeStates	(	int	index,
		MSTR *	key,
		MSTR *	value
	)

The key/value pair of any pipeline states supported in the effect. At the parameter level this will usually be a Sampler.

MAX_DEPRECATED const MCHAR* GetPropertyName

(

)

The name of the property fround in the effect file.

MAX_DEPRECATED const MCHAR* GetPropertyType

(

)

The type of the property e.g. float4, int, bool etc..

MAX_DEPRECATED IGameNode* GetBindingNode

(

)

Get the Binding Node.