alembic.AbcMaterial

AbcMaterial is a module which sits above Abc. It is not dependent upon AbcGeom – nor is AbcGeom currently dependent upon it. It provides schema and object types for representing materials and material bindings.

Explanation of terms

target: a string representing a target application or renderer by name and agreed-upon convention. Examples include “prman,” “arnold” and “maya.” The library could also include a document of conventions for interchange via a reserved “abc” target value. (More on this later).

shader type: a string representing a shader classification by name and agreed-upon convention. Examples include “surface,” “displacement” and “light.” This could also express things like “coshader_taco” in which the value text following the “coshader_” prefix is used as a coshader instance name.

shader name: a string identifying a shader object within a specified target and shader type. Examples include “paintedplastic” and “spot_light_v12.”

assignment: binding of a material object onto another object via an alembic object path

inheritance/flattening: combining the contributions of multiple material definitions. The common case is the flattening of a hierarchy of material objects following assignment. It can also reference to the combination of a locally defined material with that of an assigned material.

class alembic.AbcMaterial.ConnectionVector

append((ConnectionVector)arg1, (object)arg2) → None

extend((ConnectionVector)arg1, (object)arg2) → None

class alembic.AbcMaterial.IMaterial

doc

getSchema((IMaterial)arg1) → IMaterialSchema :

doc

static getSchemaObjTitle() → str :

doc

static getSchemaTitle() → str :

doc

