class MaterialTable ​

MaterialTable keeps information on materials 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 MaterialTable 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)

AddMaterial ​

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

rid AddMaterial( const spMaterial & material ) const;

int AddMaterial(spMaterial material);

int AddMaterial(material: spMaterial)

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)

ChangeTexturePrefixPath ​

Changes the prefix path (drive, directory) of all matching texture paths in all the materials 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 * currentPathPrefix , const char * newPathPrefix ) const;

void ChangeTexturePrefixPath(string currentPathPrefix, string newPathPrefix);

None ChangeTexturePrefixPath(currentPathPrefix: str, newPathPrefix: 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() 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)

FindIdenticalMaterial ​

Finds a material in the table that is setup identical to the specified material.

spMaterial FindIdenticalMaterial( const spMaterial & mat ) const;

spMaterial FindIdenticalMaterial(spMaterial mat);

spMaterial FindIdenticalMaterial(mat: spMaterial)

FindIdenticalMaterialId ​

Finds the id of a material in the table that is setup identical to the specified material.

rid FindIdenticalMaterialId( const spMaterial & mat ) const;

int FindIdenticalMaterialId(spMaterial mat);

int FindIdenticalMaterialId(mat: spMaterial)

FindIdenticalMaterialIds ​

Finds the materials in the table that are setup identical to the specified material.

spRidArray FindIdenticalMaterialIds( const spMaterial & mat ) const;

spRidArray FindIdenticalMaterialIds(spMaterial mat);

spRidArray FindIdenticalMaterialIds(mat: spMaterial)

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)

FindMaterial ​

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

spMaterial FindMaterial( const char * name ) const;

spMaterial FindMaterial(string name);

spMaterial FindMaterial(name: str)

FindMaterialId ​

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

rid FindMaterialId( const char * name ) const;

int FindMaterialId(string name);

int FindMaterialId(name: str)

GetClass ​

Get the name of the MaterialTable 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()

GetMaterial ​

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

spMaterial GetMaterial( rid id ) const;

spMaterial GetMaterial(int id);

spMaterial GetMaterial(id: int)

GetMaterialChannels ​

Get all unique material channel names for all materials in table.

void GetMaterialChannels( const spStringArray & channels ) const;

void GetMaterialChannels(spStringArray channels);

None GetMaterialChannels(channels: spStringArray)

GetMaterialChannelsWithTextureInputs ​

Get all unique material channel names having texture inputs for all materials in table.

void GetMaterialChannelsWithTextureInputs( const spStringArray & channels ) const;

void GetMaterialChannelsWithTextureInputs(spStringArray channels);

None GetMaterialChannelsWithTextureInputs(channels: spStringArray)

GetMaterialsCount ​

Returns the number of materials in the table.

unsigned int GetMaterialsCount() const;

uint GetMaterialsCount();

int GetMaterialsCount()

IsA ​

Returns true if MaterialTable 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 MaterialTable object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

Returns true if the MaterialTable 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 MaterialTable object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

Prints the content/info of the MaterialTable 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)

RemoveMaterial ​

Removes a material. If GetMaterial is subsequently called with the same material id, the value returned will be null.

void RemoveMaterial( rid id ) const;

void RemoveMaterial(int id);

None RemoveMaterial(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)

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)

SetMaterial ​

Sets a material in the table.

void SetMaterial( rid id , const spMaterial & material ) const;

void SetMaterial(int id, spMaterial material);

None SetMaterial(id: int, material: spMaterial)

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 spMaterialTable, and if this is the case, returns the object cast into spMaterialTable. (Inherited from Object)

static spMaterialTable SafeCast( const spObject & object ) const;

static spMaterialTable SafeCast(spObject object);

@staticmethod
spMaterialTable SafeCast(object: spObject)