Merge pull request #1367 from yannci/sceneShapeTimePlugTraversal

SceneShape: Fix reading of time samples for expanded link locations

Author: ivanimanishi

Changes

@@ -1,6 +1,11 @@
 10.4.x.x (relative to 10.4.9.1)
 ========
 
+Fixes
+---
+
+- IECoreMaya.SceneShape : Fixed reading of time samples for expanded link locations
+  - Traverse the time plug connections to check for a maya global time connection
 
 10.4.9.1 (relative to 10.4.9.0)
 ========

src/IECoreMaya/SceneShape.cpp

@@ -45,11 +45,18 @@
 #include "maya/MFnDagNode.h"
 #include "maya/MTime.h"
 #include "maya/MEvaluationNode.h"
+#include "maya/MItDependencyGraph.h"
+
 
 using namespace IECore;
 using namespace IECoreScene;
 using namespace IECoreMaya;
 
+namespace
+{
+const MString g_mayaGlobalTimeNodeName( "time1" );
+}
+
 MTypeId SceneShape::id = SceneShapeId;
 MObject SceneShape::aSceneFilePlug;
 MObject SceneShape::aSceneRootPlug;
@@ -256,7 +263,7 @@ ConstObjectPtr SceneShape::readSceneShapeLink( const MDagPath &p )
 	SceneShape *sceneShape = findScene( p, true, &dagPath );
 	if ( !sceneShape )
 	{
-		throw Exception("readSceneShapeLink: Could not find SceneShape!");
+		throw Exception( "readSceneShapeLink: Could not find SceneShape!" );
 	}
 
 	const SceneInterface *scene = sceneShape->getSceneInterface().get();
@@ -270,26 +277,36 @@ ConstObjectPtr SceneShape::readSceneShapeLink( const MDagPath &p )
 	MPlug timePlug = fnChildDag.findPlug( aTime, false, &st );
 	if( !st )
 	{
-		throw Exception( "Could not find 'time' plug in SceneShape!");
+		throw Exception( "Could not find 'time' plug in SceneShape!" );
 	}
 
-	// if time plug is connected to maya global time, then we assume there's no time remapping between the Maya scene and the loaded scene.
-	MPlugArray array;
-	timePlug.connectedTo( array, true, false, &st );
-	if( !st )
+	MItDependencyGraph it = MItDependencyGraph( timePlug, MFn::kInvalid, MItDependencyGraph::kUpstream, MItDependencyGraph::kDepthFirst, MItDependencyGraph::kPlugLevel );
+	for ( ; !it.isDone() ; it.next() )
 	{
-		throw Exception( "Could not find 'time' plug connections in SceneShape!");
-	}
+		MPlug currPlug = it.thisPlug( &st );
+		CHECK_MSTATUS(st);
+		MFnDependencyNode nodeFn( currPlug.node(), &st );
+		CHECK_MSTATUS(st);
 
-	for ( unsigned int i = 0; i < array.length(); i++ )
-	{
-		if ( array[i].name() == "time1.outTime" )
+		if ( nodeFn.name() == g_mayaGlobalTimeNodeName )
 		{
-			/// connected to time, so no time remapping between maya scene and loaded scene.
+			/// The plug is connected to maya global time, so no time remapping is happening
 			return LinkedScene::linkAttributeData( scene );
 		}
+
+		unsigned int nodeId = nodeFn.typeId().id();
+		bool isSceneShape = nodeId == SceneShapeId || nodeId == SceneShapeProxyId;
+		if ( !isSceneShape )
+		{
+			/// The time plug is not connected to global maya time or a scene shape (expanded hierarchy),
+			/// so we assume some kind of time manipulation (a maya add node to offset the value or similiar)
+			MTime time;
+			timePlug.getValue( time );
+			return LinkedScene::linkAttributeData( scene, time.as( MTime::kSeconds ) );
+		}
 	}
-	/// couldn't find connection to maya time, so this node is mapping the time some other way.
+
+	/// The time plug doesn't have any connection at all (time hold)
 	MTime time;
 	timePlug.getValue( time );
 	return LinkedScene::linkAttributeData( scene, time.as( MTime::kSeconds ) );

test/IECoreMaya/LiveSceneTest.py

@@ -556,9 +556,7 @@ def testSceneShapeCustomReaders( self ):
 		self.assertFalse( spheresScene.hasAttribute( IECoreScene.LinkedScene.linkAttribute ) )
 		leafScene = spheresScene.child("A").child("a")
 		self.assertTrue( leafScene.hasAttribute( IECoreScene.LinkedScene.linkAttribute ) )
