sMayaCore.referenceLib.Reference Class Reference

[ CLASS ] - Class to operate on referenced nodes in Maya. More...

Inheritance diagram for sMayaCore.referenceLib.Reference:

Public Member Functions
def	__init__ (self, node=None)
	Constructor. More...
def	node (self)
	Node. More...
def	exists (self)
	Check whether the node exists. More...
def	setNode (self, node)
	Set node. More...
def	reload (self)
	Reload the referenced node. More...
def	duplicate (self)
	Duplicate given referenced node. More...
def	remove (self)
	Remove the given referenced node. More...
Public Member Functions inherited from sMayaCore.nameSpaceLib.NameSpace
def	__init__ (self, nameSpace=None)
	Constructor. More...
Public Member Functions inherited from sCore.nameSpaceLib.NameSpace
def	__init__ (self, nameSpace=None)
	Constructor. More...
def	head (self)
	Get name space portion of the name space. More...
def	tail (self)
	Get the tail portion of the name space. More...
def	isValid (cls, nameSpace)
	Determine whether given string is a valid name space. More...
def	removeNameSpace (cls, name)
	Remove name space from the given name. More...
def	addNameSpace (cls, nameSpace, name, removeExisting=True)
	Add given name space to given name. More...
def	nameSpace (self)
	NameSpace. More...
def	setNameSpace (self, nameSpace)
	Set name space. More...

Static Public Member Functions
def	isNodeReferenced (node)
	Check whether the given node is a referenced node. More...
def	create (mayaFile, nameSpace=None)
	Create reference from given file. More...
def	duplicateSelected ()
	Duplicate selected referenced nodes. More...
def	removeSelected ()
	Remove selected referenced nodes. More...
def	reloadSelected ()
	Reload selected referenced nodes. More...

Additional Inherited Members
Static Public Attributes inherited from sCore.nameSpaceLib.NameSpace
string	NAME_SPACE_DELIMITER = ':'
	[ str ] - Name space delimiter. More...
string	FULL_PATH_DELIMITER = '|'
	[ str ] - Full path delimiter. More...

Detailed Description

[ CLASS ] - Class to operate on referenced nodes in Maya.

import sys
import sMayaCore.referenceLib

reference = sMayaCore.referenceLib.Reference(node='someMayaFile:pCube1')

sys.stdout.write(reference.exists())
 # True

sys.stdout.write(reference.setNode(node='someMayaFile:pCube1'))
 # True

sys.stdout.write(reference.node())
 # someMayaFile:pCube1

sys.stdout.write(reference.reload())
 # True

sys.stdout.write(reference.duplicate())
 # /pathToFile/someMayaFile.ma{2}

sys.stdout.write(reference.remove())
 # True

sys.stdout.write(sMayaCore.referenceLib.Reference.create(mayaFile='/pathToFile/someMayaFile.ma'))
 # /pathToFile/someMayaFile.ma

sMayaCore.referenceLib.Reference.duplicateSelected()

sMayaCore.referenceLib.Reference.removeSelected()

sMayaCore.referenceLib.Reference.reloadSelected()

sys.stdout.write(sMayaCore.referenceLib.Reference.isNodeReferenced(node='someMayaFile:pCube1'))
 # True

sys.stdout.write(sMayaCore.referenceLib.Reference.isNodeReferenced(node='persp'))
 # False

Constructor & Destructor Documentation

__init__()

def sMayaCore.referenceLib.Reference.__init__	(		self,
			node = None
	)

Constructor.

Parameters

node	[ str | None | in ] - Name of the node.

Exceptions

N/A

Returns

None.

Member Function Documentation

node()

def sMayaCore.referenceLib.Reference.node

(

self

)

Node.

Exceptions

N/A

Returns

str - Name of the node.

None - If node is not set.

exists()

def sMayaCore.referenceLib.Reference.exists

(

self

)

Check whether the node exists.

Checks whether node is None. Checks whether the node exists.

Exceptions

N/A

Returns

bool - Result.

setNode()

def sMayaCore.referenceLib.Reference.setNode	(		self,
			node
	)

Set node.

Returns False if the node is not a referenced node.

Parameters

node	[ str | None | in ] - Name of the node.

Exceptions

N/A

Returns

bool - Result.

reload()

def sMayaCore.referenceLib.Reference.reload

(

self

)

Reload the referenced node.

Exceptions

N/A

Returns

bool - Result.

duplicate()

def sMayaCore.referenceLib.Reference.duplicate

(

self

)

Duplicate given referenced node.

Exceptions

N/A

Returns

str - Resolved name of the referenced file.

None - If not is not set.

remove()

def sMayaCore.referenceLib.Reference.remove

(

self

)

Remove the given referenced node.

Exceptions

N/A

Returns

bool - Result.

isNodeReferenced()

def sMayaCore.referenceLib.Reference.isNodeReferenced (   node )

static

Check whether the given node is a referenced node.

Parameters

node	[ str | None | in ] - Name of the node.

Exceptions

N/A

Returns

bool - Result.

create()

def sMayaCore.referenceLib.Reference.create (   mayaFile,   nameSpace = None  )

static

Create reference from given file.

If nameSpace argument left out, file name will be the name space for the referenced nodes.

Parameters

mayaFile	[ str | None | in ] - Name of the file, Maya ASCII or Maya Binary.
nameSpace	[ str | None | in ] - Namespace of the referenced nodes.

Exceptions

N/A

Returns

str - Resolved name of the referenced file.

None - If maya file doesn't exist.

duplicateSelected()

def sMayaCore.referenceLib.Reference.duplicateSelected ( )

static

Duplicate selected referenced nodes.

Exceptions

N/A

Returns

None

removeSelected()

def sMayaCore.referenceLib.Reference.removeSelected ( )

static

Remove selected referenced nodes.

Method actually removes the referenced file which will be retrieved from the referenced nodes.

Exceptions

N/A

Returns

None

reloadSelected()

def sMayaCore.referenceLib.Reference.reloadSelected ( )

static

Reload selected referenced nodes.

Method actually reloads the referenced file which will be retrieved from the referenced nodes.

Exceptions

N/A

Returns

None

---

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

• sMayaCore/python/sMayaCore/referenceLib.py