SBNodeMaterialAppearance#

This class describes a material appearance used in SBNodeMaterial.

List of material appearance presets#

Below is the table of material appearance presets available by default shown with some of their main values:

Material appearance presets#

Name

Description

metallic

roughness

specular

clearcoat

transmission

transmission roughness

transmission IOR

emission strength

metallicCarbonFiber

Metallic: Carbon Fiber

1

0.2

0.5

0

0

0

2.42

0

metallicCarbonSteel

Metallic: Carbon Steel

0.8

0.5

0.5

0

0

0

2.5

0

metallicCopper

Metallic: Copper

1

0.3

0.5

0

0

0

1.98

0

metallicGold

Metallic: Gold

1

0.1

0.5

0

0

0

0.47

0

metallicPaint

Metallic: Paint

1

0.2

0.5

0.8

0

0

1.45

0

metallicSilver

Metallic: Silver

1

0

0.5

0

0

0

0.18

0

metallicSteel

Metallic: Steel

1

0.5

0.5

0

0

0

2.5

0

metallicZinc

Metallic: Zinc

0.9

0.4

0.5

0

0

0

2.5

0

semiMetallicBrass

Semi-metallic: Brass

0.65

0.65

0.6

0

0

0

1.7

0

semiMetallicBronze

Semi-metallic: Bronze

0.75

0.4

0.6

0

0

0

2.5

0

semiMetallicEpoxy

Semi-metallic: Epoxy

0.2

0.4

0.6

0.1

0

0

1.6

0

semiMetallicPearl

Semi-metallic: Pearl

0.1

0.1

0.8

0.2

0

0

1.53

0

semiMetallicRust

Semi-metallic: Rust

0.6

0.8

0.5

0

0

0

2.5

0

smoothCeramic

Smooth: Ceramic

0

0.4

0.5

0

0

0

1.6

0

smoothLatex

Smooth: Latex

0

0.1

0.8

0

0

0

1.49

0

smoothMarble

Smooth: Marble

0

0.2

0.5

0

0

0

1.5

0

smoothPaint

Smooth: Paint

0

0.2

0.5

0.8

0

0

1.45

0

smoothPaper

Smooth: Paper

0

0.3

0.5

0

0

0

1.52

0

smoothPlastic

Smooth: Plastic

0

0.4

0.5

0.2

0

0

1.46

0

smoothPolystyrene

Smooth: Polystyrene

0

0.1

0.5

0

0

0

1.59

0

smoothSatin

Smooth: Satin

0

0.2

0.6

0

0

0

1.54

0

smoothShinyPlastic

Smooth: Shiny plastic

0

0.1

0.8

0.1

0

0

1.52

0

roughConcrete

Rough: Concrete

0

0.9

0.2

0

0

0

1.5

0

roughFeather

Rough: Feather

0

0.9

0.5

0.1

0

0

1.56

0

roughGranite

Rough: Granite

0

0.7

0.5

0

0

0

1.54

0

roughVelvet

Rough: Velvet

0

0.9

0.3

0

0

0

1.5

0

roughWood

Rough: Wood

0

0.6

0.5

0.1

0

0

1.52

0

emissiveFaint

Emissive: Faint (0.1)

0

0.5

0.5

0

0

0

1.5

0.1

emissiveSoft

Emissive: Soft (1)

0

0.5

0.5

0

0

0

1.5

1

emissiveGlowing

Emissive: Glowing (10)

0

0.5

0.5

0

0

0

1.5

10

emissiveShining

Emissive: Shining (100)

0

0.5

0.5

0

0

0

1.5

100

emissiveBright

Emissive: Bright (1000)

0

0.5

0.5

0

0

0

1.5

1000

emissiveStrong

Emissive: Strong (10000)

0

0.5

0.5

0

0

0

1.5

10000

emissiveIntense

Emissive: Intense (100000)

0

0.5

0.5

0

0

0

1.5

100000

transparentIce

Transparent: Ice

0

0

0.5

0

0.98

0.1

1.31

0

transparentGlass

Transparent: Glass

0

0

0.5

0

1

0

1.52

0

transparentJade

Transparent: Jade

0

0.3

0.5

0

0.2

0

1.66

0

transparentObsidian

