Merge pull request #272 from davidsminor/mayaSceneVisibility

Maya scene visibility

Author: andrewkaufman

src/IECoreMaya/MayaScene.cpp

@@ -10,9 +10,12 @@
 #include "IECoreMaya/FromMayaDagNodeConverter.h"
 #include "IECoreMaya/FromMayaCameraConverter.h"
 #include "IECoreMaya/Convert.h"
+#include "IECoreMaya/SceneShape.h"
 
 #include "maya/MFnDagNode.h"
 #include "maya/MFnTransform.h"
+#include "maya/MPxTransform.h"
+#include "maya/MPxSurfaceShape.h"
 #include "maya/MFnCamera.h"
 #include "maya/MFnMatrixData.h"
 #include "maya/MFnNumericData.h"
@@ -212,6 +215,12 @@ bool MayaScene::hasAttribute( const Name &name ) const
 	{
 		throw Exception( "MayaScene::hasAttribute: Dag path no longer exists!" );
 	}
+	
+	if( name == SceneInterface::visibilityName )
+	{
+		return true;
+	}
+	
 	std::vector< CustomAttributeReader > &attributeReaders = customAttributeReaders();
 	for ( std::vector< CustomAttributeReader >::const_iterator it = attributeReaders.begin(); it != attributeReaders.end(); ++it )
 	{
@@ -238,6 +247,7 @@ void MayaScene::attributeNames( NameList &attrs ) const
 	}
 
 	attrs.clear();