static matches((MetaData)metaData[, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) → bool

matches( (ObjectHeader)metaData [, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) -> bool

reset((IMaterial)arg1) → None

valid((IMaterial)arg1) → bool

class alembic.AbcMaterial.IMaterialSchema

The IMaterialSchema class is a xform schema reader

getNetworkInterfaceParameterMapping((IMaterialSchema)arg1, (int)arg2) → dict

getNetworkInterfaceParameterMapping( (IMaterialSchema)arg1, (str)arg2) -> dict

getNetworkInterfaceParameterMappingNames((IMaterialSchema)arg1) → object

getNetworkInterfaceParameters((IMaterialSchema)arg1) → ICompoundProperty

getNetworkNode((IMaterialSchema)arg1, (str)arg2) → IMaterialSchemaNetworkNode

getNetworkNode( (IMaterialSchema)arg1, (int)arg2) -> IMaterialSchemaNetworkNode

getNetworkNodeNames((IMaterialSchema)arg1) → object

getNetworkTerminal((IMaterialSchema)arg1, (str)arg2, (str)arg3) → dict

getNetworkTerminalShaderTypesForTarget((IMaterialSchema)arg1, (str)arg2) → object

getNetworkTerminalTargetNames((IMaterialSchema)arg1) → object

getNumNetworkInterfaceParameterMappings((IMaterialSchema)arg1) → int

getNumNetworkNodes((IMaterialSchema)arg1) → int

getShader((IMaterialSchema)arg1, (str)arg2, (str)arg3) → str

getShaderParameters((IMaterialSchema)arg1, (str)arg2, (str)arg3) → ICompoundProperty

getShaderTypesForTarget((IMaterialSchema)arg1, (str)arg2) → object

getTargetNames((IMaterialSchema)arg1) → object

class alembic.AbcMaterial.IMaterialSchemaNetworkNode

getConnection((IMaterialSchemaNetworkNode)arg1, (int)arg2) → dict

getConnection( (IMaterialSchemaNetworkNode)arg1, (str)arg2) -> dict

getName((IMaterialSchemaNetworkNode)arg1) → str

getNodeType((IMaterialSchemaNetworkNode)arg1) → str

getNumConnections((IMaterialSchemaNetworkNode)arg1) → int

getParameters((IMaterialSchemaNetworkNode)arg1) → ICompoundProperty

getTarget((IMaterialSchemaNetworkNode)arg1) → str

valid((IMaterialSchemaNetworkNode)arg1) → bool

class alembic.AbcMaterial.ISchema_Material

Usually used as a base class, but could also theoretically be used as a standalone.

static getDefaultSchemaName() → str :

Return the default name for instances of this schema. Often something like ‘.geom’.

static getSchemaTitle() → str :

Return the schema title expected of this property.An empty title matches everything.

static matches((MetaData)metadata[, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) → bool :

This will check whether or not a given entity (as represented by a metadata) strictly matches the interpretation of this schema object.

matches( (PropertyHeader)header [, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) -> bool :

This will check whether or not a given entity (as represented by an object header) strictly matches the interpretation of thisschema object, as well as the datatype.

class alembic.AbcMaterial.MaterialFlatten

The MaterialFlatten class is a utility class for IMaterial

append((MaterialFlatten)arg1, (IMaterialSchema)arg2) → None

append( (MaterialFlatten)arg1, (IMaterial)arg2) -> None

empty((MaterialFlatten)arg1) → bool

getNetworkNode((MaterialFlatten)arg1, (int)arg2) → MaterialFlattenNetworkNode

getNetworkNode( (MaterialFlatten)arg1, (str)arg2) -> MaterialFlattenNetworkNode

getNetworkTerminal((MaterialFlatten)arg1, (str)arg2, (str)arg3) → dict

getNetworkTerminalShaderTypesForTarget((MaterialFlatten)arg1, (str)arg2) → object

getNetworkTerminalTargetNames((MaterialFlatten)arg1) → object

getNumNetworkNodes((MaterialFlatten)arg1) → int

getShader((MaterialFlatten)arg1, (str)arg2, (str)arg3) → str

getShaderParameters((MaterialFlatten)arg1, (str)arg2, (str)arg3) → ParameterEntryVector

getShaderTypesForTarget((MaterialFlatten)arg1, (str)arg2) → object

getTargetNames((MaterialFlatten)arg1) → object

class alembic.AbcMaterial.MaterialFlattenNetworkNode

getConnections((MaterialFlattenNetworkNode)arg1) → ConnectionVector

getName((MaterialFlattenNetworkNode)arg1) → str

getNodeType((MaterialFlattenNetworkNode)arg1) → str

getParameters((MaterialFlattenNetworkNode)arg1) → ParameterEntryVector

getTarget((MaterialFlattenNetworkNode)arg1) → str

valid((MaterialFlattenNetworkNode)arg1) → bool

class alembic.AbcMaterial.MaterialFlattenNetworkNodeConnection

connectedNodeName

connectedOutputName

inputName

class alembic.AbcMaterial.MaterialFlattenParameterEntry

header

name

parent

class alembic.AbcMaterial.OMaterial

doc

getSchema((OMaterial)arg1) → OMaterialSchema :

doc

static getSchemaObjTitle() → str :

doc

static getSchemaTitle() → str :

doc

static matches((MetaData)metaData[, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) → bool

matches( (ObjectHeader)metaData [, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) -> bool

reset((OMaterial)arg1) → None

valid((OMaterial)arg1) → bool

class alembic.AbcMaterial.OMaterialSchema

The OMaterialSchema class is a material schema writer

addNetworkNode((OMaterialSchema)arg1, (str)arg2, (str)arg3, (str)arg4) → None

getNetworkInterfaceParameters((OMaterialSchema)arg1) → OCompoundProperty

getNetworkNodeParameters((OMaterialSchema)arg1, (str)arg2) → OCompoundProperty

getShaderParameters((OMaterialSchema)arg1, (str)arg2, (str)arg3) → OCompoundProperty

setNetworkInterfaceParameterMapping((OMaterialSchema)arg1, (str)arg2, (str)arg3, (str)arg4) → None

setNetworkNodeConnection((OMaterialSchema)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5) → None

setNetworkTerminal((OMaterialSchema)arg1, (str)arg2, (str)arg3, (str)arg4, (str)arg5) → None

setShader((OMaterialSchema)arg1, (str)arg2, (str)arg3, (str)arg4) → None

class alembic.AbcMaterial.OSchema_Material

Usually used as a base class, but could also theoretically be used as a standalone.

static getDefaultSchemaName() → str :

Return the default name for instances of this schema. Often something like ‘.geom’.

getSchemaBaseType() → str :

Return the schema base type expected of this property.An empty base type means it’s the root type.

static getSchemaTitle() → str :

Return the schema title expected of this property.An empty title matches everything.

static matches((MetaData)metadata[, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) → bool :

This will check whether or not a given entity (as represented by a metadata) strictly matches the interpretation of this schema object.

matches( (PropertyHeader)header [, (SchemaInterpMatching)matchingSchema=alembic.Abc.SchemaInterpMatching.kStrictMatching]) -> bool :

This will check whether or not a given entity (as represented by an object header) strictly matches the interpretation of thisschema object, as well as the datatype.

class alembic.AbcMaterial.ParameterEntryVector

append((ParameterEntryVector)arg1, (object)arg2) → None

extend((ParameterEntryVector)arg1, (object)arg2) → None

alembic.AbcMaterial.addMaterial((OObject)iObject[, (str)iPropName='.material']) → OMaterialSchema

addMaterial( (OCompoundProperty)iProp [, (str)iPropName=’.material’]) -> OMaterialSchema

alembic.AbcMaterial.addMaterialAssignment((OObject)iObject, (str)iValue[, (str)iPropName='.material.assign']) → None

addMaterialAssignment( (OCompoundProperty)iProp, (str)iValue [, (str)iPropName=’.material.assign’]) -> None

alembic.AbcMaterial.getMaterialAssignmentPath((IObject)iObject[, (str)iPropName='.material.assign']) → str

getMaterialAssignmentPath( (ICompoundProperty)iProp [, (str)iPropName=’.material.assign’]) -> str

alembic.AbcMaterial.hasMaterial((IObject)iObject[, (str)iPropName='.material']) → IMaterialSchema

hasMaterial( (ICompoundProperty)iProp [, (str)iPropName=’.material’]) -> IMaterialSchema