User Guide Cancel

ag_types | Substance 3D Automation ToolKit

Search
Substance 3D Automation Toolkit

Substance 3D Automation Toolkit

Open app
  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

ag_types

Module ag_types defines a set of types for making it more convenient to write pixel processors, dynamic values and functions.

It provides the definition of the classes:

 class autograph.ag_types.TypeInfo(base_type, vector_size=1)

Bases: object

Class representing type information

 static type_to_string(a)  
 class autograph.ag_types.Type(new_node, fn_ctx, type_info)

Bases: object

Base class for all sbs types

 class autograph.ag_types.VectorType(new_node, fn_ctx, type_info)

Bases: autograph.ag_types.Type

Base class for scalar and vector arithmetic types (float, int)

 class autograph.ag_types.FloatType(new_node, fn_ctx, type_info)

Bases: autograph.ag_types.VectorType

Base class for float scalar and vector arithmetic types

 class autograph.ag_types.Float1(new_node, fn_ctx)

Bases: autograph.ag_types.FloatType

Scalar float node type

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Float2(new_node, fn_ctx)

Bases: autograph.ag_types.FloatType

Float vector 2

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Float3(new_node, fn_ctx)

Bases: autograph.ag_types.FloatType

Float vector 3

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Float4(new_node, fn_ctx)

Bases: autograph.ag_types.FloatType

Float vector 4

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.IntType(new_node, fn_ctx, type_info)

Bases: autograph.ag_types.VectorType

Base class for int types

 class autograph.ag_types.Int1(new_node, fn_ctx)

Bases: autograph.ag_types.IntType

Int scalar type

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Int2(new_node, fn_ctx)

Bases: autograph.ag_types.IntType

Int vector 2 type

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Int3(new_node, fn_ctx)

Bases: autograph.ag_types.IntType

Int vector 3 type

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Int4(new_node, fn_ctx)

Bases: autograph.ag_types.IntType

Int vector 4 type

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 class autograph.ag_types.Boolean(new_node, fn_ctx)

Bases: autograph.ag_types.Type

Boolean type, always scalar

 static constant(x, fn_ctx)  
 static variable(name, fn_ctx)  
 autograph.ag_types.create_constant(fn_node, type_enum, val, vector_size)

Creates a constant

Parameters:
  • fn_node (SBSFunction) – The function to create the constant in
  • type_enum (FunctionEnum) – The type of constant to create
  • val (numeric type or list of numeric types) – Constant value
  • vector_size (int) – Size of vector
Returns:

Type

 
 autograph.ag_types.create_variable(fn_node, type_enum, name)

Creates a variable (i.e a named input reference)

Parameters:
  • fn_node (SBSFunction) – The function to create the variable in in
  • type_enum (FunctionEnum) – The type of variable to create
  • name (string) – Name of variable
Returns:

Type

 Adobe

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy