class ShaderEvaluationFunctionTable ​

ShaderEvaluationFunctionTable keeps information on shader parameter used while setting up compute casting using the material evaluation shader.

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

The name of the ShaderEvaluationFunctionTable 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)

AddShaderEvaluationFunction ​

Adds details about the evaluation function to the table. The returned value of the shader evaluation function details

rid AddShaderEvaluationFunction( const spShaderEvaluationFunction & evalFunction ) const;

int AddShaderEvaluationFunction(spShaderEvaluationFunction evalFunction);

int AddShaderEvaluationFunction(evalFunction: spShaderEvaluationFunction)

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)

FindShaderEvaluationFunction ​

Finds a shader evaluation function in the table, using the shader evaluation function name. Note names are unique

spShaderEvaluationFunction FindShaderEvaluationFunction( const char * name ) const;

spShaderEvaluationFunction FindShaderEvaluationFunction(string name);

spShaderEvaluationFunction FindShaderEvaluationFunction(name: str)

FindShaderEvaluationFunctionId ​

Finds the id of a shader evaluation function in the table, using the shader evaluation function name. Note parameter shader evaluation function are unique.

rid FindShaderEvaluationFunctionId( const char * name ) const;

int FindShaderEvaluationFunctionId(string name);

int FindShaderEvaluationFunctionId(name: str)

GetClass ​

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

GetShaderEvaluationFunction ​

Returns the i:th shader evaluation function, using the id of the shader evaluation function .

spShaderEvaluationFunction GetShaderEvaluationFunction( rid id ) const;

spShaderEvaluationFunction GetShaderEvaluationFunction(int id);

spShaderEvaluationFunction GetShaderEvaluationFunction(id: int)

GetShaderEvaluationFunctionsCount ​

Returns the number of shader evaluation function in the table.

unsigned int GetShaderEvaluationFunctionsCount() const;

uint GetShaderEvaluationFunctionsCount();

int GetShaderEvaluationFunctionsCount()

IsA ​

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

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

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

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

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

RemoveShaderEvaluationFunction ​

Removes a shader evaluation function. If GetShaderEvaluationFunction is called with the shader evaluation function id, the value returned will be null.

void RemoveShaderEvaluationFunction( rid id ) const;

void RemoveShaderEvaluationFunction(int id);

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

SetShaderEvaluationFunction ​

Sets a shader evaluation function in the table.

void SetShaderEvaluationFunction( rid id , const spShaderEvaluationFunction & evalFunction ) const;

void SetShaderEvaluationFunction(int id, spShaderEvaluationFunction evalFunction);

None SetShaderEvaluationFunction(id: int, evalFunction: spShaderEvaluationFunction)

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

static spShaderEvaluationFunctionTable SafeCast( const spObject & object ) const;

static spShaderEvaluationFunctionTable SafeCast(spObject object);

@staticmethod
spShaderEvaluationFunctionTable SafeCast(object: spObject)