- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
sbsscenedata
Module sbsscenedata provides the definition of the SubMeshColor
and SubMeshSelection
objects.
class pysbs.sbsbakers.sbsscenedata.SubMeshColor(aEntityId=1, aSubMeshId=0, aColor='#ff0000')
Bases: object
Class that describe the color associated to a Scene object entity
- Members:
- mEntityId (int): entity index
- mSubMeshId (int): sub mesh index
- mColor (str): the hexadecimal color
fromSBSTree(aIndexColor, aSBSTree, removeUsedOptions=False)
Get the content of the given SBSTree to set the SubMeshColor with the given id
Parameters: |
|
---|---|
Returns: | True if success, False otherwise |
getColorHexa()
Get the hexadecimal color of this SubMeshColor
Returns: | The hexadecimal color as a string if it exists, None otherwise |
---|
setColorHexa(aColor)
Set the given hexadecimal color
Parameters: | aColor (str) – The hexadecimal color |
---|
toSBSOptionList(aIndexColor)
Convert the SubMeshColor object into a list of SBSOptions, as it is saved in the .sbs file
Parameters: | aIndexColor (int) – Index of this color in the Baking Parameters |
---|---|
Returns: | A list of SBSOptions object with the content of the SubMeshColor |
class pysbs.sbsbakers.sbsscenedata.SubMeshSelection(aEntityId=1, aSubMeshId=0)
Bases: object
Class that describe a Scene selection
- Members:
- mEntityId (int): entity index
- mSubMeshId (int): sub mesh index
fromSBSTree(aColorIndex, aSBSTree, removeUsedOptions=False)
Get the content of the given SBSTree to set the SubMeshSelection with the given id
Parameters: |
|
---|---|
Returns: | True if success, False otherwise |
toSBSOptionList(aIndexSelection)
Convert the SubMeshSelection object into a list of SBSOptions, as it is saved in the .sbs file
Parameters: | aIndexSelection (int) – Index of this selection in the Baking Parameters |
---|---|
Returns: | A list of SBSOptions object with the content of the SubMeshSelection |