-		# When expanding, we connect the child time attributes to their scene shape parent time attribute to propagate time remapping. When checking for time remapping, the scene shape
-		# currently only checks the direct connection, so we have here time in the link attributes. Will have to look out for performance issues.
-		self.assertEqual( leafScene.readAttribute( IECoreScene.LinkedScene.linkAttribute, 0 ), IECore.CompoundData( { "fileName":IECore.StringData('test/IECore/data/sccFiles/animatedSpheres.scc'), "root":IECore.InternedStringVectorData([ 'A', 'a' ]), 'time':IECore.DoubleData( 0 ) } ) )
+		self.assertEqual( leafScene.readAttribute( IECoreScene.LinkedScene.linkAttribute, 0 ), IECore.CompoundData( { "fileName":IECore.StringData('test/IECore/data/sccFiles/animatedSpheres.scc'), "root":IECore.InternedStringVectorData([ 'A', 'a' ]) } ) )
 		self.assertFalse( leafScene.hasObject() )
 
 		# expand scene to meshes

test/IECoreMaya/SceneShapeProxyTest.py

@@ -42,7 +42,8 @@ class SceneShapeProxyTest( SceneShapeTest.SceneShapeTest ):
 
 	def setUp( self ):
 		IECoreMaya.TestCase.setUp(self)
-		self._node = maya.cmds.createNode( "ieSceneShapeProxy" )
+		self._shapeType = "ieSceneShapeProxy"
+		self._node = maya.cmds.createNode( self._shapeType )
 
 if __name__ == "__main__":
 	IECoreMaya.TestProgram( plugins = [ "ieCore" ] )

test/IECoreMaya/SceneShapeTest.py

@@ -47,10 +47,12 @@ class SceneShapeTest( IECoreMaya.TestCase ) :
 	__testPlugFile = "test/testPlug.scc"
 	__testPlugAnimFile = "test/testPlugAnim.scc"
 	__testPlugAttrFile = "test/testPlugAttr.scc"
+	__testLinkFile = "test/test.lscc"
 
 	def setUp( self ):
 		super( SceneShapeTest, self ).setUp()
-		self._node = maya.cmds.createNode( "ieSceneShape" )
+		self._shapeType = "ieSceneShape"
+		self._node = maya.cmds.createNode( self._shapeType )
 
 	def writeSCC( self, file, rotation=imath.V3d( 0, 0, 0 ), time=0 ) :
 
@@ -550,10 +552,113 @@ def testLinkedLiveSceneTags( self ) :
 		self.assertEqual( sorted([ str(x) for x in child2.readTags() ]), ["ObjectType:MeshPrimitive","b"] )
 		self.assertEqual( sorted([ str(x) for x in child3.readTags() ]), ["ObjectType:MeshPrimitive","c"] )
 
