rfm2.utils.versioning Namespace Reference

Functions
def	increment
def	updateSceneVersion
def	register_prefs

Variables
int	P_MANUAL = 0
int	P_ON_PREVIEW = 1
int	P_ON_BATCH = 2
int	RENDER_IPR = 0
int	RENDER_PREVIEW = 1
int	RENDER_BATCH = 2
string	ROLE_VERSION = 'version'
string	ROLE_TAKE = 'take'

Detailed Description

Handle scene versioning in rfm.

Function Documentation

def rfm2.utils.versioning.increment	(		nodeattr,
			role,
			linked_with
	)

Increment a version attribute. If the role is 'version' and linked_with
is a valid attribute name, the linked attribute (usually the take) will be
reset to 1 on each increment.

Args:
- nodeattr (str): the int plug that should be incremented.
- role (str): can either be 'version' or 'take'.
- linked_with (str): The name of the associated 'take' attribute.

Here is the caller graph for this function:

def rfm2.utils.versioning.register_prefs

(

)

Register user preferences in Maya's preference dialog.

def rfm2.utils.versioning.updateSceneVersion

(

render_type

)

Call before a render to update the scene's version/take, based on the
prefs policies. We early out on IPR renders.

Args:
- render_type (int): can be RENDER_IPR, RENDER_PREVIEW or RENDER_BATCH

Here is the call graph for this function:

Variable Documentation

int rfm2.utils.versioning.P_MANUAL = 0

int rfm2.utils.versioning.P_ON_BATCH = 2

int rfm2.utils.versioning.P_ON_PREVIEW = 1

int rfm2.utils.versioning.RENDER_BATCH = 2

int rfm2.utils.versioning.RENDER_IPR = 0

int rfm2.utils.versioning.RENDER_PREVIEW = 1

string rfm2.utils.versioning.ROLE_TAKE = 'take'

string rfm2.utils.versioning.ROLE_VERSION = 'version'