pyfrost.api.maya

Maya Node API.

author

Benoit Gielly <benoit.gielly@gmail.com>

The intention here is to build a node API specific to each DDC (here, Maya), so in the main.py we can call that and remove the cmds calls.

When a DCC is started, the relevant API is injected in the Main one.

Note

This is a Work in Progress for now and not in use.

Example

If we were to rewrite the pyfrost.main.Graph.validate_board method, we could like that:

def __init__(self):
    self.api = Api()

def validate_board(self, name=None):
    node = self.api[name]
    if node.exists and node.type == "bifrostBoard":
        return name
    name = name if name else "bifrostGraph"
    board = api.create("bifrostBoard", name)
    return board.name

That way, all the main code remains clean of DCC commands. Obviously, each DCCs APIs must be implemented the same way for this to work.

class MayaAPI

Bases: object

Create a Maya API object.

__repr__()

Return repr(self).

__getitem__(key)

create(nodetype, name=None)

Create new node.

get(name)

Get existing node.

class MayaNode(api, node)

Bases: object

Get MayaNode object.

__init__(api, node)

Initialize self. See help(type(self)) for accurate signature.

__repr__(*args, **kwargs)

Return repr(self).

__str__()

Return str(self).

__getitem__(key)

type()

Get node type.

rename(name)

Rename node.

class MayaAttr(node, name)

Bases: object

Create a Maya Attribute class.

__init__(node, name)

Initialize self. See help(type(self)) for accurate signature.

__repr__()

Return repr(self).

__str__()

Return str(self).

property plug

Get plug.

exists()

Check if node exists.

property value

Get & set attribute’s value.

property type

Get & set attribute’s type.

add(type_, **kwargs)

Add attribute on node.

get()

Set node’s attribute value.

set(value)

Set node’s attribute value.

connect(target)

Connect current node to target.

disconnect(target)

Disconnect current node from target.