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__
def	expand
def	update
def	set_display
def	set_token

Public Attributes
	expr

Detailed Description

Class maintaining an up-to-date StringExpression object.

Constructor & Destructor Documentation

def rfm2.api.strings.SceneStringConverter.__init__

(

self

)

Member Function Documentation

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

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>

Returns:
- The expanded string

Here is the call graph for this function:

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:

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:

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

rfm2.api.strings.SceneStringConverter.expr

---

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

• /data/wlw/renderman_root/rat/apps/rfm/scripts/rfm2/api/strings.py