rfm2.render Namespace Reference

Classes
class	OutputTo
class	Message
class	RenderState
class	CameraAction
class	JobidAction

Functions
def	show_it (*args)
def	show_localqueue ()
def	show_licenseapp ()
def	show_render_view ()
def	show_render_destination (renderstate)
def	m_str (val)
def	get_render_arguments ()
def	update_ipr_icons ()
def	close_viewports ()
def	update_viewport_ui (state)
def	ipr (msg, *args)
def	preview (msg, *args)
def	ipr_is_running ()
def	ipr_destination ()
def	render_type ()
def	verify_camera (cam)
def	frame (*args)
def	pre_render_scene_check ()
def	register_prefs ()
def	rman_cmd (val)
def	register_desc_to_plugin (desc)
def	init (config)

Variables
	MAYA_VERSION_STR = str(cfg().maya_version)
list	MSG_STR
int	RT_IPR = 0
int	RT_PREVIEW = 1
int	RT_BATCH = 2
	RNDR = RenderState()

Detailed Description

This module all the render functions.

Function Documentation

close_viewports()

def rfm2.render.close_viewports

(

)

Here is the caller graph for this function:

frame()

def rfm2.render.frame

(

*

args

)

Here is the call graph for this function:

get_render_arguments()

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:

init()

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:

ipr()

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:

ipr_destination()

def rfm2.render.ipr_destination

(

)

ipr_is_running()

def rfm2.render.ipr_is_running

(

)

Here is the caller graph for this function:

m_str()

def rfm2.render.m_str

(

val

)

pre_render_scene_check()

def rfm2.render.pre_render_scene_check

(

)

Warn NCR users if trying to render PxrStylized nodes.
We only warn the first time you try to render a scene.

Here is the call graph for this function:

Here is the caller graph for this function:

preview()

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:

register_desc_to_plugin()

def rfm2.render.register_desc_to_plugin

(

desc

)

Here is the call graph for this function:

Here is the caller graph for this function:

register_prefs()

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()

Here is the call graph for this function:

render_type()

def rfm2.render.render_type

(

)

rman_cmd()

def rfm2.render.rman_cmd

(

val

)

Here is the caller graph for this function:

show_it()

def rfm2.render.show_it

(

*

args

)

Open Image Tool.
   Optional arguments can be provided to the "it" launch which are typically file paths
            of image files {str}.
Arguments:
- args {list}: Arguments to pass to "it"

Here is the call graph for this function:

Here is the caller graph for this function:

show_licenseapp()

def rfm2.render.show_licenseapp

(

)

Open LicenseApp.

Here is the call graph for this function:

show_localqueue()

def rfm2.render.show_localqueue

(

)

Open LocalQueue.

Here is the call graph for this function:

show_render_destination()

def rfm2.render.show_render_destination

(

renderstate

)

Show the user-selected render destination: 'it' or 'maya'.

Here is the call graph for this function:

Here is the caller graph for this function:

show_render_view()

def rfm2.render.show_render_view

(

)

Show Maya's renderView editor

Here is the caller graph for this function:

update_ipr_icons()

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:

update_viewport_ui()

def rfm2.render.update_viewport_ui

(

state

)

Here is the caller graph for this function:

verify_camera()

def rfm2.render.verify_camera

(

cam

)

Make sure the camera exists and that we use the shape.

Here is the caller graph for this function:

Variable Documentation

MAYA_VERSION_STR

rfm2.render.MAYA_VERSION_STR = str(cfg().maya_version)

MSG_STR

list rfm2.render.MSG_STR

Initial value:

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

RNDR

rfm2.render.RNDR = RenderState()

RT_BATCH

int rfm2.render.RT_BATCH = 2

RT_IPR

int rfm2.render.RT_IPR = 0

RT_PREVIEW

int rfm2.render.RT_PREVIEW = 1