Transparent: Obsidian

0

0.07

0.5

0

0.1

0.1

1.5

0

transparentWater

Transparent: Water

0

0

0.5

0

0.95

0

1.33

0

transparentWax

Transparent: Wax

0

0.1

0.5

0

0.3

0

1.46

0

class samson.SBNodeMaterialAppearance(*args, **kwargs)#

Bases: SBReferenceTarget

This class describes a material appearance.

Overloaded function.

  1. __init__(self: samson.SBNodeMaterialAppearance, metallicCoefficient: float = 0.0, roughnessCoefficient: float = 0.5, specularCoefficient: float = 0.5, specularTint: float = 0.0, clearcoatCoefficient: float = 0.0, clearcoatRoughness: float = 0.029999999329447746, transmissionCoefficient: float = 0.0, transmissionRoughness: float = 0.0, transmissionIOR: float = 1.4500000476837158, emissionStrength: float = 0.0, emissionColor: samson.SBColor = SBColor(0.000000, 0.000000, 0.000000, 1.000000), subsurfaceCoefficient: float = 0.0, subsurfaceRadius: samson.SBPhysicalVector3 = (1 (dimensionless), 0.2 (dimensionless), 0.1 (dimensionless)), subsurfaceColor: samson.SBColor = SBColor(0.800000, 0.800000, 0.800000, 1.000000), subsurfaceIOR: float = 1.399999976158142, subsurfaceAnisotropy: float = 0.0, transparency: float = 0.0, sheenCoefficient: float = 0.0, sheenTint: float = 0.5, anisotropicCoefficient: float = 0.0, anisotropicRotation: float = 0.0) -> None

Constructs a material appearance with the given parameters.

Parameters:
  • metallicCoefficient (float, default=0.0) – The metallic coefficient

  • roughnessCoefficient (float, default=0.5) – The roughness coefficient

  • specularCoefficient (float, default=0.5) – The specular coefficient

  • specularTint (float, default=0.0) – The specular tint

  • clearcoatCoefficient (float, default=0.0) – The clearcoat coefficient

  • clearcoatRoughness (float, default=0.03) – The clearcoat roughness

  • transmissionCoefficient (float, default=0.0) – The transmission coefficient

  • transmissionRoughness (float, default=0.0) – The transmission roughness

  • transmissionIOR (float, default=1.45) – The transmission index of refraction (IOR)

  • emissionStrength (float, default=0.0) – The emission strength

  • emissionColor (SBColor, default=SBColor(0,0,0)) – The emission color

  • subsurfaceCoefficient (float, default=0.0) – The subsurface coefficient

  • subsurfaceRadius (SBVector3, SBVector3(1.0, 0.2, 0.1)) – The subsurface radius

  • subsurfaceColor (SBColor, default=SBColor(0.8f, 0.8f, 0.8f)) – The subsurface color

  • subsurfaceIOR (float, default=1.4) – The subsurface index of refraction (IOR)

  • subsurfaceAnisotropy (float, default=0.0) – The subsurface anisotropy

  • transparency (float, default=0.0) – The transparency

  • sheenCoefficient (float, default=0.0) – The sheen coefficient

  • sheenTint (float, default=0.5) – The sheen tint

  • anisotropicCoefficient (float, default=0.0) – The anisotropic coefficient

  • anisotropicRotation (float, default=0.0) – The anisotropic rotation

  1. __init__(self: samson.SBNodeMaterialAppearance, materialAppearance: samson.SBNodeMaterialAppearance) -> None

Copy constructor.

getEmissionColor(self: samson.SBNodeMaterialAppearance) samson.SBColor#

Returns the emission color

getSubsurfaceColor(self: samson.SBNodeMaterialAppearance) samson.SBColor#

Returns the subsurface color

getSubsurfaceRadius(self: samson.SBNodeMaterialAppearance) samson.SBPhysicalVector3#

Returns the subsurface radius

setEmissionColor(self: samson.SBNodeMaterialAppearance, emissionColor: samson.SBColor) None#

Sets the emission color

setSubsurfaceColor(self: samson.SBNodeMaterialAppearance, emissionColor: samson.SBColor) None#

Sets the subsurface color

