# class MaterialEvaluationShaderDefineTable

MaterialEvaluationShaderDefineTable keeps information on material Defines used while setting up compute casting using the material evaluation shader.

# Properties

Property Description
Name The name of the MaterialEvaluationShaderDefineTable object. (Inherited from Object)

# Methods

Method Description
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(). (Inherited from Table)
AddMaterialEvaluationShaderDefine Adds a MaterialEvaluationShaderDefine to the table. The returned value is the id of the MaterialEvaluationShaderDefine within the table.
AddObserver Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear Clears the table, and removes all items. If AddItem is called after Clear, the item ids will start over from 0. (Inherited from Table)
Copy Clears the current table and copies the items from a source table. (Inherited from Table)
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. (Inherited from Table)
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. (Inherited from Table)
FindMaterialEvaluationShaderDefine Finds a MaterialEvaluationShaderDefine in the table, using the MaterialEvaluationShaderDefine name. Note names are unique
FindMaterialEvaluationShaderDefineId Finds the id of a MaterialEvaluationShaderDefine in the table, using the MaterialEvaluationShaderDefine name. Note Define names are unique.
GetClass Get the name of the MaterialEvaluationShaderDefineTable class. (Inherited from Object)
GetItem Returns the i:th item, using the id of the item. (Inherited from Table)
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. (Inherited from Table)
GetMaterialEvaluationShaderDefine Returns the i:th MaterialEvaluationShaderDefine, using the id of the MaterialEvaluationShaderDefine.
GetMaterialEvaluationShaderDefinesCount Returns the number of MaterialEvaluationShaderDefine in the table.
IsA Returns true if MaterialEvaluationShaderDefineTable is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the MaterialEvaluationShaderDefineTable object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the MaterialEvaluationShaderDefineTable object is valid. (Inherited from Object)
NonNull Returns true if the MaterialEvaluationShaderDefineTable object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the MaterialEvaluationShaderDefineTable object to the log. (Inherited from Object)
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. (Inherited from Table)
RemoveMaterialEvaluationShaderDefine Removes a MaterialEvaluationShaderDefine. If GetMaterialEvaluationShaderDefine is called with the MaterialEvaluationShaderDefine id, the value returned will be null.
RemoveObserver Removes a previously added observer object. (Inherited from Object)
SetItem Sets an item in the table. The id must exist in the table. (Inherited from Table)
SetMaterialEvaluationShaderDefine Sets a MaterialEvaluationShaderDefine in the table.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast SafeCast makes sure the input object is of a class that can be cast into spMaterialEvaluationShaderDefineTable, and if this is the case, returns the object cast into spMaterialEvaluationShaderDefineTable. (Inherited from Object)

# Properties details

# Name

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

# Syntax

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

// Getter
spString GetName() const;

# SetName parameters

Type Name Min Max Description
const char * name New name of the object.

# GetName return value

Type: spString

# 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().

# Syntax

rid AddItem( const spObject & item ) const;

# Parameters

Type Name Min Max Description
Object item Is the item that is to be added to the table.

# Return value

Type: rid

# AddMaterialEvaluationShaderDefine

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

# Syntax

rid AddMaterialEvaluationShaderDefine( const spMaterialEvaluationShaderDefine & ShaderDefine ) const;

# Parameters

Type Name Min Max Description
MaterialEvaluationShaderDefine ShaderDefine The MaterialEvaluationShaderDefine to add into the table.

# Return value

Type: rid

# AddObserver

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

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type Name Min Max Description
Observer observer Observer is the object that will receive events.

# Return value

Type: rid

# Clear

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

# Syntax

void Clear() const;

# Parameters

Clear takes no parameters.

# Copy

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

# Syntax

void Copy( const spTable & src ) const;

# Parameters

Type Name Min Max Description
Table src The table to copy.

# 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.

# Syntax

spObject FindItem( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Is the string that is to be searched for.

# Return value

Type: Object

# 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.

# Syntax

rid FindItemId( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name Is the string that is to be searched for.

# Return value

Type: rid

# FindMaterialEvaluationShaderDefine

Finds a MaterialEvaluationShaderDefine in the table, using the MaterialEvaluationShaderDefine name. Note names are unique

# Syntax

spMaterialEvaluationShaderDefine FindMaterialEvaluationShaderDefine( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name The MaterialEvaluationShaderDefine name to look for.

# Return value

Type: MaterialEvaluationShaderDefine

# FindMaterialEvaluationShaderDefineId

Finds the id of a MaterialEvaluationShaderDefine in the table, using the MaterialEvaluationShaderDefine name. Note Define names are unique.

# Syntax

rid FindMaterialEvaluationShaderDefineId( const char * name ) const;

# Parameters

Type Name Min Max Description
const char * name The MaterialEvaluationShaderDefine name to look for.

# Return value

Type: rid

# GetClass

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

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetItem

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

# Syntax

spObject GetItem( rid id ) const;

# Parameters

Type Name Min Max Description
rid id Is the id of the requested object.

# Return value

Type: Object

# 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.

# Syntax

unsigned int GetItemsCount() const;

# Parameters

GetItemsCount takes no parameters.

# Return value

Type: unsigned int

# GetMaterialEvaluationShaderDefine

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

# Syntax

spMaterialEvaluationShaderDefine GetMaterialEvaluationShaderDefine( rid id ) const;

# Parameters

Type Name Min Max Description
rid id The id of the MaterialEvaluationShaderDefine in the table.

# Return value

Type: MaterialEvaluationShaderDefine

# GetMaterialEvaluationShaderDefinesCount

Returns the number of MaterialEvaluationShaderDefine in the table.

# Syntax

unsigned int GetMaterialEvaluationShaderDefinesCount() const;

# Parameters

GetMaterialEvaluationShaderDefinesCount takes no parameters.

# Return value

Type: unsigned int

# IsA

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

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if MaterialEvaluationShaderDefineTable is, or is a descendant of.

# Return value

Type: bool

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

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

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to compare with.

# Return value

Type: bool

# NonNull

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

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

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

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# 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.

# Syntax

void RemoveItem( rid id ) const;

# Parameters

Type Name Min Max Description
rid id The id of the object that should be removed.

# RemoveMaterialEvaluationShaderDefine

Removes a MaterialEvaluationShaderDefine. If GetMaterialEvaluationShaderDefine is called with the MaterialEvaluationShaderDefine id, the value returned will be null.

# Syntax

void RemoveMaterialEvaluationShaderDefine( rid id ) const;

# Parameters

Type Name Min Max Description
rid id The id of the Define in the table.

# RemoveObserver

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

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type Name Min Max Description
rid observerId ObserverId is the id returned by AddObserver when the observer was added.

# SetItem

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

# Syntax

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

# Parameters

Type Name Min Max Description
rid id Is the id that is to be set.
Object item Is the object set to the id.

# SetMaterialEvaluationShaderDefine

Sets a MaterialEvaluationShaderDefine in the table.

# Syntax

void SetMaterialEvaluationShaderDefine( rid id , const spMaterialEvaluationShaderDefine & shaderDefine ) const;

# Parameters

Type Name Min Max Description
rid id The id of the Define in the table.
MaterialEvaluationShaderDefine shaderDefine The parameter to set into the table.

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

# Syntax

static bool IsClassA( const char * type ) const;

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spMaterialEvaluationShaderDefineTable, and if this is the case, returns the object cast into spMaterialEvaluationShaderDefineTable. (Inherited from Object)

# Syntax

static spMaterialEvaluationShaderDefineTable SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: MaterialEvaluationShaderDefineTable