+	attrs.push_back( SceneInterface::visibilityName );
 	for ( std::vector< CustomAttributeReader >::const_iterator it = customAttributeReaders().begin(); it != customAttributeReaders().end(); it++ )
 	{
 		it->m_names( m_dagPath, attrs );
@@ -250,11 +260,81 @@ ConstObjectPtr MayaScene::readAttribute( const Name &name, double time ) const
 	{
 		return 0;
 	}
-
+	
 	if( m_dagPath.length() == 0 )
 	{
 		throw Exception( "MayaScene::readAttribute: Dag path no longer exists!" );
 	}
+	
+	tbb::mutex::scoped_lock l( s_mutex );
+	if( name == SceneInterface::visibilityName )
+	{
+		bool visible = true;
+		
+		MStatus st;
+		MFnDagNode dagFn( m_dagPath );
+		MPlug visibilityPlug = dagFn.findPlug( MPxTransform::visibility, &st );
+		if( st )
+		{
+			visible = visibilityPlug.asBool();
+		}
+		
+		if( visible )
+		{
+			MDagPath childDag;
+			
+			// find an object that's either a SceneShape, or has a cortex converter and check its visibility:
+			unsigned int childCount = 0;
+			m_dagPath.numberOfShapesDirectlyBelow(childCount);
+			
+			for ( unsigned int c = 0; c < childCount; c++ )
+			{
+				MDagPath d = m_dagPath;
+				if( d.extendToShapeDirectlyBelow( c ) )
+				{
+					MFnDagNode fnChildDag(d);
+					if( fnChildDag.typeId() == SceneShape::id )
+					{
+						childDag = d;
+						break;
+					}
+					
+					if ( fnChildDag.isIntermediateObject() )
+					{
+						continue;
+					}
+					
+					FromMayaShapeConverterPtr shapeConverter = FromMayaShapeConverter::create( d );
+					if( shapeConverter )
+					{
+						childDag = d;
+						break;
+					}
+
+					FromMayaDagNodeConverterPtr dagConverter = FromMayaDagNodeConverter::create( d );
+					if( dagConverter )
+					{
+						childDag = d;
+						break;
+					}
+				}
+			}
+			
+			if( childDag.isValid() )
+			{
+				MFnDagNode dagFn( childDag );
+				MPlug visibilityPlug = dagFn.findPlug( MPxSurfaceShape::visibility, &st );
+				if( st )
+				{
+					visible = visibilityPlug.asBool();
+				}
+			}
+			
+		}
+		
+		return new BoolData( visible );
+	}
+	
 	std::vector< CustomAttributeReader > &attributeReaders = customAttributeReaders();
 	for ( std::vector< CustomAttributeReader >::const_iterator it = attributeReaders.begin(); it != attributeReaders.end(); ++it )
 	{

src/IECoreMaya/SceneShape.cpp

@@ -279,18 +279,21 @@ void SceneShape::sceneShapeAttributeNames( const MDagPath &p, SceneInterface::Na
 		return;
 	}
 
+	SceneInterface::NameList sceneAttrNames;
 	ConstSceneInterfacePtr scene = sceneShape->getSceneInterface();
 	if ( !scene )
 	{
 		return;
 	}
-	scene->attributeNames( attributeNames );
+	scene->attributeNames( sceneAttrNames );
+	attributeNames.insert( attributeNames.end(), sceneAttrNames.begin(), sceneAttrNames.end() );
 
 	MFnDagNode fnChildDag( dagPath );
 	if( !fnChildDag.isIntermediateObject() && hasSceneShapeLink( p ) )
 	{
 		attributeNames.push_back( LinkedScene::linkAttribute );
 	}
+	
 }
 
 ConstObjectPtr SceneShape::readSceneShapeAttribute( const MDagPath &p, SceneInterface::Name attributeName )

test/IECoreMaya/MayaSceneTest.py

@@ -595,7 +595,7 @@ def testCustomTags( self ) :
 		doTest = True
 
 		def hasMyTags( node, tag, tagFilter ) :
-			"""'archivable' should be on all transforms and 'renderable' only at shape transforms."""			
+			#'archivable' should be on all transforms and 'renderable' only at shape transforms.
 
 			if not doTest:
 				return False
@@ -621,7 +621,7 @@ def hasMyTags( node, tag, tagFilter ) :
 			return dagPath.fullPathName().endswith("Shape")
 
 		def readMyTags( node, tagFilter ) :
-			"""'archivable' should be on all transforms and 'renderable' only at shape transforms."""			
+			#'archivable' should be on all transforms and 'renderable' only at shape transforms.
 
 			if not doTest:
 				return []
@@ -712,17 +712,86 @@ def readMyAttribute( node, attr ) :
 		sphereScene = scene.child('pSphere')
 		self.assertEqual( scene.attributeNames(), [] )
 		self.assertEqual( scene.readAttribute("anyAttr", 0.0), None )
-		self.assertEqual( transformScene.attributeNames(), [ IECore.InternedString("transformAttribute") ] )
+		self.assertEqual( transformScene.attributeNames(), [ IECore.InternedString("scene:visible"), IECore.InternedString("transformAttribute") ] )
 		self.assertEqual( transformScene.hasAttribute("shapeAttribute"), False )
 		self.assertEqual( transformScene.readAttribute("shapeAttribute", 0.0), None )
 		self.assertEqual( transformScene.readAttribute( "transformAttribute", 0.0), IECore.FloatData(5) )
-		self.assertEqual( sphereScene.attributeNames(), [ IECore.InternedString('shapeAttribute') ] )
+		self.assertEqual( sphereScene.attributeNames(), [ IECore.InternedString("scene:visible"), IECore.InternedString('shapeAttribute') ] )
 		self.assertEqual( sphereScene.readAttribute( "shapeAttribute", 0.0), IECore.StringData("mesh") )
 
 		# Disable custom attribute functions so they don't mess with other tests
 		doTest = False
+	
+	def testSceneVisible( self ) :
+		
+		maya.cmds.createNode( "transform", name = "t1" )
+		maya.cmds.createNode( "transform", name = "t2" )
+		
+		scene = IECoreMaya.MayaScene()
+		t1 = scene.child( "t1" )
+		t2 = scene.child( "t2" )
+		
+		self.assertEqual( t1.attributeNames(), ["scene:visible"] )
+		self.assertEqual( t2.attributeNames(), ["scene:visible"] )
+		
+		self.assertEqual( t1.hasAttribute( "scene:visible" ), True )
+		self.assertEqual( t2.hasAttribute( "scene:visible" ), True )
+		
+		self.assertEqual( t1.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
+		self.assertEqual( t2.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
+		
+		# test visibility on transform:
+		maya.cmds.setAttr( "t1.visibility", False )
+		
+		self.assertEqual( t1.readAttribute( "scene:visible", 0 ), IECore.BoolData( False ) )
+		self.assertEqual( t2.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
+		
+		maya.cmds.setAttr( "t1.visibility", True )
+		
+		# test visibility on shape. Add a mesh to the two transforms, along with an image plane to confuse it:
+		maya.cmds.createNode( "mesh", name = "m1", parent="t1" )
+		maya.cmds.createNode( "imagePlane", name = "i1", parent="t1" )
+		
+		maya.cmds.createNode( "imagePlane", name = "i2", parent="t2" )
+		maya.cmds.createNode( "mesh", name = "m2", parent="t2" )
+		
+		maya.cmds.setAttr( "i1.visibility", False )
+		maya.cmds.setAttr( "i2.visibility", False )
+		
+		# these should both be visible, as cortex ignores image planes and the meshes are visible:
+		self.assertEqual( t1.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
+		self.assertEqual( t2.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
+	
+		maya.cmds.setAttr( "m1.visibility", False )
+		maya.cmds.setAttr( "m2.visibility", False )
+		
+		# should both be invisible now, as we've hidden the meshes:
+		self.assertEqual( t1.readAttribute( "scene:visible", 0 ), IECore.BoolData( False ) )
+		self.assertEqual( t2.readAttribute( "scene:visible", 0 ), IECore.BoolData( False ) )
+		
+	def testSceneShapeVisible( self ) :
+		
+		# make sure we are at time 0
+		maya.cmds.currentTime( "0sec" )
+		scene = IECoreMaya.MayaScene()
+
+		envShape = str( IECoreMaya.FnSceneShape.create( "ieScene1" ).fullPathName() )
+		envNode = 'ieScene1'
+
+		envScene = scene.child( envNode )
+		self.failUnless( IECore.InternedString( "scene:visible" ) in envScene.attributeNames() )
+		
+		maya.cmds.setAttr( envShape+'.file', 'test/IECore/data/sccFiles/animatedSpheres.scc',type='string' )
+		self.failUnless( IECore.InternedString( "scene:visible" ) in envScene.attributeNames() )
 
+		maya.cmds.setAttr( "ieScene1.visibility", False )
+		self.assertEqual( envScene.readAttribute( "scene:visible", 0 ), IECore.BoolData( False ) )
 
+		maya.cmds.setAttr( "ieScene1.visibility", True )
+		self.assertEqual( envScene.readAttribute( "scene:visible", 0 ), IECore.BoolData( True ) )
 
+		maya.cmds.setAttr( envShape + ".visibility", False )
+		self.assertEqual( envScene.readAttribute( "scene:visible", 0 ), IECore.BoolData( False ) )
+	
 if __name__ == "__main__":
 	IECoreMaya.TestProgram( plugins = [ "ieCore" ] )