rfm2.render Namespace Reference

Classes
class	OutputTo
class	Message
class	RenderState

Functions
def	show_it
def	show_localqueue
def	show_licenseapp
def	show_render_view
def	show_render_destination
def	render_with_renderman
def	m_str
def	get_render_arguments
def	update_ipr_icons
def	close_viewports
def	ipr
def	preview
def	ipr_is_running
def	ipr_destination
def	render_type
def	frame
def	sequence
def	register_prefs
def	rman_cmd
def	register_desc_to_plugin
def	init

Variables
tuple	MAYA_VERSION_STR = mc.about(version=True)
list	MSG_STR
int	RT_IPR = 0
int	RT_PREVIEW = 1
int	RT_BATCH = 2
tuple	RNDR = RenderState()

Function Documentation

def rfm2.render.close_viewports

(

)

Here is the caller graph for this function:

def rfm2.render.frame

(

args

)

Here is the call graph for this function:

def rfm2.render.get_render_arguments

(

)

returns any arguments render might need. Currently
only:
 ["-shadinggroups", "sg1", "sg2"... ] any sg's possibly needed by abind rif

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.init

(

config

)

Load the rfm plugin (C++) and pass node descriptions and extension attributes.

Arguments:
    config {Config} -- The main config object

Here is the call graph for this function:

def rfm2.render.ipr	(		msg,
			args
	)

The main IPR call. This will validate the command based on the message
value and pass the variable argument list to susbsequent functions.

Args:
- msd (Message): The type of event requested by the user.
- *args (tuple): variable argument list.

Returns:
- bool when msg is Message.kIsRunning

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.ipr_destination

(

)

def rfm2.render.ipr_is_running

(

)

Here is the caller graph for this function:

def rfm2.render.m_str

(

val

)

def rfm2.render.preview	(		msg,
			args
	)

The main preview call. This will validate the command based on the
message value and pass the variable argument list to susbsequent functions.

Args:
- msd (Message): The type of event requested by the user.
- *args (tuple): variable argument list.

Returns:
- bool when msg is Message.kIsRunning

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.register_desc_to_plugin

(

desc

)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.register_prefs

(

)

Standard preference registration hook.
Prefs are saved as Maya optionVars and can be read back using :
    rfm2.ui.prefs.get_pref_by_name()
Prefs:
- rfmRenderIprDestination (str): 'Maya Render View' or 'Pixar It'
- rfmRenderIprAOVs (bool): Output OAVs or not during IPR.
- rfmRenderBatchQueue (str): 'Local Queue' or 'Tractor'

def rfm2.render.render_type

(

)

def rfm2.render.render_with_renderman

(

)

Here is the caller graph for this function:

def rfm2.render.rman_cmd

(

val

)

Here is the caller graph for this function:

def rfm2.render.sequence	(		batch = None,
			output = OutputTo.kPrman
	)

def rfm2.render.show_it

(

)

Open It.

NOTE: Windows 7 need 'stdin=subprocess.PIPE' and it doesn't seem to have
any negative side effects on other platforms.

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.show_licenseapp

(

)

Open LicenseApp.

Here is the call graph for this function:

def rfm2.render.show_localqueue

(

)

Open LocalQueue.

Here is the call graph for this function:

def rfm2.render.show_render_destination

(

renderstate

)

Here is the call graph for this function:

Here is the caller graph for this function:

def rfm2.render.show_render_view

(

)

Here is the caller graph for this function:

def rfm2.render.update_ipr_icons

(

)

Called at the end of ipr() to update the shelf and menu.
- We don't update the icon when a viewport render is running.

Here is the caller graph for this function:

Variable Documentation

string rfm2.render.MAYA_VERSION_STR = mc.about(version=True)

list rfm2.render.MSG_STR

Initial value:

= ['kConfig', 'kStart', 'kStop', 'kPause', 'kResume', 'kRefresh',
           'kIsRunning', 'kCropChanged']

tuple rfm2.render.RNDR = RenderState()

int rfm2.render.RT_BATCH = 2

int rfm2.render.RT_IPR = 0

int rfm2.render.RT_PREVIEW = 1