assetQC::api::utils Namespace Reference

Functions
def	formatInstances
def	getHostApplication
def	isMayaRunning
def	isStandaloneRunning
def	printProgress
def	printProgressNum
def	progressNum
Variables
string	ASSET_TYPE_ALL = 'all'
string	HOST_APP_ALL = 'all'
string	HOST_APP_MAYA = 'maya'
string	HOST_APP_STANDALONE = 'standalone'

---

Detailed Description

Low-level utilities for the 'check asset' tool.

Intended to be used for internal use ONLY.

---

Function Documentation

def assetQC.api.utils.formatInstances	(		context,
			validFilter
	)

Returns information about all instances and their validity. 

:param context: 
:param validFilter: 
:return: 

def assetQC.api.utils.getHostApplication

(

)

def assetQC.api.utils.isMayaRunning

(

)

Determines if we are running inside Autodesk Maya.

:return: True or False. 

def assetQC.api.utils.isStandaloneRunning

(

)

Determines if we are running inside the standalone Python interpreter.

:return: True or False. 

def assetQC.api.utils.printProgress	(		msg,
			index,
			total,
			minNum,
			maxNum,
			progressCb
	)

Print a progress number to the log.

:param msg: Text for the progress. For example the 'step' that has progress.
:param index: 
:param total: 
:param minNum: 
:param maxNum: 
:param progressCb: 
:return: 

Here is the call graph for this function:

def assetQC.api.utils.printProgressNum	(		msg,
			num,
			progressCb,
			logger = None
	)

Print a progress number to the log. 

def assetQC.api.utils.progressNum	(		index,
			totalNum,
			minNum,
			maxNum
	)

:param index: 
:param totalNum: 
:param minNum: 
:param maxNum: 
:return: 

Here is the caller graph for this function:

---

Variable Documentation

string assetQC::api::utils::ASSET_TYPE_ALL = 'all'

string assetQC::api::utils::HOST_APP_ALL = 'all'

string assetQC::api::utils::HOST_APP_MAYA = 'maya'

string assetQC::api::utils::HOST_APP_STANDALONE = 'standalone'