+	def testReadSceneShapeLink( self ):
+
+		# Create an .lscc with three child locations that we will time remap once we have read it back into maya
+		self.writeAnimSCC( SceneShapeTest.__testFile )
+
+		sceneCache = IECoreScene.SceneCache( SceneShapeTest.__testFile, IECore.IndexedIO.OpenMode.Read )
+		linkedScene = IECoreScene.LinkedScene( SceneShapeTest.__testLinkFile, IECore.IndexedIO.OpenMode.Write  )
+
+		noRemapLocation = linkedScene.createChild( "NoRemap" )
+		noRemapLocation.writeLink( sceneCache )
+		remapLocation = linkedScene.createChild( "Remap" )
+		remapLocation.writeLink( sceneCache )
+		holdLocation = linkedScene.createChild( "Hold" )
+		holdLocation.writeLink( sceneCache )
+
+		del noRemapLocation, remapLocation, holdLocation
+		del linkedScene
+
+		# Create a root level scene shape node to read in the .lscc
+		rootFn = IECoreMaya.FnSceneShape.create( "Root", shapeType=self._shapeType )
+		maya.cmds.setAttr( rootFn.name() + ".file", SceneShapeTest.__testLinkFile, type="string" )
+		maya.cmds.setAttr( rootFn.name() + ".root", "/", type="string" )
+
+		holdFn, noRemapFn, remapFn = rootFn.expandOnce()
+
+		# check that we don't have any other value than global maya time
+		mayaTime = maya.cmds.currentTime( query=True )
+		self.assertEqual( maya.cmds.getAttr( holdFn.name() + ".time" ), mayaTime )
+		self.assertEqual( maya.cmds.getAttr( noRemapFn.name() + ".time" ), mayaTime )
+		self.assertEqual( maya.cmds.getAttr( remapFn.name() + ".time" ), mayaTime )
+
+		# break the time connection to create a time hold
+		maya.cmds.disconnectAttr( rootFn.name() + ".outTime", holdFn.name() + ".time" )
+		maya.cmds.setAttr( holdFn.name() + ".time", 5.0 )
+		self.assertEqual( maya.cmds.getAttr( holdFn.name() + ".time" ), 5.0 )
+
+		# add an offset to create a time remapping
+		addNode = maya.cmds.createNode( "addDoubleLinear" )
+		maya.cmds.connectAttr( "time1.outTime", addNode + ".input1" )
+		maya.cmds.setAttr( addNode + ".input2", 10.0 )
+		maya.cmds.connectAttr( addNode + ".output", remapFn.name() + ".time", force=True )
+		self.assertEqual( maya.cmds.getAttr( remapFn.name() + ".time" ), 11.0 )
+
+		# set up the LiveScenes for actual testing
+		holdFn.expandAll()
+		holdLiveScene = IECoreMaya.LiveScene()
+		holdLocation = holdLiveScene.child( "|Root|Hold" )
+		holdChild1 = holdLocation.child( holdLocation.childNames()[0] )
+		holdChild2 = holdChild1.child( holdChild1.childNames()[0] )
+		holdChild3 = holdChild2.child( holdChild2.childNames()[0] )
+		holdLocations = [holdLocation, holdChild1, holdChild2, holdChild3]
+
+		noRemapFn.expandAll()
+		noRemapLiveScene = IECoreMaya.LiveScene()
+		noRemapLocation = noRemapLiveScene.child( "|Root|NoRemap" )
+		noRemapChild1 = noRemapLocation.child( noRemapLocation.childNames()[0] )
+		noRemapChild2 = noRemapChild1.child( noRemapChild1.childNames()[0] )
+		noRemapChild3 = noRemapChild2.child( noRemapChild2.childNames()[0] )
+		noRemapLocations = [noRemapLocation, noRemapChild1, noRemapChild2, noRemapChild3]
+
+		remapFn.expandAll()
+		remapLiveScene = IECoreMaya.LiveScene()
+		remapLocation = remapLiveScene.child( "|Root|Remap" )
+		remapChild1 = remapLocation.child( remapLocation.childNames()[0] )
+		remapChild2 = remapChild1.child( remapChild1.childNames()[0] )
+		remapChild3 = remapChild2.child( remapChild2.childNames()[0] )
+		remapLocations = [remapLocation, remapChild1, remapChild2, remapChild3]
+
+		# set up some constants used during testing
+		FPS = 24
+		TIME_HOLD = 5.0
+		TIME_OFFSET = 10.0
+
+		for time in [1.0, 5.0, 10.0, 50.0, 100.0]:
+
+			maya.cmds.currentTime( time, edit=True )
+			mayaTime = maya.cmds.currentTime( query=True )
+			# check that we actually moved in time
+			self.assertEqual( mayaTime, time )
+
+			# test no time remap
+			for location in noRemapLocations:
+				nodeTime = maya.cmds.getAttr( str(location.dagPath()) + ".outTime" )
+				linkAttr = location.readAttribute( IECoreScene.LinkedScene.linkAttribute, mayaTime )
+				self.assertFalse( linkAttr.has_key( "time" ) )
+				self.assertEqual( nodeTime, mayaTime )
+
+			# test time remap
+			for location in remapLocations:
+				linkAttr = location.readAttribute( IECoreScene.LinkedScene.linkAttribute, mayaTime )
+				self.assertTrue( linkAttr.has_key( "time" ) )
+				self.assertEqual( linkAttr["time"].value * FPS, mayaTime + TIME_OFFSET )
+
+			# test time hold
+			for location in holdLocations:
+				linkAttr = location.readAttribute( IECoreScene.LinkedScene.linkAttribute, mayaTime )
+				self.assertTrue( linkAttr.has_key( "time" ) )
+				self.assertEqual( linkAttr["time"].value * FPS, TIME_HOLD )
+
 
 	def tearDown( self ) :
 
-		for f in [ SceneShapeTest.__testFile, SceneShapeTest.__testPlugFile, SceneShapeTest.__testPlugAnimFile, SceneShapeTest.__testPlugAttrFile ] :
+		for f in [
+			SceneShapeTest.__testFile, SceneShapeTest.__testPlugFile,
+			SceneShapeTest.__testPlugAnimFile, SceneShapeTest.__testPlugAttrFile,
+			SceneShapeTest.__testLinkFile
+		]:
 			if os.path.exists( f ) :
 				os.remove( f )