# class TextureTable

TextureTable keeps information on textures used while rendering. Note that the table will make sure that the names of objects added are unique within the table, and will rename objects with non-unique names.

# Properties

# Methods

# Static methods

# Properties details

# Name

The name of the TextureTable object. (Inherited from Object)

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

# 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( const spObject & item ) const;

int AddItem(spObject item);

int AddItem(item: spObject)

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

# AddTexture

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

rid AddTexture( const spTexture & texture ) const;

int AddTexture(spTexture texture);

int AddTexture(texture: spTexture)

# Clear

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

void Clear() const;

void Clear();

None Clear()

# Copy

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

void Copy( const spTable & src ) const;

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 ) const;

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 ) const;

int 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 ) const;

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 ) const;

int FindTextureId(string name);

int FindTextureId(name: str)

# FindTextureUsingAbsoluteFilePath

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

spTexture FindTextureUsingAbsoluteFilePath( const char * path ) const;

spTexture FindTextureUsingAbsoluteFilePath(string path);

spTexture FindTextureUsingAbsoluteFilePath(path: str)

# FindTextureUsingFilePath

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

spTexture FindTextureUsingFilePath( const char * path ) const;

spTexture FindTextureUsingFilePath(string path);

spTexture FindTextureUsingFilePath(path: str)

# FindTextureUsingPath

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

SGDEPRECATED spTexture FindTextureUsingPath( const char * path ) const;

spTexture FindTextureUsingPath(string path);

spTexture FindTextureUsingPath(path: str)

# GetClass

Get the name of the TextureTable class. (Inherited from Object)

spString GetClass() const;

string GetClass();

str GetClass()

# GetItem

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

spObject GetItem( rid id ) const;

spObject GetItem(int 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() const;

uint GetItemsCount();

int GetItemsCount()

# GetTexture

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

spTexture GetTexture( rid id ) const;

spTexture GetTexture(int id);

spTexture GetTexture(id: int)

# GetTexturesCount

Returns the number of textures in the table.

unsigned int GetTexturesCount() const;

uint GetTexturesCount();

int GetTexturesCount()

# IsA

Returns true if TextureTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

# IsNull

Returns true if the TextureTable object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

# IsSameObjectAs

Returns true if the TextureTable object is valid. (Inherited from Object)

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

# NonNull

Returns true if the TextureTable object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

# PrintInfo

Prints the content/info of the TextureTable object to the log. (Inherited from Object)

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

# 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 ) const;

void RemoveItem(int id);

None RemoveItem(id: int)

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

# RemoveTexture

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

void RemoveTexture( rid id ) const;

void RemoveTexture(int id);

None RemoveTexture(id: int)

# SetItem

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

void SetItem( rid id , const spObject & item ) const;

void SetItem(int id, spObject item);

None SetItem(id: int, item: spObject)

# SetTexture

Sets a texture in the table.

void SetTexture( rid id , const spTexture & texture ) const;

void SetTexture(int 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. (Inherited from Object)

static bool IsClassA( const char * type ) const;

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. (Inherited from Object)

static spTextureTable SafeCast( const spObject & object ) const;

static spTextureTable SafeCast(spObject object);

@staticmethod
spTextureTable SafeCast(object: spObject)