# `class` Material

Material object that keeps material information used while rendering.

# Properties

Property	Description
MaterialGUID	The unique id for this node.
MaterialType	The MaterialType.
UseTangentSpaceNormals	The UseTangentSpaceNormals flag. If set, the normal map has tangent space normals.

# Methods

Method	Description
AddMaterialChannel	Add a material channel.
ChangeTexturePrefixPath	Changes the prefix path (drive, directory) of all matching texture paths in the material, with the new one. This method is useful when external textures are placed in a specific folder, which needs to be moved.
ConvertHandedness	Converts parameters such as UVTiling and UVOffset in shading networks.
GetClass	Get the name of the Material class.
GetMaterialChannelCount	Returns the number of material channels in the material.
GetMaterialChannelFromIndex	Returns the name of a channel from the index. Note that by adding/removing channels the indices are changed, and this method should only be used for enumeration.
GetShadingNetwork	Get which shading network to use for the material channel.
HasMaterialChannel	Check if the channel exists within the material.
IsA	Returns true if Material is a or is a descendant of the class named as the type parameter.
IsIdenticalTo	Returns true if the material is setup identical to this material.
IsNull	Returns true if the Material object is invalid.
IsTransparent	Returns true if the material could be transparent.
LoadShadingNetworkFromXML	Save shading network to XML.
RemoveMaterialChannel	Remove a material channel.
SaveShadingNetworkToXML	Save shading network to XML.
SetOpacityFromDiffuseAlpha	Maps the alpha component of the diffuse channel to all the RGBA components in the opacity channel (by using a swizzle node).
SetShadingNetwork	Set which shading network to use for the material channel.

# Static methods

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

# Properties details

# MaterialGUID

The unique id for this node.

Type	Name	Min	Max	Description
`const char *`	value			The node id of type string.

Type	Name	Min	Max	Description
`string`	value			The node id of type string.

Name	Type	Min	Max	Description
value	`str`			The node id of type string.

# MaterialType

The MaterialType.

Type	Name	Min	Max	Description
EMaterialType	value			The Material type. One of the following: Standard -> Use the standard shaderSG_MATERIALTYPE_FLIPBOOK -> Use the flipbook shader. BillboardCloud -> Use the billboard cloud shader.

Key	Value	Comment
Standard	0	Use the standard shader.
Flipbook	1	Use the flipbook shader.
BillboardCloud	2	Use the billboard cloud shader.

Type	Name	Min	Max	Description
EMaterialType	value			The Material type. One of the following: Standard -> Use the standard shaderSG_MATERIALTYPE_FLIPBOOK -> Use the flipbook shader. BillboardCloud -> Use the billboard cloud shader.

Key	Value	Comment
Standard	0	Use the standard shader.
Flipbook	1	Use the flipbook shader.
BillboardCloud	2	Use the billboard cloud shader.

Name	Type	Min	Max	Description
value	EMaterialType			The Material type. One of the following: Standard -> Use the standard shaderSG_MATERIALTYPE_FLIPBOOK -> Use the flipbook shader. BillboardCloud -> Use the billboard cloud shader.

Key	Value	Comment
EMaterialType_Standard	0	Use the standard shader.
EMaterialType_Flipbook	1	Use the flipbook shader.
EMaterialType_BillboardCloud	2	Use the billboard cloud shader.

# UseTangentSpaceNormals

The UseTangentSpaceNormals flag. If set, the normal map has tangent space normals.

Type	Name	Min	Max	Description
`bool`	value			The desired flag value.

Type	Name	Min	Max	Description
`bool`	value			The desired flag value.

Name	Type	Min	Max	Description
value	`bool`			The desired flag value.

# Methods details

# AddMaterialChannel

Add a material channel.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the material channel.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the material channel.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the material channel.

# ChangeTexturePrefixPath

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

Type	Name	Min	Max	Description
`const char *`	current_path_prefix			The current prefix path, either relative or absolute.
`const char *`	new_path_prefix			The new prefix path.

Type	Name	Min	Max	Description
`string`	current_path_prefix			The current prefix path, either relative or absolute.
`string`	new_path_prefix			The new prefix path.

Name	Type	Min	Max	Description
current_path_prefix	`str`			The current prefix path, either relative or absolute.
new_path_prefix	`str`			The new prefix path.

# ConvertHandedness

Converts parameters such as UVTiling and UVOffset in shading networks.

# GetClass

Get the name of the Material class.

# GetMaterialChannelCount

Returns the number of material channels in the material.

# GetMaterialChannelFromIndex

Returns the name of a channel from the index. Note that by adding/removing channels the indices are changed, and this method should only be used for enumeration.

Type	Name	Min	Max	Description
`rid`	index			The index to the channel to be fetched.

Type	Name	Min	Max	Description
`rid`	index			The index to the channel to be fetched.

Name	Type	Min	Max	Description
index	`int`			The index to the channel to be fetched.

# GetShadingNetwork

Get which shading network to use for the material channel.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the channel.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the channel.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the channel.

# HasMaterialChannel

Check if the channel exists within the material.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the material channel.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the material channel.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the material channel.

# IsA

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

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

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if Material is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if Material is, or is a descendant of.

# IsIdenticalTo

Returns true if the material is setup identical to this material.

Type	Name	Min	Max	Description
Material	mat			The material to compare to.

Type	Name	Min	Max	Description
Material	mat			The material to compare to.

Name	Type	Min	Max	Description
mat	Material			The material to compare to.

# IsNull

Returns true if the Material object is invalid.

# IsTransparent

Returns true if the material could be transparent.

# LoadShadingNetworkFromXML

Save shading network to XML.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the channel.
`const char *`	in_xml			The xml descriping the shading node graph.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the channel.
`string`	in_xml			The xml descriping the shading node graph.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the channel.
in_xml	`str`			The xml descriping the shading node graph.

# RemoveMaterialChannel

Remove a material channel.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the material channel.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the material channel.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the material channel.

# SaveShadingNetworkToXML

Save shading network to XML.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the channel.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the channel.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the channel.

# SetOpacityFromDiffuseAlpha

Maps the alpha component of the diffuse channel to all the RGBA components in the opacity channel (by using a swizzle node).

# SetShadingNetwork

Set which shading network to use for the material channel.

Type	Name	Min	Max	Description
`const char *`	channel_name			The name of the new channel.
`ShadingNode`	node			The shading network exit node.

Type	Name	Min	Max	Description
`string`	channel_name			The name of the new channel.
`ShadingNode`	node			The shading network exit node.

Name	Type	Min	Max	Description
channel_name	`str`			The name of the new channel.
node	`ShadingNode`			The shading network exit node.

# Static methods details

# IsClassA

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

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

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

# SafeCast

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

← ImageData PackedGeometryData →

# class Material