Tronverte
API documentation for Tronverte products.
 All Classes Namespaces Files Functions Variables
Public Member Functions | Static Public Member Functions | Public Attributes
tronverte.maya.core.dag.DAG Class Reference

List of all members.

Public Member Functions

def __init__
def createNodeAttributes
def validate
def set
def create
def rename
def delete
def dag
def dg
def listShapes
def listChildren
def listParents
def parent
def unparent
def resetTransform
def list

Static Public Member Functions

def isUnique

Public Attributes

 nodeState
 nodeState attribute of the node as tronverte.maya.core.plug.Plug instance.
 translate
 translate attribute of the node as tronverte.maya.core.plug.Plug instance.
 t
 Short version of translate attribute of the node as tronverte.maya.core.plug.Plug instance.
 translateX
 translateX attribute of the node as tronverte.maya.core.plug.Plug instance.
 tx
 Short version of translateX attribute of the node as tronverte.maya.core.plug.Plug instance.
 translateY
 translateY attribute of the node as tronverte.maya.core.plug.Plug instance.
 ty
 Short version of translateY attribute of the node as tronverte.maya.core.plug.Plug instance.
 translateZ
 translateZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 tz
 Short version of translateZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 rotate
 rotate attribute of the node as tronverte.maya.core.plug.Plug instance.
 r
 Short version of rotate attribute of the node as tronverte.maya.core.plug.Plug instance.
 rotateX
 rotateX attribute of the node as tronverte.maya.core.plug.Plug instance.
 rx
 Short version of rotateX attribute of the node as tronverte.maya.core.plug.Plug instance.
 rotateY
 rotateY attribute of the node as tronverte.maya.core.plug.Plug instance.
 ry
 Short version of rotateY attribute of the node as tronverte.maya.core.plug.Plug instance.
 rotateZ
 rotateZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 rz
 Short version of rotateZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 scale
 scale attribute of the node as tronverte.maya.core.plug.Plug instance.
 s
 Short version of scale attribute of the node as tronverte.maya.core.plug.Plug instance.
 scaleX
 scaleX attribute of the node as tronverte.maya.core.plug.Plug instance.
 sx
 Short version of scaleX attribute of the node as tronverte.maya.core.plug.Plug instance.
 scaleY
 scaleY attribute of the node as tronverte.maya.core.plug.Plug instance.
 sy
 Short version of scaleY attribute of the node as tronverte.maya.core.plug.Plug instance.
 scaleZ
 scaleZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 sz
 Short version of scaleZ attribute of the node as tronverte.maya.core.plug.Plug instance.
 visibility
 visibility attribute of the node as tronverte.maya.core.plug.Plug instance.
 v
 Short version of visibility attribute of the node as tronverte.maya.core.plug.Plug instance.
 rotateOrder
 rotateOrder attribute of the node as tronverte.maya.core.plug.Plug instance.
 displayHandle
 displayHandle attribute of the node as tronverte.maya.core.plug.Plug instance.
 displayLocalAxis
 displayLocalAxis attribute of the node as tronverte.maya.core.plug.Plug instance.
 dagType
 Type of the DAG node.
 dgType
 Type of the DG node if applicable.
 extension
 Extension for the DAG node.
 dagPath
 Directed acyclic graph path of the node as maya.OpenMaya.MDagPath.
 dgDependencyNode
 Dependency node of the node as maya.OpenMaya.MFnDependencyNode which would be the shape of the node if applicable.

Detailed Description

import tronverte.maya.core.dag as tronverte_maya_core_dag
reload(tronverte_maya_core_dag)
dag = tronverte_maya_core_dag.DAG()

This is an abstract class and it needs to be inherited whenever you need to create a DAG node wrapped for Autodesk Maya.

Constructor & Destructor Documentation

def tronverte.maya.core.dag.DAG.__init__ (   self,
  name = None,
  force = False,
  stat = None 
)
# DESCRIPTION
Default constructor.

# ARGUMENTS
name  | str                               | None  | in  | * | arg | Name of the node. If node exists it will be set otherwise it will be created.
force | bool                              | False | in  | * | arg | Force creation. Create the node even if it exists. That will affect the given name.
stat  | tronverte.maya.core.status.Status | None  | out | * | arg | Status.

# RETURN
None

Member Function Documentation

def tronverte.maya.core.dag.DAG.create (   self,
  name = None,
  force = True,
  stat = None 
)
# DESCRIPTION
Create node.

# ARGUMENTS
name  | str                               | None | in  | * | arg | Name of the node. If this argument left out node type will be the name of the node.
force | bool                              | True | in  | * | arg | Force creation. Create the node even if it exists. That will affect the given name.
stat  | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
# DESCRIPTION
Create additional attributes of Maya node for the instance of the class by using tronverte.maya.core.plug.Plug instances.

# ARGUMENTS
None.

