rfm2.api.strings Namespace Reference

Classes
class	SceneStringConverter

Functions
def	get_user_tokens ()
def	get_all_tokens ()
def	expand_string (string, display=None, glob_sequence=False, frame=None, jobid=None, asFilePath=False)
def	converter_validity_check ()
def	lock_jobid (value)
def	unlock_jobid ()
def	set_var (nm, val)
def	get_var (nm)
def	reset_vars ()
def	get_str_attr (nodeattr, glob_sequence=False, frame=None)

Variables
list	PAD_FMT = ['%d', '%01d', '%02d', '%03d', '%04d']

Function Documentation

converter_validity_check()

def rfm2.api.strings.converter_validity_check

(

)

Here is the caller graph for this function:

expand_string()

def rfm2.api.strings.expand_string	(		string,
			display = None,
			glob_sequence = False,
			frame = None,
			jobid = None,
			asFilePath = False
	)

expand a string containing tokens.

Args:
- string (str): a string that may or may not contain tokens.

Kwargs:
- display (str): the name of a rmanDisplay node that should be used to
update the <aov> and <ext> tokens.

Returns:
- The expanded string.

Here is the caller graph for this function:

get_all_tokens()

def rfm2.api.strings.get_all_tokens

(

)

Returns all tokens from the render globals as a dict. This includes the
user tokens.

Here is the call graph for this function:

Here is the caller graph for this function:

get_str_attr()

def rfm2.api.strings.get_str_attr	(		nodeattr,
			glob_sequence = False,
			frame = None
	)

getAttr a maya string plug and return its expanded value if it contains tokens.

Args:
- nodeattr (str): the plug, i.e. 'PxrDomeLight1.lightColorMap'.

Returns:
- expanded value of the attribute.

Here is the call graph for this function:

get_user_tokens()

def rfm2.api.strings.get_user_tokens

(

)

Return the string substitution user tokens as a dict.

Here is the caller graph for this function:

get_var()

def rfm2.api.strings.get_var

(

nm

)

Here is the call graph for this function:

lock_jobid()

def rfm2.api.strings.lock_jobid

(

value

)

Sets the jobid value so it remains constant until unlock_jobid() is called.
See set_locked_jobid() above for details.

Here is the call graph for this function:

reset_vars()

def rfm2.api.strings.reset_vars

(

)

set_var()

def rfm2.api.strings.set_var	(		nm,
			val
	)

Here is the call graph for this function:

unlock_jobid()

def rfm2.api.strings.unlock_jobid

(

)

Unlock the jobid so it may be set to another value.

Here is the call graph for this function:

Variable Documentation

PAD_FMT

list rfm2.api.strings.PAD_FMT = ['%d', '%01d', '%02d', '%03d', '%04d']