rfm2.rfm_manipulators.LocalLightManipulator Class Reference

Inheritance diagram for rfm2.rfm_manipulators.LocalLightManipulator:

Collaboration diagram for rfm2.rfm_manipulators.LocalLightManipulator:

Public Member Functions
def	__init__ (self)
def	createChildren (self)
def	connectToDependNode (self, node)
def	plugToManipConversion (self, manipIndex)
def	manipToPlugConversion (self, plugIndex)

Public Attributes
	positionManip
	directionManip
	nodePath
	transformPath
	startPointIndex
	endPointIndex
	directionIndex
	rotatePlug
	centerOfIllumPlug
	initialEndPointSet
	rotateConvIdx

Static Public Attributes
	typeName = None
	nodeId = None
	desc = None

Detailed Description

Implement a standard Position + Aim manipulator for local lights. It
consists of a freePointTriadManip and a directionManip.

Constructor & Destructor Documentation

__init__()

def rfm2.rfm_manipulators.LocalLightManipulator.__init__

(

self

)

Member Function Documentation

connectToDependNode()

def rfm2.rfm_manipulators.LocalLightManipulator.connectToDependNode	(		self,
			node
	)

Connect this manipulator to a scene node.
- The position manip is directly connected to the 'translate' attribute
  of the node's transform.
- The direction manip is indirectly connected via conversion methods
  because they require additional computations:
  - Connect to the 'rotate' plug of the node's transform.
  - Connect to the 'centerOfIllumination' plug of the node. Note that
    the 'centerOfIllumination' plug is automatically added to RenderMan
    light nodes in rfm2.maya_node.initStandardLightAttributes().

Here is the call graph for this function:

createChildren()

def rfm2.rfm_manipulators.LocalLightManipulator.createChildren

(

self

)

Create children manipulators: a freePointTriadManip and a
directionManip. We store the manip pointers for later retrieval.

manipToPlugConversion()

def rfm2.rfm_manipulators.LocalLightManipulator.manipToPlugConversion	(		self,
			plugIndex
	)

Calculates and returns the requested plug value, based upon the
container's manipulator values. Again, we have 2 cases:
- update the transform's 'rotate' plug based on the direction manip.
- update the nodes 'centerOfIllumination' plug based on the direction
  manip.

Here is the call graph for this function:

plugToManipConversion()

def rfm2.rfm_manipulators.LocalLightManipulator.plugToManipConversion	(		self,
			manipIndex
	)

Calculates and returns the requested manipulator value, based upon
the values of plugs on the nodes being manipulated. Here we have 2
cases:
- Update the start point position
- Update the end point position

Here is the call graph for this function:

Member Data Documentation

centerOfIllumPlug

rfm2.rfm_manipulators.LocalLightManipulator.centerOfIllumPlug

desc

rfm2.rfm_manipulators.LocalLightManipulator.desc = None

static

directionIndex

rfm2.rfm_manipulators.LocalLightManipulator.directionIndex

directionManip

rfm2.rfm_manipulators.LocalLightManipulator.directionManip

endPointIndex

rfm2.rfm_manipulators.LocalLightManipulator.endPointIndex

initialEndPointSet

rfm2.rfm_manipulators.LocalLightManipulator.initialEndPointSet

nodeId

rfm2.rfm_manipulators.LocalLightManipulator.nodeId = None

static

nodePath

rfm2.rfm_manipulators.LocalLightManipulator.nodePath

positionManip

rfm2.rfm_manipulators.LocalLightManipulator.positionManip

rotateConvIdx

rfm2.rfm_manipulators.LocalLightManipulator.rotateConvIdx

rotatePlug

rfm2.rfm_manipulators.LocalLightManipulator.rotatePlug

startPointIndex

rfm2.rfm_manipulators.LocalLightManipulator.startPointIndex

transformPath

rfm2.rfm_manipulators.LocalLightManipulator.transformPath

typeName

rfm2.rfm_manipulators.LocalLightManipulator.typeName = None

static

---

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

• /Users/plp/Perforce/plp_thebridge_rman_24_dev/rat/apps/rfm/scripts/rfm2/rfm_manipulators.py