rfm2.rfm_manipulators Namespace Reference

Classes
class	LocalLightManipulator

Functions
def	init_from_desc (cls, desc)
def	create_from_class (cls)
def	make_manip_class (desc)
def	initializePlugin (mobject)
def	uninitializePlugin (mobject)

Variables
	long = int
string	RFM_LOGGER = 'rfm'
bool	vsc_remote_dbg = False
string	host = 'localhost'
int	port = 3000
	address

Detailed Description

This plugin registers light manipulators for rfm2.

Why use a separate plugin ? Because we are using Maya's python API v2 and it
doesn't (as of Maya 2017) have bindings for manipulators (MPxManipContainer and
friends). This plugin uses python API v1, so be careful not to mix in API v2
code...

This plugin is automatically loaded by RenderMan_for_Maya.py and depends on the
availability of the rfm2.config.config data.

Function Documentation

create_from_class()

def rfm2.rfm_manipulators.create_from_class

(

cls

)

Closure to return a fully configured creator() static method.

Returns:
    object: the configured static method.

Here is the caller graph for this function:

init_from_desc()

def rfm2.rfm_manipulators.init_from_desc	(		cls,
			desc
	)

Closure to return a fully configured initialize() static method.

Args:
    desc (RfmNodeDesc): The node description object.

Returns:
    object: the configured static method.

Here is the call graph for this function:

Here is the caller graph for this function:

initializePlugin()

def rfm2.rfm_manipulators.initializePlugin

(

mobject

)

Register our manipulator plugins.

Here is the call graph for this function:

make_manip_class()

def rfm2.rfm_manipulators.make_manip_class

(

desc

)

Dynamically creates a new class (inheriting from LocalLightManipulator) for a
specific node type.
The class gets a bespoke initialize() and creator() static method. Later
on, we will be able to use the same method to add a compute() or VP2
drawing code.

Args:
    desc (RfmNodeDesc): The full node description

Returns:
    object: the new class

Here is the call graph for this function:

Here is the caller graph for this function:

uninitializePlugin()

def rfm2.rfm_manipulators.uninitializePlugin

(

mobject

)

uninitialize the script plug-in

Here is the call graph for this function:

Variable Documentation

address

rfm2.rfm_manipulators.address

host

string rfm2.rfm_manipulators.host = 'localhost'

long

rfm2.rfm_manipulators.long = int

port

int rfm2.rfm_manipulators.port = 3000

RFM_LOGGER

string rfm2.rfm_manipulators.RFM_LOGGER = 'rfm'

vsc_remote_dbg

bool rfm2.rfm_manipulators.vsc_remote_dbg = False