setSubsurfaceRadius(self: samson.SBNodeMaterialAppearance, subsurfaceRadius: samson.SBPhysicalVector3) None#

Sets the subsurface radius

property anisotropicCoefficient#

The anisotropic coefficient.

property anisotropicRotation#

The anisotropic rotation.

property clearcoatCoefficient#

The clearcoat coefficient.

property clearcoatRoughness#

The clearcoat roughness.

property emissionStrength#

The emission strength.

emissiveBright = SBNodeMaterialAppearance.emissiveBright#
emissiveFaint = SBNodeMaterialAppearance.emissiveFaint#
emissiveGlowing = SBNodeMaterialAppearance.emissiveGlowing#
emissiveIntense = SBNodeMaterialAppearance.emissiveIntense#
emissiveShining = SBNodeMaterialAppearance.emissiveShining#
emissiveSoft = SBNodeMaterialAppearance.emissiveSoft#
emissiveStrong = SBNodeMaterialAppearance.emissiveStrong#
property isSerializable#

Returns True when the class is serializable

metallicCarbonFiber = SBNodeMaterialAppearance.metallicCarbonFiber#
metallicCarbonSteel = SBNodeMaterialAppearance.metallicCarbonSteel#
property metallicCoefficient#

The metallic coefficient.

metallicCopper = SBNodeMaterialAppearance.metallicCopper#
metallicGold = SBNodeMaterialAppearance.metallicGold#
metallicPaint = SBNodeMaterialAppearance.metallicPaint#
metallicSilver = SBNodeMaterialAppearance.metallicSilver#
metallicSteel = SBNodeMaterialAppearance.metallicSteel#
metallicZinc = SBNodeMaterialAppearance.metallicZinc#
roughConcrete = SBNodeMaterialAppearance.roughConcrete#
roughFeather = SBNodeMaterialAppearance.roughFeather#
roughGranite = SBNodeMaterialAppearance.roughGranite#
roughVelvet = SBNodeMaterialAppearance.roughVelvet#
roughWood = SBNodeMaterialAppearance.roughWood#
property roughnessCoefficient#

The roughness coefficient.

semiMetallicBrass = SBNodeMaterialAppearance.semiMetallicBrass#
semiMetallicBronze = SBNodeMaterialAppearance.semiMetallicBronze#
semiMetallicEpoxy = SBNodeMaterialAppearance.semiMetallicEpoxy#
semiMetallicPearl = SBNodeMaterialAppearance.semiMetallicPearl#
semiMetallicRust = SBNodeMaterialAppearance.semiMetallicRust#
property sheenCoefficient#

The sheen coefficient.

property sheenTint#

The sheen tint.

smoothCeramic = SBNodeMaterialAppearance.smoothCeramic#
smoothLatex = SBNodeMaterialAppearance.smoothLatex#
smoothMarble = SBNodeMaterialAppearance.smoothMarble#
smoothPaint = SBNodeMaterialAppearance.smoothPaint#
smoothPaper = SBNodeMaterialAppearance.smoothPaper#
smoothPlastic = SBNodeMaterialAppearance.smoothPlastic#
smoothPolystyrene = SBNodeMaterialAppearance.smoothPolystyrene#
smoothSatin = SBNodeMaterialAppearance.smoothSatin#
smoothShinyPlastic = SBNodeMaterialAppearance.smoothShinyPlastic#
property specularCoefficient#

The specular coefficient.

property specularTint#

The specular tint.

property subsurfaceAnisotropy#

The subsurface anisotropy.

property subsurfaceCoefficient#

The subsurface coefficient.

property subsurfaceIOR#

The subsurface index of refraction (IOR).

property transmissionCoefficient#

The transmission coefficient.

property transmissionIOR#

The transmission index of refraction (IOR).

property transmissionRoughness#

The transmission roughness.

property transparency#

The transparency.

transparentGlass = SBNodeMaterialAppearance.transparentGlass#
transparentIce = SBNodeMaterialAppearance.transparentIce#
transparentJade = SBNodeMaterialAppearance.transparentJade#
transparentObsidian = SBNodeMaterialAppearance.transparentObsidian#
transparentWater = SBNodeMaterialAppearance.transparentWater#
transparentWax = SBNodeMaterialAppearance.transparentWax#