User Guide Cancel

sbsbaker_info_handlers | Substance 3D Automation ToolKit

  1. Substance 3D home
  2. Home
  3. Command Line Tools
    1. Command Line overview
    2. sbsbaker
      1. sbsbaker overview
      2. sbsbaker command line options
      3. sbsbaker Example Command Lines
    3. sbscooker
      1. sbscooker overview
      2. sbscooker command line options
      3. sbscooker pattern variables
    4. sbsmtools
      1. sbsmtools overview
      2. sbsmtools command line options
    5. sbsmutator
      1. sbsmutator overview
      2. sbsmutator command line options
      3. sbsmutator Example Command Lines
    6. sbsrender
      1. sbsrender overview
      2. sbsrender base parameters and pattern variables
      3. sbsrender command line options
      4. sbsrender example command lines
    7. sbsupdater
      1. sbsupdater overview
      2. sbsupdater command line options
  4. Pysbs - Python API
    1. Pysbs - Python API overview
    2. Getting started
    3. General topics
      1. Basic manipulation
      2. Substance creation
      3. Substances modification
      4. Dependencies management
      5. PySbs batchtools module
      6. metadata manipulation
      7. SAT demos
      8. Edit sbsar with SBSARManager
      9. Spot Colors
      10. Thumbnail creation with SAT
    4. Examples
      1. demohelloworld
      2. demos
      3. demos_batchtools
      4. script_update_with_sbsupdater
    5. API Content
      1. API Content overview
      2. Substance definitions
        1. Common interfaces
          1. basegraph
          2. package
          3. sbsarobject
          4. sbsobject
        2. compnode
          1. compnode overview
          2. common
          3. compimplementation
          4. paramgraph
        3. context projectmgr
        4. graph
          1. graph overview
          2. function
          3. inputparameters
          4. output
        5. mdl
          1. mdlannotation
          2. mdlcommon
          3. mdldictionaries
          4. mdlenum
          5. mdlgraph
          6. mdllibclasses
          7. mdlmanager
          8. mdlnode
          9. mdlnodeimpl
          10. mdloperand
          11. mdlsbsbridge
        6. modelgraphindex
          1. modelannotationnames
          2. modelgraph
          3. modelgraphgenerator
          4. modelgraphimplementation
          5. modelnodenames
          6. modeloperand
          7. modulegraphindex
          8. moduleannotation
          9. moduleconnection
          10. modulegraph
          11. modulegraphgenerator
          12. modulegraphimplementation
          13. modulegraphlibrary
          14. modulegraphregister
          15. modulenode
          16. modulenodeimplementation
          17. modulenodeinstance
          18. moduleoperand
          19. moduleoutputbridging
          20. moduleparaminput
        7. params
          1. params overview
          2. dynamicvalue
          3. paramnode
        8. projectmgrdoc
        9. sbsarchive
          1. sbsarchive overview
          2. sbsarenum
          3. sbsargraph
          4. sbsargui
          5. sbsarguiwidgets
          6. sbsarmanager
        10. sbscommon
          1. connections
          2. gui
          3. nodes
          4. values
        11. sbspreset
        12. sbsproject
        13. substance
          1. substance overview
          2. content
          3. resource
      3. Libraries
        1. sbsenum
        2. sbslibrary
          1. sbslibrary overview
          2. sbsdictionaries
          3. sbsfilters
          4. sbsfunctions
          5. sbsfxmapnodes
          6. sbslibclasses
          7. sbswidgets
        3. sbsbakerslibrary
          1. sbsbakerslibrary overview
          2. sbsbakersdef
          3. sbsbakersdefaultprops
          4. sbsbakersdictionaries
          5. sbsbakersenum
          6. sbsbakingconverter
          7. sbsbakingconverterparam
          8. sbsbakingparameters
          9. sbsdialogstate
          10. sbsscenedata
        4. Helpers
          1. sbscleaner
          2. sbsexporter
          3. sbsgenerator
          4. sbsparser
          5. sbswriter
          6. qtclasses
            1. qtclasses overview
            2. qtvariantreader
            3. qtvariantwriter
          7. psdparser
          8. sbsimpactmanager
          9. batchtools
          10. autograph
            1. ag_functions
            2. ag_layout
            3. ag_types
          11. info_mesh_parser
          12. sbsbaker_info_handlers
          13. sbsrender_render_handlers
          14. output_handlers
          15. spotcolorinfo_handler
          16. thumbnail
          17. batchtools overview
        5. Execution context
          1. context
          2. functions
        6. API Change log
  5. Samples
    1. Samples overview
    2. Texturing Template Demo
    3. Batch Tools Demo
    4. Variations
    5. Texture Mat
    6. Pixel Processor Ray tracer
  6. Setup and Getting Started
    1. Setup and Getting Started overview
    2. Compatibility
    3. Frequently asked Questions
    4. Known issues
    5. SAT Cookbook
    6. Use Pysbs in different python interpreter (maya, sd, blender...)
  7. Integrations
    1. Substance Maya toolset
      1. Substance Maya Toolset overview
      2. Installing
      3. Launching
      4. Baking
        1. Baking overview
        2. Export parameters
        3. Baker parameters
        4. Mesh setup
        5. Using a template
      5. Changelog
  8. Changelog overview

