zBuilder.nodes.ziva package

Submodules

zBuilder.nodes.ziva.zAttachment module

class zBuilder.nodes.ziva.zAttachment.AttachmentNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zAttachments.

MAP_LIST = ['weightList[0].weights', 'weightList[1].weights']

List of maps to store.

build(*args, **kwargs)[source]

Builds the zAttachment in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • interp_maps (str) – Interpolating maps. Defaults to auto
  • permissive (bool) – Pass on errors. Defaults to True
type = 'zAttachment'

The type of node.

zBuilder.nodes.ziva.zBone module

class zBuilder.nodes.ziva.zBone.BoneNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zBones.

build(*args, **kwargs)[source]

Builds the zBones in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
type = 'zBone'

The type of node.

zBuilder.nodes.ziva.zBone.apply_multiple(parameters, attr_filter=None, permissive=False)[source]

Each node can deal with it’s own building. Though, with zBones it is much faster to build them all at once with one command instead of looping through them. This function builds all the zBones at once.

Parameters:
  • permissive (bool) –
  • parameters
  • attr_filter (obj) –

Returns:

zBuilder.nodes.ziva.zCloth module

class zBuilder.nodes.ziva.zCloth.ClothNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zCloth.

build(*args, **kwargs)[source]

Builds the zCloth in maya scene.

Parameters:attr_filter (dict) –

Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

tmp = {‘zSolver’:[‘substeps’]}

type = 'zCloth'

The type of node.

zBuilder.nodes.ziva.zEmbedder module

class zBuilder.nodes.ziva.zEmbedder.EmbedderNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zEmebedder.

build(*args, **kwargs)[source]

Builds the zEmbedder in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
get_collision_meshes(long_name=False)[source]

Gets the collision meshes stored. :param long_name: Returns long name or short. Default False :type long_name: bool

Returns:String of collision mesh name.
Return type:str
get_embedded_meshes(long_name=False)[source]

Gets the embedded meshes stored. :param long_name: Returns long name or short. Default False :type long_name: bool

Returns:String of embedded mesh name.
Return type:str
populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.
set_collision_meshes(meshes)[source]

Sets the collision meshes.

Parameters:meshes (list) – The meshes to set.
set_embedded_meshes(meshes)[source]

Sets the embedded meshes.

Parameters:meshes (list) – The meshes to set.
type = 'zEmbedder'

The type of node.

zBuilder.nodes.ziva.zEmbedder.get_embedded_meshes(bodies)[source]

Returns embedded meshes for given body. :param bodies: Maya mesh to find embedded meshes with.

Returns:of embedded meshes and collision meshes.
Return type:2 dict

zBuilder.nodes.ziva.zFiber module

class zBuilder.nodes.ziva.zFiber.FiberNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zFibers.

MAP_LIST = ['weightList[0].weights', 'endPoints']

List of maps to store.

build(*args, **kwargs)[source]

Builds the zFiber in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • interp_maps (str) – Interpolating maps. Defaults to auto
  • permissive (bool) – Pass on errors. Defaults to True
get_map_meshes()[source]

This is the mesh associated with each map in obj.MAP_LIST. Typically it seems to coincide with mesh store in get_association. Sometimes it deviates, so you can override this method to define your own list of meshes against the map list.

Returns:of long mesh names.
Return type:list()
type = 'zFiber'

The type of node.

zBuilder.nodes.ziva.zFieldAdaptor module

class zBuilder.nodes.ziva.zFieldAdaptor.FieldAdaptorNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to fields.

build(*args, **kwargs)[source]

Builds the zFieldAdaptor in maya scene.

This keeps track of inputs and outputs of zFieldadaptor (field nodes and zCloth, zTissue respecitvely) and re-connects them.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
input_field

Name of parameter corresponding to maya node name. Setting this property will check for long name and store that. self.input_field still returns short name, self.long_field_name returns the stored long name.

long_field_name

Long name of parameter corresponding to long name of maya node. This property is not settable. To set it use self.input_field.

populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.
type = 'zFieldAdaptor'

The type of node.

zBuilder.nodes.ziva.zFieldAdaptor.get_bodies(zFieldAdaptor)[source]

This gets the output bodies associated with a zFieldAdaptor.

Parameters:zNode (string) – [description]
zBuilder.nodes.ziva.zFieldAdaptor.get_field(zFieldAdaptor)[source]

This gets the field associated with a zFieldAdaptor.

Parameters:zNode (string) – [description]

zBuilder.nodes.ziva.zLineOfAction module

class zBuilder.nodes.ziva.zLineOfAction.LineOfActionNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zLineOfAction.

build(*args, **kwargs)[source]

Builds the Line of Actions in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.
spawn_parameters()[source]

Returns:

type = 'zLineOfAction'

The type of node.

zBuilder.nodes.ziva.zMaterial module

class zBuilder.nodes.ziva.zMaterial.MaterialNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zMaterials.

MAP_LIST = ['weightList[0].weights']

List of maps to store.

build(*args, **kwargs)[source]

Builds the zMaterial in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • interp_maps (str) – Interpolating maps. Defaults to auto
  • permissive (bool) – Pass on errors. Defaults to True
type = 'zMaterial'

The type of node.

zBuilder.nodes.ziva.zRelaxer module

class zBuilder.nodes.ziva.zRelaxer.ZRelaxerNode(parent=None, maya_node=None, builder=None, deserialize=None)[source]

Bases: zBuilder.nodes.deformer.Deformer

MAP_LIST = ['weightList[0].weights']
build(*args, **kwargs)[source]

Builds the node in maya. mean to be overwritten.

type = 'zRelaxer'

zBuilder.nodes.ziva.zRivetToBone module

class zBuilder.nodes.ziva.zRivetToBone.RivetToBoneNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zRivetToBone.

build(*args, **kwargs)[source]

Builds the zRivetToBone in maya scene.

Kwargs:
attr_filter (dict): Attribute filter on what attributes to get.

dictionary is key value where key is node type and value is list of attributes to use.

tmp = {‘zSolver’:[‘substeps’]}

permissive (bool): Pass on errors. Defaults to True

curve

Name of parameter corresponding to maya node name. Setting this property will check for long name and store that. self.name still returns short name, self.long_name returns the stored long name.

long_curve_name

Long name of parameter corresponding to long name of maya node. This property is not settable. To set it use self.name.

populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.
type = 'zRivetToBone'

The type of node.

zBuilder.nodes.ziva.zRivetToBone.is_cv_connected_to_rivet(crv, cv)[source]

zBuilder.nodes.ziva.zSolver module

class zBuilder.nodes.ziva.zSolver.SolverNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node is for storing information related to zSolver.

build(*args, **kwargs)[source]

Builds the zSolver in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
type = 'zSolver'

The type of node.

zBuilder.nodes.ziva.zSolverTransform module

class zBuilder.nodes.ziva.zSolverTransform.SolverTransformNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zSolverTransform.

build(*args, **kwargs)[source]

Builds the zSolverTransform in maya scene.

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • permissive (bool) – Pass on errors. Defaults to True
type = 'zSolverTransform'

The type of node.

zBuilder.nodes.ziva.zTet module

class zBuilder.nodes.ziva.zTet.TetNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zTets.

MAP_LIST = ['weightList[0].weights']

List of maps to store.

apply_user_tet_mesh()[source]

Applies the user tet mesh if any.

build(*args, **kwargs)[source]

Builds the zTets in maya scene.

These get built after the tissues so it is assumed they are in scene. This just checks what tet is associated with mesh and uses that one, renames it and stores mObject then changes attributes. There is only ever 1 per mesh so no need to worry about multiple tets

Parameters:
  • attr_filter (dict) –

    Attribute filter on what attributes to get. dictionary is key value where key is node type and value is list of attributes to use.

    tmp = {‘zSolver’:[‘substeps’]}

  • interp_maps (str) – Interpolating maps. Defaults to auto
  • permissive (bool) – Pass on errors. Defaults to True
get_user_tet_mesh(long_name=False)[source]

Get user tet mesh. :param long_name: return long name or not. Defaults to False

Returns:String of user tet mesh name.
Return type:str
set_user_tet_mesh(mesh)[source]

Setting of the user tet mesh. :param mesh: A maya mesh. :type mesh: str

type = 'zTet'

The type of node.

zBuilder.nodes.ziva.zTissue module

class zBuilder.nodes.ziva.zTissue.TissueNode(*args, **kwargs)[source]

Bases: zBuilder.nodes.ziva.zivaBase.Ziva

This node for storing information related to zTissues.

build(*args, **kwargs)[source]

Builds the zTissue in maya scene.

Kwargs:
attr_filter (dict): Attribute filter on what attributes to get.

dictionary is key value where key is node type and value is list of attributes to use.

tmp = {‘zSolver’:[‘substeps’]}

interp_maps (str): Interpolating maps. Defaults to auto permissive (bool): Pass on errors. Defaults to True

populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.
type = 'zTissue'

The type of node.

zBuilder.nodes.ziva.zTissue.build_multiple(tissue_items, tet_items, interp_maps='auto', attr_filter=None, permissive=True, solver=None)[source]

Each node can deal with it’s own building. Though, with zBones it is much faster to build them all at once with one command instead of looping through them. This function builds all the zBones at once.

Parameters:
  • permissive (bool) –
  • tissue_items
  • tet_items
  • attr_filter (obj) –
  • solver
  • interp_maps

Returns:

zBuilder.nodes.ziva.zTissue.get_tissue_children(ztissue)[source]

This checks a zTissue if it has children. Useful for sub-tissues. :param ztissue: The zTissue object in the maya scene. :type ztissue: str

Returns:(str) Children mesh of zTissue, or None if none found.
zBuilder.nodes.ziva.zTissue.get_tissue_parent(ztissue)[source]

This checks a zTissue if it has a parent. Useful for sub-tissues. :param ztissue: The zTissue object in the maya scene. :type ztissue: str

Returns:(str) Parent mesh of zTissue, or None if none found

zBuilder.nodes.ziva.zivaBase module

class zBuilder.nodes.ziva.zivaBase.Ziva(parent=None, maya_node=None, builder=None, deserialize=None)[source]

Bases: zBuilder.nodes.deformer.Deformer

Base node for Ziva type nodes.

extended from base to deal with maps and meshes and storing the solver.

EXTEND_ATTR_LIST = []
static check_meshes()[source]

Checks meshes for potential problems

This checks meshes for known problems that would prevent a body from being created and raises an error if found. This does not check problems that would cause a warning.

Parameters:meshes (list) – list of meshes to check
Raises:StandardError – if any mesh fails a check
populate(maya_node=None)[source]

This populates the node given a selection.

Parameters:maya_node – Maya node to populate with.

Module contents