rfm2.api.strings.SceneStringConverter Class Reference

Inheritance diagram for rfm2.api.strings.SceneStringConverter:

Collaboration diagram for rfm2.api.strings.SceneStringConverter:

Public Member Functions
def	__init__ (self)
def	expand (self, string, display=None, frame=None, asFilePath=False)
def	update (self)
def	set_display (self, display)
def	set_token (self, key, value)
def	get_token (self, key)
def	set_locked_jobid (self, value)
def	reset_jobid (self)

Public Attributes
	expr

Detailed Description

Class maintaining an up-to-date StringExpression object.

Constructor & Destructor Documentation

__init__()

def rfm2.api.strings.SceneStringConverter.__init__

(

self

)

Member Function Documentation

expand()

def rfm2.api.strings.SceneStringConverter.expand	(		self,
			string,
			display = None,
			frame = None,
			asFilePath = False
	)

Expand the <tokens> in the string.

Args:
- string (str): The string to be expanded.

Kwargs:
- display (str): The display being considered. This is necessary if your
expression contains <aov> or <ext>
- frame (int): An optional frame number to expand <f>, <f4>, etc.

Returns:
- The expanded string

Here is the call graph for this function:

get_token()

def rfm2.api.strings.SceneStringConverter.get_token	(		self,
			key
	)

Gets a token's value in the StringExpression object.

Args:
- key (str): the token's name

Here is the call graph for this function:

Here is the caller graph for this function:

reset_jobid()

def rfm2.api.strings.SceneStringConverter.reset_jobid

(

self

)

reset rmanGlobals.jobid to '', so that StringExpression.set_jobid()
may generate a new value.

Here is the caller graph for this function:

set_display()

def rfm2.api.strings.SceneStringConverter.set_display	(		self,
			display
	)

Sets the <aov> and <ext> tokens based on the display.

Args:
- display (str): the name of the display node.

Here is the call graph for this function:

Here is the caller graph for this function:

set_locked_jobid()

def rfm2.api.strings.SceneStringConverter.set_locked_jobid	(		self,
			value
	)

Sets the current jobid to a specific string value. If None is passed,
we let StringExpression object generate a new jobid and store it.

NOTE: The jobid is stored in rmanGlobals.jobid. If its value is '',
StringExpression.set_jobid() will generate a new value but NOT store it
on rmanGlobals.

Arguments:
    value {str} -- the jobid value

Here is the call graph for this function:

set_token()

def rfm2.api.strings.SceneStringConverter.set_token	(		self,
			key,
			value
	)

Sets a token's value in the StringExpression object.

Args:
- key (str): the token's name
- value (str): the token's value

Here is the call graph for this function:

update()

def rfm2.api.strings.SceneStringConverter.update

(

self

)

Create a new StringExpression and configures it for the current state
of the scene.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

expr

rfm2.api.strings.SceneStringConverter.expr

---

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

• /Users/plp/Perforce/plp_thebridge_rman_24_dev/rat/apps/rfm/scripts/rfm2/api/strings.py