sbsbaker_info_handlers

Example of usage with SbsBakerInfoOutputHandler (output_handlers module):

# call a sbsbaker_info with the kwarg output_handler=True to get an OutputHandler instead of Popen 
# the OutputHandler will stop the interpreter during the batchtool process exactly like Popen.wait() 
out = batchtools.sbsbaker_info('foo.fbx', output_handler=True) 
print(out) 
# <pysbs.batchtools.output_handlers.SbsBakerInfoOutputHandler object at 0x7f8808fe1c50> 
# to get the result use get_results, an OutputHandler's common method 
results = out.get_results() 
print(results) 
# [<pysbs.batchtools.sbsbaker_info_handlers.SbsBakerInfoEntityStruct object at 0x7f7757881c10>, <pysbs.batchtools.sbsbaker_info_handlers.SbsBakerInfoEntityStruct object at 0x7f7757881e10>] 
# SbsBakerInfoOutputHandler.get_results() return a list of SbsBakerInfoEntityStruct. Follow the doc to get more details of SbsBakerInfoEntityStruct 
# as mush as possible each member type is converted in a python type. 
for entity in results: 
    # some examples of its different members 
    print(entity.label) 
    for mesh in entity.meshes: 
        print(mesh.vertices_number) 
        for uv in mesh.uvs: 
            print(uv.udim_tiles) 
        for subpart in mesh.submeshes: 
            print(subpart.color) 
# it become easy to retrieve all the udims or uv tiles: 
all_udims = set([udim for entity in out for mesh in entity.meshes for uv in mesh.uvs for udim in uv.udim_tiles]) 
 
# an other OutputHandler common method is dump() to write the output in a stream IO (file) 
with open("dumped_file.ext", 'w') as f: 
    out.dump(f)
class batchtools.sbsbaker_info_handlers.SbsBakerInfoBboxStruct(minimal_point=(), maximal_point=(), center=(), size=())

Bases: object

Bbox handles bounding box info of an object, member of SbsBakerInfoEntityStruct.

Parameters:
  • minimal_point – the smallest point of the box
  • maximal_point – the highest point of the box
  • center – the center of the box
  • size – the size of the box
class batchtools.sbsbaker_info_handlers.SbsBakerInfoEntityStruct(label='', enabled=True, bounding_box=None, location=None, meshes=None)

Bases: object

Entity is the higher structure of sbsbaker info. It defined an object in the scene. SbsBakeInfoOutputHandler info return a list of SbsBakerInfoEntityStruct instance. Each arguments is accessible with attribute members.

Parameters:
enabled
class batchtools.sbsbaker_info_handlers.SbsBakerInfoLocStruct(local_transformation, global_transformation)

Bases: object

Loc handles location info of an object, member of SbsBakerInfoEntityStruct. Warning, the values is not relevant with obj format.

Parameters:
  • local_transformation – local transformation matrix
  • global_transformation – global transformation matrix
class batchtools.sbsbaker_info_handlers.SbsBakerInfoMeshStruct(label='', vertices_number=0, uvs=None, submeshes=None)

Bases: object

Mesh handles mesh info part of an object, member of SbsBakerInfoEntityStruct.

Parameters:
  • label – the name of the mesh part
  • vertices_number – mesh’s vertices number
  • uv_info – uv info handled by SbsBakerInfoUvStruct
  • sub_meshes – sub part of a mesh, usually defined by a material assignation or a shader group
class batchtools.sbsbaker_info_handlers.SbsBakerInfoSubmeshStruct(label='', color='', triangles_number=0)

Bases: object

Submesh handles submesh’s material info for each mesh’s submesh, member of SbsBakerInfoMeshStruct.

Parameters:
  • label – material name
  • color – color assignation
  • triangles_number – triangles number present in this submesh
class batchtools.sbsbaker_info_handlers.SbsBakerInfoUvStruct(is_in_unit_square='1', points_number=0, uv_tiles='', udim_tiles='')

Bases: object

Uv handles UV info for each mesh’s uv sets, member of SbsBakerInfoMeshStruct.

Parameters:
  • is_in_unit_square – if all the uvs is in the 0-1 space
  • points_number – points number
  • uv_tiles – uv tiles where points are present (could be several)
  • udim_tiles – udim tiles where points are present (could be several)
udim_tiles
uv_tiles

 Adobe

Get help faster and easier

New user?