This reference page is linked to from the following overview topics: Plug-in Base Classes, Accessing Material Properties, Changing Bitmap Texture Map Gamma.

Detailed Description

See also:: Class Texmap, Class StdUVGen, Class TextureOutput.

Description:: This class is an interface into the Bitmap texture. All methods of this class are implemented by the system.

#include <stdmat.h>

Inheritance diagram for BitmapTex:

[legend]

List of all members.

Public Member Functions
BEGIN_FUNCTION_MAP	VFN_0 (bitmaptex_reload, fnReload)
	VFN_0 (bitmaptex_crop, fnViewImage)
virtual END_FUNCTION_MAP void	SetFilterType (int ft)=0
virtual void	SetAlphaSource (int as)=0
virtual void	SetEndCondition (int endcond)=0
virtual void	SetAlphaAsMono (BOOL onoff)=0
virtual void	SetAlphaAsRGB (BOOL onoff)=0
virtual void	SetPremultAlpha (BOOL onoff)=0
virtual void	SetMapName (const MCHAR *name, bool isUIAction=false)=0
	Changes the name of the bitmap file.
virtual void	SetMap (const MaxSDK::AssetManagement::AssetUser &asset, bool isUIAction=false)=0
	Change the bitmap file.
virtual void	SetStartTime (TimeValue t)=0
virtual void	SetPlaybackRate (float r)=0
virtual int	GetFilterType ()=0
virtual int	GetAlphaSource ()=0
virtual int	GetEndCondition ()=0
virtual BOOL	GetAlphaAsMono (BOOL onoff)=0
virtual BOOL	GetAlphaAsRGB (BOOL onoff)=0
virtual BOOL	GetPremultAlpha (BOOL onoff)=0
virtual MCHAR *	GetMapName ()=0
virtual const MaxSDK::AssetManagement::AssetUser &	GetMap ()=0
virtual TimeValue	GetStartTime ()=0
virtual float	GetPlaybackRate ()=0
virtual StdUVGen *	GetUVGen ()=0
virtual TextureOutput *	GetTexout ()=0
virtual void	SetBitmap (Bitmap *bm)
virtual Bitmap *	GetBitmap (TimeValue t)
virtual void	BitmapLoadDlg ()
virtual void	ReloadBitmapAndUpdate ()
FPInterfaceDesc *	GetDesc ()
virtual void	fnReload ()=0
virtual void	fnViewImage ()=0
virtual void	SetBitmapInfo (const BitmapInfo &)

Member Function Documentation

BEGIN_FUNCTION_MAP VFN_0	(	bitmaptex_reload	,
		fnReload
	)

Search for all occurrences

VFN_0	(	bitmaptex_crop	,
		fnViewImage
	)

Search for all occurrences

virtual END_FUNCTION_MAP void SetFilterType ( int ft ) [pure virtual]

Search for all occurrences

Remarks:: Sets the bitmap filtering method used.

Parameters:: int ft

Image filtering types. One of the following values:

FILTER_PYR

Pyramidal.

FILTER_SAT

Summed Area.

FILTER_NADA

None.

virtual void SetAlphaSource ( int as ) [pure virtual]

Search for all occurrences

Remarks:: This method may be used to set the alpha source for the bitmap.

Parameters:: int as

Alpha source types. One of the following values:

ALPHA_FILE

Image alpha (if present).

ALPHA_RGB

RGB Intensity.

ALPHA_NONE

None (opaque).

virtual void SetEndCondition ( int endcond ) [pure virtual]

Search for all occurrences

Remarks:: Sets the end condition setting.

Parameters:: int endcond

The end condition. One of the following values:

END_LOOP

END_PINGPONG

END_HOLD

virtual void SetAlphaAsMono ( BOOL onoff ) [pure virtual]

Search for all occurrences

Remarks:: The Mono Channel Intensity may be either RGB Intensity or Alpha.

Parameters:: BOOL onoff

TRUE for Alpha; FALSE for RGB Intensity.

virtual void SetAlphaAsRGB ( BOOL onoff ) [pure virtual]

Search for all occurrences

Remarks:: The Alpha Source may be either from the RGB channels or Image Alpha channel.

Parameters:: BOOL onoff

TRUE for RGB; FALSE for Alpha channel.

virtual void SetPremultAlpha ( BOOL onoff ) [pure virtual]

Search for all occurrences

virtual void SetMapName	(	const MCHAR *	name,
		bool	isUIAction = `false`
	)		`[pure virtual]`

Search for all occurrences

Changes the name of the bitmap file.

Changes the file name of the image to be used.

Parameters:

[in]	name	- The new file name.
[in]	isUIAction	- Should be set to true if and only if the renaming of the file is the result of a UI action from the user. When this is set to true, the bitmap texture may, for example, display a dialog asking the user whether the map should be cached by the bitmap proxy system.

virtual void SetMap	(	const MaxSDK::AssetManagement::AssetUser &	asset,
		bool	isUIAction = `false`
	)		`[pure virtual]`

Search for all occurrences

Change the bitmap file.

Changes the asset to be used.

Parameters:

[in]	asset	- The new asset.
[in]	isUIAction	- Should be set to true if and only if the renaming of the file is the result of a UI action from the user. When this is set to true, the bitmap texture may, for example, display a dialog asking the user whether the map should be cached by the bitmap proxy system.

virtual void SetStartTime ( TimeValue t ) [pure virtual]

Search for all occurrences

Remarks:: Sets the start time setting.

Parameters:: TimeValue t

The new start time.

virtual void SetPlaybackRate ( float r ) [pure virtual]

Search for all occurrences

Remarks:: Sets the playback rate setting.

Parameters:: float r

The new playback rate. This is frames of the bitmap per frame of rendering time. If the value is 1 then you are playing 1 frame for every render frame. If it is 0.5 then the bitmap frame is held for 2 rendering frames.

virtual int GetFilterType ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the filter type.

Returns:: One of the following values:

FILTER_PYR

Pyramidal.

FILTER_SAT

Summed Area Table.

FILTER_NADA

None.

virtual int GetAlphaSource ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the alpha source.

Returns:: One of the following values:

ALPHA_FILE

ALPHA_RGB

ALPHA_NONE

virtual int GetEndCondition ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the end condition setting.

Returns:: One of the following values:

END_LOOP

END_PINGPONG

END_HOLD

virtual BOOL GetAlphaAsMono ( BOOL onoff ) [pure virtual]

Search for all occurrences

Remarks:: The Mono Channel Intensity may be either RGB Intensity or Alpha.

Parameters:: BOOL onoff

This parameter is ignored.

Returns:: TRUE if Alpha; FALSE if RGB Intensity.

virtual BOOL GetAlphaAsRGB ( BOOL onoff ) [pure virtual]

Search for all occurrences

Remarks:: The Alpha Channel may be either RGB or Image Alpha.

Parameters:: BOOL onoff

This parameter is ignored.

Returns:: TRUE for RGB; FALSE for Image Alpha.

virtual BOOL GetPremultAlpha ( BOOL onoff ) [pure virtual]

Search for all occurrences

virtual MCHAR* GetMapName ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the name of the bitmap file.

virtual const MaxSDK::AssetManagement::AssetUser& GetMap ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns an AssetUser of the bitmap file.

virtual TimeValue GetStartTime ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the start frame setting as a TimeValue.

virtual float GetPlaybackRate ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns the playback rate setting.

virtual StdUVGen* GetUVGen ( ) [pure virtual]

Search for all occurrences

Remarks:: Retrieves a pointer to the StdUVGen interface for this bitmap. This allows access to the mapping parameters such as UV offsets, blur, angle, noise level, etc.; Retrieves a pointer to the StdUVGen interface for this bitmap. This allows access to the mapping parameters such as UV offsets, blur, angle, noise level, etc.

virtual TextureOutput* GetTexout ( ) [pure virtual]

Search for all occurrences

Remarks:: Returns a pointer to a class to access TextureOutput properties of this texture.

virtual void SetBitmap ( Bitmap * bm ) [inline, virtual]

Search for all occurrences

Remarks:: This will swap the bitmap pointer without updating BitmapInfo.

Parameters:: Bitmap *bm

A pointer to the bitmap.

Default Implementation:: { }

{}

virtual Bitmap* GetBitmap ( TimeValue t ) [inline, virtual]

Search for all occurrences

Remarks:: Returns a pointer to the Bitmap associated with this Bitmap Texture.

Parameters:: TimeValue t

The time at which to return the bitmap.

{ return NULL; }

virtual void BitmapLoadDlg ( ) [inline, virtual]

Search for all occurrences

Remarks:: This method brings up a bitmap loader dialog.

Default Implementation:: { return 0; }

{ }

virtual void ReloadBitmapAndUpdate ( ) [inline, virtual]

Search for all occurrences

Remarks:: This method forces the bitmap to reload and the view to be redrawn.

Default Implementation:: { return 0; }

{ }

FPInterfaceDesc* GetDesc ( ) [virtual]

Search for all occurrences

Remarks:: Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual void fnReload ( ) [pure virtual]

Search for all occurrences

Remarks:: This method reloads the bitmap texture and operates as if the user pressed the reload button.

virtual void fnViewImage ( ) [pure virtual]

Search for all occurrences

Remarks:: This method will view the bitmap texture image and operates as if the user pressed the view image button.

virtual void SetBitmapInfo ( const BitmapInfo & ) [inline, virtual]

Search for all occurrences

Remarks:: This method will update the bitmap name and layer information of the texture with the information from the BitmapInfo structure

{ }

BitmapTex Class Reference

Detailed Description

Public Member Functions

Member Function Documentation