User Guide Cancel

ag_layout | Substance 3D Automation ToolKit

Last updated on May 24, 2023

Substance 3D home
Home
Command Line Tools
1. Command Line overview
2. sbsbaker
3. sbscooker
4. sbsmtools
  1. sbsmtools overview
  2. sbsmtools command line options
5. sbsmutator
6. sbsrender
7. sbsupdater
  1. sbsupdater overview
  2. sbsupdater command line options
Pysbs - Python API
1. Pysbs - Python API overview
2. Getting started
3. General topics
4. Examples
5. API Content
  1. API Content overview
  2. Substance definitions
    1. Common interfaces
    2. compnode
    3. context projectmgr
    4. graph
    5. mdl
    6. modelgraphindex
    7. params
    8. projectmgrdoc
    9. sbsarchive
    10. sbscommon
      1. connections
      2. gui
      3. nodes
      4. values
    11. sbspreset
    12. sbsproject
    13. substance
  3. Libraries
    1. sbsenum
    2. sbslibrary
    3. sbsbakerslibrary
    4. Helpers
      1. sbscleaner
      2. sbsexporter
      3. sbsgenerator
      4. sbsparser
      5. sbswriter
      6. qtclasses
        
        qtclasses overview
        
        qtvariantreader
        
        qtvariantwriter
      7. psdparser
      8. sbsimpactmanager
      9. batchtools
      10. autograph
        
        ag_functions
        
        ag_layout
        
        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
Samples
Setup and Getting Started
Integrations
1. Substance Maya toolset
  1. Substance Maya Toolset overview
  2. Installing
  3. Launching
  4. Baking
  5. Changelog
Changelog overview

ag_layout

Module ag_layout provides the definition of the functions layoutGraph(), and layoutDoc() for automatically organizing the nodes in a graph or all graphs in a document respectively.

class autograph.ag_layout.NodesToKeepEnum

Bases: object

Enumeration of what nodes to keep when laying out a graph

KEEP_ALL_NODES= 0 
KEEP_COMPUTED_NODES= 1 
KEEP_COMPUTED_AND_INPUT_NODES= 2

class autograph.ag_layout.GUIElementsToKeepEnum

Bases: object

Enumeration treatments of gui elements when laying out a graph

KEEP_ALL= 0 
KEEP_NONE= 1 
KEEP_NON_EMPTY= 2

class autograph.ag_layout.GraphFlowDirectionEnum

Bases: object

Enumeration layout directions for graphs

RIGHTWARD= 0 
UPWARD= 1

class autograph.ag_layout.GraphLayoutAlignment

Bases: object

Enumeration what side of a graph to align when laying out a graph

OUTPUTS= 0 
INPUTS= 1

autograph.ag_layout.layoutGraph(graph, aNodeSpacing=160, aNodeShift=(80, 0), nodesToKeep=0, layoutAlignment=0, commentsToKeep=0, framesToKeep=0, navigationPinsToKeep=0)

Lays out a graph

Parameters:

Parameters:	graph (`SBSDynamicValue` or `SBSGraph` or `SBSFunction` or `SBSParamsGraph` or :class:.`MDLGraph`) – graph to layout aNodeSpacing (int) – distance to keep between nodes when laying them out aNodeShift (tuple of int) – Start position for the laid out graph nodesToKeep (`NodesToKeepEnum`) – What nodes to keep in the graph layoutAlignment (`GraphLayoutAlignment`) – Enum selecting whether to traverse from inputs or outputs commentsToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep comments framesToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep frames navigationPinsToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep navigation pins
Returns:	None

graph (SBSDynamicValue or SBSGraph or SBSFunction or SBSParamsGraph or :class:.`MDLGraph`) – graph to layout
aNodeSpacing (int) – distance to keep between nodes when laying them out
aNodeShift (tuple of int) – Start position for the laid out graph
nodesToKeep (NodesToKeepEnum) – What nodes to keep in the graph
layoutAlignment (GraphLayoutAlignment) – Enum selecting whether to traverse from inputs or outputs
commentsToKeep (GUIElementsToKeepEnum) – Whether to delete or keep comments
framesToKeep (GUIElementsToKeepEnum) – Whether to delete or keep frames
navigationPinsToKeep (GUIElementsToKeepEnum) – Whether to delete or keep navigation pins

Returns:

None

autograph.ag_layout.layoutDoc(sbsDoc, aNodeSpacing=160, aNodeShift=(80, 0), nodesToKeep=0, layoutAlignment=0, commentsToKeep=0, framesToKeep=0, navigationPinsToKeep=0)

Layout all graphs in an sbs document

Parameters:

Parameters:	sbsDoc – Document to layout aNodeSpacing (int) – distance to keep between nodes when laying them out aNodeShift (tuple of int) – Start position for the laid out graphs nodesToKeep (`NodesToKeepEnum`) – What nodes to keep in the graph layoutAlignment (`GraphLayoutAlignment`) – Enum selecting whether to traverse from inputs or outputs commentsToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep comments framesToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep frames navigationPinsToKeep (`GUIElementsToKeepEnum`) – Whether to delete or keep navigation pins
Returns:	None

sbsDoc – Document to layout
aNodeSpacing (int) – distance to keep between nodes when laying them out
aNodeShift (tuple of int) – Start position for the laid out graphs
nodesToKeep (NodesToKeepEnum) – What nodes to keep in the graph
layoutAlignment (GraphLayoutAlignment) – Enum selecting whether to traverse from inputs or outputs
commentsToKeep (GUIElementsToKeepEnum) – Whether to delete or keep comments
framesToKeep (GUIElementsToKeepEnum) – Whether to delete or keep frames
navigationPinsToKeep (GUIElementsToKeepEnum) – Whether to delete or keep navigation pins

Returns:

None

Get help faster and easier

New user?

ag_layout | Substance 3D Automation ToolKit

ag_layout

Get help faster and easier

Ask the Community

Contact Us