# class TextureTable

TextureTable keeps information on textures used while rendering.

# Methods

# Static methods

# Methods details

# AddItem

Adds an item to the table. The returned value is the id of the item within the table, which can be used to retrieve the item using GetItem().

rid AddItem( spObject item );

rid AddItem(spObject item);

int AddItem(item: spObject)

# AddTexture

Adds a texture to the table. The returned value is the id of the texture within the table.

rid AddTexture( spTexture texture );

rid AddTexture(spTexture texture);

int AddTexture(texture: spTexture)

# ChangeTexturePrefixPath

Changes the prefix path (drive, directory) of all matching texture paths in all the textures in the table, with the new one. This method is useful when external textures are placed in a specific folder, which needs to be moved.

void ChangeTexturePrefixPath( const char * current_path_prefix , const char * new_path_prefix );

void ChangeTexturePrefixPath(string current_path_prefix, string new_path_prefix);

None ChangeTexturePrefixPath(current_path_prefix: str, new_path_prefix: str)

# Clear

Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0.

void Clear();

void Clear();

None Clear()

# Copy

Clears the current table and copies the items from a source table.

void Copy( spTable src );

void Copy(spTable src);

None Copy(src: spTable)

# FindItem

Finds a named item in the table. If multiple items have the same name, the first will be returned. If no item was found, null will be returned.

spObject FindItem( const char * name );

spObject FindItem(string name);

spObject FindItem(name: str)

# FindItemId

Finds the id of an item in the table, using the name. If multiple items have the same name, the first will be returned. If no item was found, the return will be -1.

rid FindItemId( const char * name );

rid FindItemId(string name);

int FindItemId(name: str)

# FindTexture

Finds a texture in the table, using the texture name. If multiple textures have the same name, the first will be returned. If the texture was not found, null will be returned.

spTexture FindTexture( const char * name );

spTexture FindTexture(string name);

spTexture FindTexture(name: str)

# FindTextureId

Finds the id of a texture in the table, using the texture name. If multiple textures have the same name, the first will be returned. If the texture was not found, -1 will be returned.

rid FindTextureId( const char * name );

rid FindTextureId(string name);

int FindTextureId(name: str)

# FindTextureUsingPath

Finds a texture in the table, using the texture path. If multiple textures have the same path, the first will be returned. If the texture was not found, null will be returned.

spTexture FindTextureUsingPath( const char * path );

spTexture FindTextureUsingPath(string path);

spTexture FindTextureUsingPath(path: str)

# GetClass

Get the name of the TextureTable class.

spString GetClass();

string GetClass();

str GetClass()

# GetItem

Returns the i:th item, using the id of the item.

spObject GetItem( rid id );

spObject GetItem(rid id);

spObject GetItem(id: int)

# GetItemsCount

The number of item id:s in the table. If an item has been removed, using RemoveItem, the id is still counted in this method. GetIdsCount also equals the id that will be applied to the next item added to the table.

unsigned int GetItemsCount();

uint GetItemsCount();

int GetItemsCount()

# GetTexture

Returns the i:th texture, using the id of the texture.

spTexture GetTexture( rid id );

spTexture GetTexture(rid id);

spTexture GetTexture(id: int)

# GetTexturesCount

Returns the number of textures in the table.

unsigned int GetTexturesCount();

uint GetTexturesCount();

int GetTexturesCount()

# IsA

Returns true if TextureTable is a or is a descendant of the class named as the type parameter.

bool IsA( const char * type );

bool IsA(string type);

bool IsA(type: str)

# IsNull

Returns true if the TextureTable object is invalid.

bool IsNull();

bool IsNull();

bool IsNull()

# RemoveItem

Removes an item, and invalidates the id. The id will not point at a valid item, until Clear is called and new items are added up until the id.

void RemoveItem( rid id );

void RemoveItem(rid id);

None RemoveItem(id: int)

# RemoveTexture

Removes a texture. If GetTexture is called with the texture id, the value returned will be null.

void RemoveTexture( rid id );

void RemoveTexture(rid id);

None RemoveTexture(id: int)

# SetItem

Sets an item in the table. The id must exist in the table.

void SetItem( rid id , spObject item );

void SetItem(rid id, spObject item);

None SetItem(id: int, item: spObject)

# SetTexture

Sets a texture in the table.

void SetTexture( rid id , spTexture texture );

void SetTexture(rid id, spTexture texture);

None SetTexture(id: int, texture: spTexture)

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

static bool IsClassA( const char * type );

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spTextureTable, and if this is the case, returns the object cast into spTextureTable.

static spTextureTable SafeCast( spObject object );

static spTextureTable SafeCast(spObject object);

@staticmethod
spTextureTable SafeCast(object: spObject)