# RETURN
None
def tronverte.maya.core.dag.DAG.dag (   self,
  stat = None 
)
# DESCRIPTION
Get the name of the DAG node (transform) as string.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
str | Name of the DAG node.
def tronverte.maya.core.dag.DAG.delete (   self,
  stat = None 
)
# DESCRIPTION
Delete the node.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.dg (   self,
  stat = None 
)
# DESCRIPTION
Get the name of the DG node (shape of the node, if it's available) as string.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
str | Name of the DG node.
def tronverte.maya.core.dag.DAG.isUnique (   name,
  stat = None 
) [static]
# DESCRIPTION
Checks if the node is unique.

# ARGUMENTS
name | str                               | None | in  | + | arg | Name of the node that will be checked.
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.list (   cls,
  selected = False 
)
# DESCRIPTION
List nodes.

# ARGUMENTS
selected | bool | False | in | * | arg | List only selected nodes, otherwise list all nodes.

# RETURN
str list | Nodes.
def tronverte.maya.core.dag.DAG.listChildren (   self,
  stat = None 
)
# DESCRIPTION
List the children of the DAG node.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
str list | Children of the node. If there is no children method returns None.
def tronverte.maya.core.dag.DAG.listParents (   self,
  stat = None 
)
# DESCRIPTION
List parents of the DAG node.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
str list | Parent of the node. If there is no parent method returns None.
def tronverte.maya.core.dag.DAG.listShapes (   self,
  name = None,
  stat = None 
)
# DESCRIPTION
List the shapes of the DAG node.

# ARGUMENTS
name | str                               | None | in  | * | arg | Name of the DAG node. This argument can be left out if the current instance needs to be checked.
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
str list | Shapes of the node. If there is no shape method returns None.
def tronverte.maya.core.dag.DAG.parent (   self,
  parent,
  stat = None 
)
# DESCRIPTION
Parent the node.

# ARGUMENTS
parent | str, dag.DAG                      | None | in  | + | arg | Node that will be parent of the node.
stat   | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.rename (   self,
  name,
  stat = None 
)
# DESCRIPTION
Rename the node.

# ARGUMENTS
name | str                               | None | in  | + | arg | New name of the node.
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.resetTransform (   self,
  translate = True,
  rotate = True,
  scale = True,
  stat = None 
)
# DESCRIPTION
Set transform attributes zero.

# ARGUMENTS
translate | bool                              | True | in  | * | arg | Set translate attributes zero.
rotate    | bool                              | True | in  | * | arg | Set rotate attributes zero.
scale     | bool                              | True | in  | * | arg | Set scale attributes zero.
stat      | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.set (   self,
  name,
  stat = None 
)
# DESCRIPTION
Associate the given node with the instance of the class.

# ARGUMENTS
name | str                               | None | in  | + | arg | Name of the node.
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.unparent (   self,
  stat = None 
)
# DESCRIPTION
Unparent the node.

# ARGUMENTS
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.
def tronverte.maya.core.dag.DAG.validate (   self,
  name = None,
  stat = None 
)
# DESCRIPTION
Validate the node. Method checks if node exists, if it is unique and if the node type is correct.

# ARGUMENTS
name | str                               | None | in  | * | arg | Node that will be validated. This argument can be left out if the current instance needs to be checked.
stat | tronverte.maya.core.status.Status | None | out | * | arg | Status.

# RETURN
bool | Result.

Member Data Documentation

Directed acyclic graph path of the node as maya.OpenMaya.MDagPath.

Type of the DAG node.

Dependency node of the node as maya.OpenMaya.MFnDependencyNode which would be the shape of the node if applicable.

Type of the DG node if applicable.

displayHandle attribute of the node as tronverte.maya.core.plug.Plug instance.

displayLocalAxis attribute of the node as tronverte.maya.core.plug.Plug instance.

Extension for the DAG node.

nodeState attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of rotate attribute of the node as tronverte.maya.core.plug.Plug instance.

rotate attribute of the node as tronverte.maya.core.plug.Plug instance.

rotateOrder attribute of the node as tronverte.maya.core.plug.Plug instance.

rotateX attribute of the node as tronverte.maya.core.plug.Plug instance.

rotateY attribute of the node as tronverte.maya.core.plug.Plug instance.

rotateZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of rotateX attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of rotateY attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of rotateZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of scale attribute of the node as tronverte.maya.core.plug.Plug instance.

scale attribute of the node as tronverte.maya.core.plug.Plug instance.

scaleX attribute of the node as tronverte.maya.core.plug.Plug instance.

scaleY attribute of the node as tronverte.maya.core.plug.Plug instance.

scaleZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of scaleX attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of scaleY attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of scaleZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of translate attribute of the node as tronverte.maya.core.plug.Plug instance.

translate attribute of the node as tronverte.maya.core.plug.Plug instance.

translateX attribute of the node as tronverte.maya.core.plug.Plug instance.

translateY attribute of the node as tronverte.maya.core.plug.Plug instance.

translateZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of translateX attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of translateY attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of translateZ attribute of the node as tronverte.maya.core.plug.Plug instance.

Short version of visibility attribute of the node as tronverte.maya.core.plug.Plug instance.

visibility attribute of the node as tronverte.maya.core.plug.Plug instance.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables