tronverte.maya.core.dg.DG Class Reference

List of all members.

Public Member Functions
def	__init__
def	createNodeAttributes
def	validate
def	set
def	create
def	rename
def	delete
def	dg
def	list
Static Public Member Functions
def	isUnique
Public Attributes
	dgType
	Type of the DG node.
	extension
	Extension for the DG node.
	nodeState
	nodeState attribute of the node as tronverte.maya.core.plug.Plug instance.
	dgDependencyNode

---

Detailed Description

import tronverte.maya.core.dg as tronverte_maya_core_dg
reload(tronverte_maya_core_dg)
dg = tronverte_maya_core_dg.DG()

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

---

Constructor & Destructor Documentation

def tronverte.maya.core.dg.DG.__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.dg.DG.create	(		self,
			name = None,
			force = False,
			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                              | 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
bool | Result.

def tronverte.maya.core.dg.DG.createNodeAttributes

(

self

)

# 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.dg.DG.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.dg.DG.dg	(		self,
			stat = None
	)

# DESCRIPTION
Get the name of the node as string.

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

# RETURN
str | Name of the node.

def tronverte.maya.core.dg.DG.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.dg.DG.list	(		cls,
			selected = False
	)

# DESCRIPTION
List nodes by node type of the instance class.

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

# RETURN
str list | Nodes.

def tronverte.maya.core.dg.DG.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.dg.DG.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.dg.DG.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

tronverte::maya::core::dg.DG::dgDependencyNode

tronverte::maya::core::dg.DG::dgType

Type of the DG node.

tronverte::maya::core::dg.DG::extension

Extension for the DG node.

tronverte::maya::core::dg.DG::nodeState

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

---

The documentation for this class was generated from the following file:

• tronverte/maya/core/dg.py