This reference page is linked to from the following overview topics: Textures, Sampling Texture Values, Layer Containers.

Detailed Description

This is a container class for simple textures.

In Mudbox, textures are confined to a 0 to 1 UV space. If an object has texture coordinates that go outside this 0-1 space, then multiple texture tiles are used to represent the texture, one tile per unit region in texture space. This class is a container for all the tiles that comprise a texture.

Mudbox also uses paint layers (where each layer would have the same number of tiles). An instance of the TexturePool class can therefore also be a LayerContainer. In this case it is possible to cast a TexturePool pointer into a pointer to a LayerContainer instance, and use the LayerContainer pointer to determine the number of layers and get them. Each pointer to a layer object can then be cast into a TexturePool object again, which then will be the physical paint layer. See the Material class documentation for more details.

Examples:: FixedFunctionMaterial/FixedFunctionMaterial.h, PtexExtractor/PtexPaintExporter.h, and PtexImporter/PtexImporter.h.

Definition at line 419 of file material.h.

#include <material.h>

Inheritance diagram for TexturePool:

[legend]

List of all members.

Public Types
enum	RenderMode { renderModeConstantColor, renderModeTexture, renderModeVertexColor }
enum	Location { locationUnknown, locationGPU, locationCPU, locationDisk }
enum	Usage { usagePaintLayer, usageLayerMask, usageAdjustmentLayer, usageUnknown }
Public Member Functions
virtual enum Usage	Usage () const
	A texture pool can have different usages.
virtual void	SetUsage (enum Usage eUsage)
	Sets the desired usage type for this texture pool. See TexturePool::Usage().
virtual QString	Name (void) const
	Returns the name of the texturepool.
virtual void	SetName (const QString &sName)
	Sets the name of the texture pool.
virtual unsigned int	RenderMode (void) const
	Returns the render mode of the texture pool. 0=constant color, 1=texture, 2=vertex color.
virtual void	SetRenderMode (unsigned int iMode)
	Sets the render mode for the texture pool.
virtual void	SetLocation (unsigned int iLocation)
	Sets the location for the texture pool.
virtual unsigned int	Location (void) const
	Gets the location for the texture pool.
virtual TexturePool &	operator= (TexturePool &cT)
virtual int	Width (void) const
	Returns the number of tiles in a row.
virtual void	SetWidth (int iWidth)
	Sets the number of tiles in a row.
virtual void	SetFileName (const QString &sFileName)
	Set the file name mask for the texture pool.
virtual const QString &	FileName (void) const
	Returns the file name mask for the texture pool.
virtual void	Save (const QString &sFileName="", const QString &sFormat="", Material *m=NULL, bool bForced=false)
	Saves the textures into files on the disk.
virtual void	Export (const QString &sFileName, const QString &sFormat="", Material *m=NULL)
	Exports the textures into files on the disk.
virtual void	SetDirty (bool bDirty)
	Sets the dirty status of the texture.
virtual bool	IsDirty (void) const
	Gets the dirty status of the texture.
virtual void	AddToDirtyArea (const Vector &cPoint)
	Adds a point to the dirty region of this texture pool.
virtual void	Reload (void)
	Reload the pool from the files based on the current file name mask.
virtual void	SetContentChanged (void)
	Sets a flag to say that the texturepool has been modified.
virtual bool	IsContentChanged (void)
	Returns true if the texturepool has been modified since the last file save.
virtual unsigned int	TileCount (void) const
	Returns the number of created tiles so far. These tiles can overlap.
virtual class Texture *	Tile (unsigned int iTileIndex)
	Returns a pointer to a specified tile. Do not delete this pointer.
virtual class Texture *	Tile (const AxisAlignedBoundingBox &cTCArea, bool bAlloc=true)
	Returns a texture tile for a coordinate range.
virtual class Texture *	Tile (float U, float V, bool bAlloc=true)
	Returns a texture tile for a coordinate.
virtual AxisAlignedBoundingBox	TileArea (unsigned int iTileIndex) const
	Returns the UV area associated with a tile.
TextureTileArray *	getTextureTileArray ()
virtual TextureMixer *	Mixer (void) const
	Returns a mixer object for the pool.
virtual int	BlendMode (void) const
	Returns the blending mode of the pool.
virtual void	SetBlendMode (int iMode)
	Sets the blending mode.
virtual void	SetMaterial (Material *pMaterial)
virtual Material *	GetMaterial () const
virtual TexturePool *	Buffer (void) const
	return the material associated with this texture pool.
virtual qint64	GPUMemoryUsageInBytes (void) const
	Returns the video memory usage in byte.
Protected Member Functions
	TexturePool (void)
	Constructor.
Protected Attributes
TextureTileArray	m_TextureTileArray

renderModeConstantColor	Search for all occurrences
renderModeTexture	Search for all occurrences
renderModeVertexColor	Search for all occurrences

locationUnknown	Search for all occurrences
locationGPU	Search for all occurrences
locationCPU	Search for all occurrences
locationDisk	Search for all occurrences

usagePaintLayer	Search for all occurrences
usageLayerMask	Search for all occurrences
usageAdjustmentLayer	Search for all occurrences
usageUnknown	Search for all occurrences

virtual void Save	(	const QString &	sFileName = `""`,
		const QString &	sFormat = `""`,
		Material *	m = `NULL`,
		bool	bForced = `false`
	)		`[virtual]`

[in]	sFileName	The file name to save
[in]	sFormat	The file format in the form "bitDepth,dataType", i.e. "8,i" for 8bit/channel integer. 8, 16, 32 are valid for bitdepth and i and fp are valid for dataType.
[in]	m	The material assciated with this texture pool.
[in]	bForced	If the save should happen regardless if the texture is dirty

virtual void Export	(	const QString &	sFileName,
		const QString &	sFormat = `""`,
		Material *	m = `NULL`
	)		`[virtual]`

virtual class Texture* Tile	(	const AxisAlignedBoundingBox &	cTCArea,
		bool	bAlloc = `true`
	)		`[virtual]`

[in]	cTCArea	The UV area that corresponds to the desired texture.
[in]	bAlloc	Set this to true to guarantee the returned Texture is loaded onto the GPU.

virtual class Texture* Tile	(	float	U,
		float	V,
		bool	bAlloc = `true`
	)		`[virtual]`

TexturePool Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation