Class SBDDataGraphNodeMaterialAppearance#
ClassList > SBDDataGraphNodeMaterialAppearance
This class describes a material appearance. More...
#include <SBDDataGraphNodeMaterialAppearance.hpp>
Inherits the following classes: SBCReferenceTarget
Public Static Attributes#
| Type | Name |
|---|---|
| const SBDDataGraphNodeMaterialAppearance | emissiveBright The default emissive "Bright (1000)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveFaint The default emissive "Faint (0.1)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveGlowing The default emissive "Glowing (10)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveIntense The default emissive "Intense (100000)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveShining The default emissive "Shining (100)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveSoft The default emissive "Soft (1)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | emissiveStrong The default emissive "Strong (10000)" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicCarbonFiber The default metallic "Carbon Fiber" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicCarbonSteel The default metallic "Carbon Steel" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicCopper The default metallic "Copper" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicGold The default metallic "Gold" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicPaint The default metallic "Paint" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicSilver The default metallic "Silver" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicSteel The default metallic "Steel" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | metallicZinc The default metallic "Zinc" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | roughConcrete The default rough "Concrete" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | roughFeather The default rough "Feather" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | roughGranite The default rough "Granite" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | roughVelvet The default rough "Velvet" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | roughWood The default rough "Wood" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | semiMetallicBrass The default semi-metallic "Brass" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | semiMetallicBronze The default semi-metallic "Bronze" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | semiMetallicEpoxy The default semi-metallic "Epoxy" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | semiMetallicPearl The default semi-metallic "Pearl" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | semiMetallicRust The default semi-metallic "Rust" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothCeramic The default smooth "Ceramic" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothLatex The default smooth "Latex" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothMarble The default smooth "Marble" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothPaint The default smooth "Paint" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothPaper The default smooth "Paper" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothPlastic The default smooth "Plastic" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothPolystyrene The default smooth "Polystyrene" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothSatin The default smooth "Satin" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | smoothShinyPlastic The default smooth "Shiny plastic" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentGlass The default transparent "Glass" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentIce The default transparent "Ice" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentJade The default transparent "Jade" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentObsidian The default transparent "Obsidian" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentWater The default transparent "Water" appearance preset. |
| const SBDDataGraphNodeMaterialAppearance | transparentWax The default transparent "Wax" appearance preset. |
Public Functions#
| Type | Name |
|---|---|
| SBDDataGraphNodeMaterialAppearance (float metallicCoefficient=0.0f, float roughnessCoefficient=0.5f, float specularCoefficient=0.5f, float specularTint=0.0f, float clearcoatCoefficient=0.0f, float clearcoatRoughness=0.03f, float transmissionCoefficient=0.0f, float transmissionRoughness=0.0f, float transmissionIOR=1.45f, float emissionStrength=0.0f, const SBColor & emissionColor=SBColor(0.0f, 0.0f, 0.0f), float subsurfaceCoefficient=0.0f, const SBVector3 & subsurfaceRadius=SBVector3(1.0, 0.2, 0.1), const SBColor & subsurfaceColor=SBColor(0.8f, 0.8f, 0.8f), float subsurfaceIOR=1.4f, float subsurfaceAnisotropy=0.0f, float transparency=0.0f, float sheenCoefficient=0.0f, float sheenTint=0.5f, float anisotropicCoefficient=0.0f, float anisotropicRotation=0.0f) Constructs a material appearance with the given parameters. |
|
| SBDDataGraphNodeMaterialAppearance (const SBDDataGraphNodeMaterialAppearance & other) Copy constructor. |
|
| float | getAnisotropicCoefficient () const Returns the anisotropic coefficient. |
| float | getAnisotropicRotation () const Returns the anisotropic rotation. |
| float | getClearcoatCoefficient () const Returns the clearcoat coefficient. |
| float | getClearcoatRoughness () const Returns the clearcoat roughness. |
| SBColor const & | getEmissionColor () const Returns the emission color. |
| float | getEmissionStrength () const Returns the emission strength. |
| float | getMetallicCoefficient () const Returns the metallic coefficient. |
| float | getRoughnessCoefficient () const Returns the roughness coefficient. |
| float | getSheenCoefficient () const Returns the sheen coefficient. |
| float | getSheenTint () const Returns the sheen tint. |
| float | getSpecularCoefficient () const Returns the specular coefficient. |
| float | getSpecularTint () const Returns the specular tint. |
| float | getSubsurfaceAnisotropy () const Returns the subsurface anisotropy. |
| float | getSubsurfaceCoefficient () const Returns the subsurface coefficient. |
| SBColor const & | getSubsurfaceColor () const Returns the subsurface color. |
| float | getSubsurfaceIOR () const Returns the subsurface index of refraction. |
| SBVector3 const & | getSubsurfaceRadius () const Returns the subsurface radius. |
| float | getTransmissionCoefficient () const Returns the transmission coefficient. |
| float | getTransmissionIOR () const Returns the transmission index of refraction. |
| float | getTransmissionRoughness () const Returns the transmission roughness. |
| float | getTransparency () const Returns the transparency. |
| virtual bool | isSerializable () const Returns true __ |
| bool | operator!= (const SBDDataGraphNodeMaterialAppearance & other) const Inequality operator. |
| SBDDataGraphNodeMaterialAppearance & | operator= (const SBDDataGraphNodeMaterialAppearance & other) Copy assignment. |
| bool | operator== (const SBDDataGraphNodeMaterialAppearance & other) const Equality operator. |
| virtual void | serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) const Serializes the document. |
| void | setAnisotropicCoefficient (float anisotropicCoefficient) Sets the anisotropic coefficient. |
| void | setAnisotropicRotation (float anisotropicRotation) Sets the anisotropic rotation. |
| void | setClearcoatCoefficient (float clearcoatCoefficient) Sets the clearcoat coefficient. |
| void | setClearcoatRoughness (float clearcoatRoughness) Sets the clearcoat roughness. |
| void | setEmissionColor (const SBColor & emissionColor) Sets the emission color. |
| void | setEmissionStrength (float emissionStrength) Sets the emission strength. |
| void | setMetallicCoefficient (float metallicCoefficient) Sets the metallic coefficient. |
| void | setRoughnessCoefficient (float roughnessCoefficient) Sets the roughness coefficient. |
| void | setSheenCoefficient (float sheenCoefficient) Sets the sheen coefficient. |
| void | setSheenTint (float sheenTint) Sets the sheen tint. |
| void | setSpecularCoefficient (float specular) Sets the specular coefficient. |
| void | setSpecularTint (float specularTint) Sets the specular tint. |
| void | setSubsurfaceAnisotropy (float subsurfaceAnisotropy) Sets the subsurface anisotropy. |
| void | setSubsurfaceCoefficient (float subsurfaceCoefficient) Sets the subsurface coefficient. |
| void | setSubsurfaceColor (const SBColor & subsurfaceColor) Sets the subsurface color. |
| void | setSubsurfaceIOR (float subsurfaceIOR) Sets the subsurface index of refraction. |
| void | setSubsurfaceRadius (const SBVector3 & subsurfaceRadius) Sets the subsurface radius. |
| void | setTransmissionCoefficient (float transmissionCoefficient) Sets the transmission coefficient. |
| void | setTransmissionIOR (float ior) Sets the transmission index of refraction. |
| void | setTransmissionRoughness (float transmissionRoughness) Sets the transmission roughness. |
| void | setTransparency (float transparency) Sets the transparency. |
| virtual std::string | toPythonCode () const Returns the string representation of the object that can be used to reconstruct it in Python. |
| virtual void | unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) Unserializes the document. |
| virtual | ~SBDDataGraphNodeMaterialAppearance () Destructs the material appearance. |
Public Functions inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTarget () Builds the reference target. |
|
| unsigned int | getMemoryFootprint () const Returns the memory footprint. |
| void | printReferencesToOwners () const Prints the references to the owners of this reference target. |
| virtual | ~SBCReferenceTarget () Destructor. |
Protected Attributes inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTargetData * | dataPointer A pointer to the private data. |
Protected Functions#
| Type | Name |
|---|---|
| SBDDataGraphNodeMaterialAppearance (SBDDataGraphNodeMaterialAppearanceData * dataPointer) Protected constructor. |
Protected Functions inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor. |
|
| void | removeAllReferenceOwners () Stops all the reference owners from referencing this reference target. |
Detailed Description#
This class describes a material appearance in SAMSON.
Please refer to Materials for more information.
Short name: SBNodeMaterialAppearance
See also: Materials
Public Static Attributes Documentation#
variable emissiveBright#
The default emissive "Bright (1000)" appearance preset.
variable emissiveFaint#
The default emissive "Faint (0.1)" appearance preset.
variable emissiveGlowing#
The default emissive "Glowing (10)" appearance preset.
variable emissiveIntense#
The default emissive "Intense (100000)" appearance preset.
variable emissiveShining#
The default emissive "Shining (100)" appearance preset.
variable emissiveSoft#
The default emissive "Soft (1)" appearance preset.
variable emissiveStrong#
The default emissive "Strong (10000)" appearance preset.
variable metallicCarbonFiber#
The default metallic "Carbon Fiber" appearance preset.
variable metallicCarbonSteel#
The default metallic "Carbon Steel" appearance preset.
variable metallicCopper#
The default metallic "Copper" appearance preset.
variable metallicGold#
The default metallic "Gold" appearance preset.
variable metallicPaint#
The default metallic "Paint" appearance preset.
variable metallicSilver#
The default metallic "Silver" appearance preset.
variable metallicSteel#
The default metallic "Steel" appearance preset.
variable metallicZinc#
The default metallic "Zinc" appearance preset.
variable roughConcrete#
The default rough "Concrete" appearance preset.
variable roughFeather#
The default rough "Feather" appearance preset.
variable roughGranite#
The default rough "Granite" appearance preset.
variable roughVelvet#
The default rough "Velvet" appearance preset.
variable roughWood#
The default rough "Wood" appearance preset.
variable semiMetallicBrass#
The default semi-metallic "Brass" appearance preset.
variable semiMetallicBronze#
The default semi-metallic "Bronze" appearance preset.
variable semiMetallicEpoxy#
The default semi-metallic "Epoxy" appearance preset.
variable semiMetallicPearl#
The default semi-metallic "Pearl" appearance preset.
variable semiMetallicRust#
The default semi-metallic "Rust" appearance preset.
variable smoothCeramic#
The default smooth "Ceramic" appearance preset.
variable smoothLatex#
The default smooth "Latex" appearance preset.
variable smoothMarble#
The default smooth "Marble" appearance preset.
variable smoothPaint#
The default smooth "Paint" appearance preset.
variable smoothPaper#
The default smooth "Paper" appearance preset.
variable smoothPlastic#
The default smooth "Plastic" appearance preset.
variable smoothPolystyrene#
The default smooth "Polystyrene" appearance preset.
variable smoothSatin#
The default smooth "Satin" appearance preset.
variable smoothShinyPlastic#
The default smooth "Shiny plastic" appearance preset.
variable transparentGlass#
The default transparent "Glass" appearance preset.
variable transparentIce#
The default transparent "Ice" appearance preset.
variable transparentJade#
The default transparent "Jade" appearance preset.
variable transparentObsidian#
The default transparent "Obsidian" appearance preset.
variable transparentWater#
The default transparent "Water" appearance preset.
variable transparentWax#
The default transparent "Wax" appearance preset.
Public Functions Documentation#
function SBDDataGraphNodeMaterialAppearance [2/3]#
Constructs a material appearance with the given parameters.
SBDDataGraphNodeMaterialAppearance::SBDDataGraphNodeMaterialAppearance (
float metallicCoefficient=0.0f,
float roughnessCoefficient=0.5f,
float specularCoefficient=0.5f,
float specularTint=0.0f,
float clearcoatCoefficient=0.0f,
float clearcoatRoughness=0.03f,
float transmissionCoefficient=0.0f,
float transmissionRoughness=0.0f,
float transmissionIOR=1.45f,
float emissionStrength=0.0f,
const SBColor & emissionColor=SBColor (0.0f, 0.0f, 0.0f),
float subsurfaceCoefficient=0.0f,
const SBVector3 & subsurfaceRadius=SBVector3(1.0, 0.2, 0.1),
const SBColor & subsurfaceColor=SBColor (0.8f, 0.8f, 0.8f),
float subsurfaceIOR=1.4f,
float subsurfaceAnisotropy=0.0f,
float transparency=0.0f,
float sheenCoefficient=0.0f,
float sheenTint=0.5f,
float anisotropicCoefficient=0.0f,
float anisotropicRotation=0.0f
)
Constructs a material appearance with the specified physical parameters.
This constructor initializes all material appearance attributes, such as metallic and roughness coefficients, specular properties, clearcoat, transmission, emission, subsurface scattering, transparency, sheen, and anisotropy.
Parameters:
metallicCoefficientMetallic coefficient of the material.roughnessCoefficientRoughness coefficient of the material.specularCoefficientSpecular reflection coefficient.specularTintTint applied to the specular reflection.clearcoatCoefficientClearcoat layer coefficient.clearcoatRoughnessRoughness of the clearcoat layer.transmissionCoefficientCoefficient governing transmission (transparency) of the material.transmissionRoughnessRoughness of the transmission.transmissionIORIndex of refraction for transmission.emissionStrengthStrength of the emitted light.emissionColorColor of the emitted light.subsurfaceCoefficientSubsurface scattering coefficient.subsurfaceRadiusRadius of subsurface scattering (per color channel).subsurfaceColorColor of subsurface scattering.subsurfaceIORIndex of refraction for subsurface scattering.subsurfaceAnisotropyAnisotropy factor for subsurface scattering.transparencyOverall transparency of the material.sheenCoefficientSheen (soft highlight) coefficient.sheenTintTint applied to the sheen.anisotropicCoefficientAnisotropic reflection coefficient.anisotropicRotationRotation of the anisotropic direction.
function SBDDataGraphNodeMaterialAppearance [3/3]#
Copy constructor.
SBDDataGraphNodeMaterialAppearance::SBDDataGraphNodeMaterialAppearance (
const SBDDataGraphNodeMaterialAppearance & other
)
Constructs a material appearance as a copy of another.
Initializes a new material appearance with the same attribute values as the provided instance.
Parameters:
otherThe material appearance to copy from.
function getAnisotropicCoefficient#
Returns the anisotropic coefficient.
function getAnisotropicRotation#
Returns the anisotropic rotation.
function getClearcoatCoefficient#
Returns the clearcoat coefficient.
function getClearcoatRoughness#
Returns the clearcoat roughness.
function getEmissionColor#
Returns the emission color.
function getEmissionStrength#
Returns the emission strength.
function getMetallicCoefficient#
Returns the metallic coefficient.
function getRoughnessCoefficient#
Returns the roughness coefficient.
function getSheenCoefficient#
Returns the sheen coefficient.
function getSheenTint#
Returns the sheen tint.
function getSpecularCoefficient#
Returns the specular coefficient.
function getSpecularTint#
Returns the specular tint.
function getSubsurfaceAnisotropy#
Returns the subsurface anisotropy.
function getSubsurfaceCoefficient#
Returns the subsurface coefficient.
function getSubsurfaceColor#
Returns the subsurface color.
function getSubsurfaceIOR#
Returns the subsurface index of refraction.
function getSubsurfaceRadius#
Returns the subsurface radius.
function getTransmissionCoefficient#
Returns the transmission coefficient.
function getTransmissionIOR#
Returns the transmission index of refraction.
function getTransmissionRoughness#
Returns the transmission roughness.
function getTransparency#
Returns the transparency.
function isSerializable#
Returns true __
Indicates whether the material appearance can be serialized.
This function always returns true for material appearances.
Returns:
true.
function operator!=#
Inequality operator.
bool SBDDataGraphNodeMaterialAppearance::operator!= (
const SBDDataGraphNodeMaterialAppearance & other
) const
Checks whether this material appearance is not equal to another.
Returns the logical negation of the equality comparison.
Parameters:
otherThe material appearance to compare with.
Returns:
true if any attribute differs, false if all attributes are equal.
function operator=#
Copy assignment.
SBDDataGraphNodeMaterialAppearance & SBDDataGraphNodeMaterialAppearance::operator= (
const SBDDataGraphNodeMaterialAppearance & other
)
Assigns the values from another material appearance to this instance.
Copies all attribute values from the source material appearance.
Parameters:
otherThe material appearance to assign from.
Returns:
Reference to this material appearance after assignment.
function operator==#
Equality operator.
bool SBDDataGraphNodeMaterialAppearance::operator== (
const SBDDataGraphNodeMaterialAppearance & other
) const
Checks whether this material appearance is equal to another.
Compares all material appearance attributes for equality.
Parameters:
otherThe material appearance to compare with.
Returns:
true if all attributes are equal, false otherwise.
function serialize#
Serializes the document.
virtual void SBDDataGraphNodeMaterialAppearance::serialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) const
Serializes the material appearance to a serializer.
Writes all material appearance attributes to the provided serializer.
Parameters:
serializerThe serializer to write the data to.nodeIndexerIndexer used for node references.sdkVersionNumberSDK version number used for serialization.classVersionNumberClass version number used for serialization.
function setAnisotropicCoefficient#
Sets the anisotropic coefficient.
function setAnisotropicRotation#
Sets the anisotropic rotation.
function setClearcoatCoefficient#
Sets the clearcoat coefficient.
function setClearcoatRoughness#
Sets the clearcoat roughness.
function setEmissionColor#
Sets the emission color.
function setEmissionStrength#
Sets the emission strength.
function setMetallicCoefficient#
Sets the metallic coefficient.
function setRoughnessCoefficient#
Sets the roughness coefficient.
function setSheenCoefficient#
Sets the sheen coefficient.
function setSheenTint#
Sets the sheen tint.
function setSpecularCoefficient#
Sets the specular coefficient.
function setSpecularTint#
Sets the specular tint.
function setSubsurfaceAnisotropy#
Sets the subsurface anisotropy.
function setSubsurfaceCoefficient#
Sets the subsurface coefficient.
function setSubsurfaceColor#
Sets the subsurface color.
function setSubsurfaceIOR#
Sets the subsurface index of refraction.
function setSubsurfaceRadius#
Sets the subsurface radius.
function setTransmissionCoefficient#
Sets the transmission coefficient.
void SBDDataGraphNodeMaterialAppearance::setTransmissionCoefficient (
float transmissionCoefficient
)
function setTransmissionIOR#
Sets the transmission index of refraction.
function setTransmissionRoughness#
Sets the transmission roughness.
function setTransparency#
Sets the transparency.
function toPythonCode#
Returns the string representation of the object that can be used to reconstruct it in Python.
Returns a Python code representation of this material appearance.
This method produces a string that can be used to reconstruct the material appearance in Python. If the appearance matches one of the built-in preset appearances, the corresponding preset name is returned; otherwise a full constructor call with all attribute values is generated.
Returns:
A Python code string representing this material appearance.
function unserialize#
Unserializes the document.
virtual void SBDDataGraphNodeMaterialAppearance::unserialize (
SBCSerializer * serializer,
const SBNodeIndexer & nodeIndexer,
const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
)
Deserializes the material appearance from a serializer.
Reads all material appearance attributes from the provided serializer.
Parameters:
serializerThe serializer to read the data from.nodeIndexerIndexer used for node references.sdkVersionNumberSDK version number used for deserialization.classVersionNumberClass version number used for deserialization.
function ~SBDDataGraphNodeMaterialAppearance#
Destructs the material appearance.
Destroys the material appearance.
Releases any resources associated with the material appearance.
Protected Functions Documentation#
function SBDDataGraphNodeMaterialAppearance [1/3]#
Protected constructor.
SBDDataGraphNodeMaterialAppearance::SBDDataGraphNodeMaterialAppearance (
SBDDataGraphNodeMaterialAppearanceData * dataPointer
)
Constructs a material appearance with a given data pointer.
This constructor is used internally to associate the material appearance with its underlying data object.
Parameters:
dataPointerPointer to the internal data structure representing the material appearance.