Merge branch 'RB-10.3' into main

Author: johnhaddon

Changes

@@ -95,6 +95,22 @@ Breaking Changes
 - IECoreGL : Removed `PerspectiveCamera.h` header. The implementation was already removed in a Cortex 10.1.0.0 (#1241).
 - StringAlgo : Removed `join()` (#1221).
 
+10.3.7.0 (relative to 10.3.6.1)
+========
+
+Improvements
+------------
+
+- IECoreGL :
+  - Buffer : Added `buffer()` method, which returns the OpenGL buffer handle (#1272).
+  - Primitive : Added `getVertexBuffer()` and `getVertexCount()` methods (#1272).
+
+Fixes
+-----
+
+- IECoreUSD :
+  - SceneCacheFileFormat : Added support for `IECore::Object` references when determining primvar type (#1280).
+
 10.3.6.1 (relative to 10.3.6.0)
 ========
 

contrib/IECoreUSD/src/IECoreUSD/SceneCacheData.cpp

@@ -662,7 +662,7 @@ void SceneCacheData::loadPrimVars( const SceneInterface::Path& currentPath, TfTo
 	// variables
 	SceneInterface::Path variablesPath;
 	variablesPath.push_back( g_ioRoot );
-	for ( auto& p : currentPath )
+	for ( const auto& p : currentPath )
 	{
 		// avoid injecting the internal root because
 		// the path would be invalid in the IndexedIO hierarchy
@@ -676,20 +676,21 @@ void SceneCacheData::loadPrimVars( const SceneInterface::Path& currentPath, TfTo
 
 	variablesPath.insert( variablesPath.end(), g_staticIoVariablesPath.begin(), g_staticIoVariablesPath.end() );
 
-	if ( auto variables = m_sceneio->directory( variablesPath, IndexedIO::MissingBehaviour::NullIfMissing ) )
+	if ( const auto variables = m_sceneio->directory( variablesPath, IndexedIO::MissingBehaviour::NullIfMissing ) )
 	{
 		IndexedIO::EntryIDList variableLists;
 		variables->entryIds( variableLists );
-		for( auto& var: variableLists )
+
+		for( const auto& var: variableLists )
 		{
-			auto it = find( g_defaultPrimVars.cbegin(), g_defaultPrimVars.cend(), var.value() );
+			const auto it = find( g_defaultPrimVars.cbegin(), g_defaultPrimVars.cend(), var.value() );
 			if( it != g_defaultPrimVars.cend() )
 			{
 				continue;
 			}
 
 			// interpolation
-			auto variableIO = variables->subdirectory( var, IndexedIO::MissingBehaviour::NullIfMissing );
+			const auto variableIO = variables->subdirectory( var, IndexedIO::MissingBehaviour::NullIfMissing );
 			int interpolationValue = 0;
 			TfToken usdInterpolation;
 			if ( !variableIO || !variableIO->hasEntry( g_ioInterpolation ) )
@@ -702,17 +703,45 @@ void SceneCacheData::loadPrimVars( const SceneInterface::Path& currentPath, TfTo
 			usdInterpolation = PrimitiveAlgo::toUSD( static_cast<PrimitiveVariable::Interpolation>( interpolationValue ) );
 
 			// data type
-			auto dataType = variableIO->subdirectory( g_ioData, IndexedIO::MissingBehaviour::NullIfMissing );
-			std::string dataTypeValue;
-			if( !dataType || !dataType->hasEntry( g_ioType ) )
+			if( !variableIO->hasEntry( g_ioData ) )
+			{
+				IECore::msg( IECore::Msg::Warning, "SceneCacheData::loadPrimVars", boost::format( "Unable to find data for Primitive Variable \"%s\" at location \"%s\"." ) % var % primPath );
+				continue;
+			}
+
+			ConstIndexedIOPtr dataIO;
+			const IndexedIO::Entry dataEntry = variableIO->entry( g_ioData );
+			if( dataEntry.entryType() == IndexedIO::File)
+			{
+				if( dataEntry.dataType() != IndexedIO::InternedStringArray )
+				{
+					IECore::msg( IECore::Msg::Warning, "SceneCacheData::loadPrimVars", boost::format( "Unable to find reference to data for Primitive Variable \"%s\" at location \"%s\"." ) % var % primPath );
+					continue;
+				}
+				// IECore::Object has saved a reference to the data, so we need to follow the link to the referenced
+				// directory in order to find the dataType
+				IndexedIO::EntryIDList referencedPath( dataEntry.arrayLength() );
+				InternedString *p = referencedPath.data();
+				variableIO->read( g_ioData, p, dataEntry.arrayLength() );
+				dataIO = variableIO->directory( referencedPath, IndexedIO::MissingBehaviour::NullIfMissing );
+			}
+			else
+			{
+				// Get the data subdirectory
+				dataIO = variableIO->subdirectory( g_ioData, IndexedIO::MissingBehaviour::NullIfMissing );
+			}
+
+			if( !dataIO || !dataIO->hasEntry( g_ioType ) )
 			{
 				IECore::msg( IECore::Msg::Warning, "SceneCacheData::loadPrimVars", boost::format( "Unable to find data type for Primitive Variable \"%s\" at location \"%s\"." ) % var % primPath );
 				continue;
 			}
-			dataType->read( g_ioType, dataTypeValue );
+
+			std::string dataTypeValue;
+			dataIO->read( g_ioType, dataTypeValue );
 
 			// interpretation
-			auto interpretationData = dataType->subdirectory( g_ioData, IndexedIO::MissingBehaviour::NullIfMissing );
+			const auto interpretationData = dataIO->subdirectory( g_ioData, IndexedIO::MissingBehaviour::NullIfMissing );
 			IntDataPtr interpretationValue = nullptr;
 			if ( interpretationData && interpretationData->hasEntry( g_interpretation ) )
 			{

contrib/IECoreUSD/test/IECoreUSD/SceneCacheFileFormatTest.py

@@ -527,6 +527,9 @@ def testCustomPrimvars( self ):
 		mesh["customPoint"] = IECoreScene.PrimitiveVariable( IECoreScene.PrimitiveVariable.Interpolation.Vertex, v )
 		mesh["customIndexedInt"] = IECoreScene.PrimitiveVariable( IECoreScene.PrimitiveVariable.Interpolation.Uniform, IECore.IntVectorData( [12] ), IECore.IntVectorData( [ 0 ] * vertexSize ) )
 
+		# Test a shallow copy of a primvar which causes IECore.Object to write a reference into the IndexedIO file
+		mesh["Pref"] = mesh["P"]
+
 		box.writeObject( mesh, 1.0 )
 		del m, box
 
@@ -557,6 +560,14 @@ def testCustomPrimvars( self ):
 		customIndexedInt = prim.GetAttribute( "primvars:customIndexedInt" )
 		self.assertEqual( customIndexedInt.GetMetadata( "interpolation" ), pxr.UsdGeom.Tokens.uniform )
 
+		# Pref
+		Pref = prim.GetAttribute( "primvars:Pref" )
+		self.assertIsNotNone( Pref )
+		self.assertFalse( Pref.GetMetadata( "custom" ) )
+		self.assertEqual( Pref.GetMetadata( "typeName" ), pxr.Sdf.ValueTypeNames.Point3fArray )
+		self.assertEqual( Pref.Get( 24.0 ), pxr.UsdGeom.Mesh( prim ).GetPointsAttr().Get( 24.0 ) )
+		self.assertEqual( Pref.GetMetadata( "interpolation" ), pxr.UsdGeom.Tokens.vertex )
+
 		# round trip
 		exportPath = os.path.join( self.temporaryDirectory(), "testUSDExportCustomPrimVar.scc" )
 		stage.Export( exportPath )
@@ -581,6 +592,9 @@ def testCustomPrimvars( self ):
 		# indices
 		self.assertEqual( mesh["customIndexedInt"].indices, IECore.IntVectorData( [0] * vertexSize ) )
 
+		# copy
+		self.assertEqual( mesh["Pref"], mesh["P"] )
+
 	def testCornersAndCreases( self ):
 		fileName = os.path.join( self.temporaryDirectory(), "testUSDCornerAndCreases.scc" )
 		m = IECoreScene.SceneCache( fileName, IECore.IndexedIO.OpenMode.Write )

include/IECoreGL/Buffer.h

@@ -62,6 +62,12 @@ class IECOREGL_API Buffer : public IECore::RunTimeTyped
 		/// Deletes the buffer with glDeleteBuffers().
 		~Buffer() override;
 
+		/// Returns the GL handle for the buffer. Note that this is
+		/// owned by the Buffer class and will be destroyed in the
+		/// destructor - you must therefore not call glDeleteBuffers()
+		/// yourself.
+		GLuint buffer() const;
+
 		/// Returns the size of the buffer in bytes.
 		size_t size() const;
 

include/IECoreGL/Primitive.h

@@ -37,6 +37,7 @@
 
 #include "IECoreGL/Export.h"
 #include "IECoreGL/GL.h"
+#include "IECoreGL/Buffer.h"
 #include "IECoreGL/Renderable.h"
 #include "IECoreGL/Shader.h"
 #include "IECoreGL/TypedStateComponent.h"
@@ -165,6 +166,12 @@ class IECOREGL_API Primitive : public Renderable
 		IE_CORE_DECLAREPTR( TransparencySort );
 		//@}
 
+		/// Call to retrieve the buffer for a previously registered vertex attribute.
+		ConstBufferPtr getVertexBuffer( const std::string &name ) const;
+
+		/// Call to determine the number of vertices in each registered vertex attribute.
+		size_t getVertexCount() const;
+
 	protected :
 
 		/// Called by derived classes to register a uniform attribute. There are no type or length checks on this call.

src/IECoreGL/Buffer.cpp

@@ -94,6 +94,11 @@ Buffer::~Buffer()
 	glDeleteBuffers( 1, &m_buffer );
 }
 
+GLuint Buffer::buffer() const
+{
+	return m_buffer;
+}
+
 size_t Buffer::size() const
 {
 	ScopedBinding binding( *this, GL_ARRAY_BUFFER );

src/IECoreGL/Primitive.cpp

@@ -153,6 +153,8 @@ const Shader::Setup *flatConstantShaderSetup( State *state, bool forIDRender )
 	return shaderSetup.get();
 }
 
+const std::string g_P( "P" );
+
 } // namespace
 
 //////////////////////////////////////////////////////////////////////////
@@ -380,6 +382,28 @@ void Primitive::addVertexAttribute( const std::string &name, IECore::ConstDataPt
 	m_vertexAttributes[name] = data->copy();
 }
 
+ConstBufferPtr Primitive::getVertexBuffer( const std::string &name ) const
+{
+	const AttributeMap::const_iterator it = m_vertexAttributes.find( name );
+	return ( it != m_vertexAttributes.end() )
+		? IECore::runTimeCast< const Buffer >( CachedConverter::defaultCachedConverter()->convert( it->second.get() ) )
+		: ConstBufferPtr();
+}
+
+size_t Primitive::getVertexCount() const
+{
+	// NOTE : It would perhaps be better if the vertex count was stored as a member variable, then we could
+	//        check the size of each registered vertex attribute as it is added. Derived classes would need
+	//        to set this value perhaps as an argument to the constructor. However that would break ABI so for
+	//        now determine the vertex count by inspecting the size of the "P" attribute which ALL primitives
+	//        should have registered.
+
+	const AttributeMap::const_iterator it = m_vertexAttributes.find( g_P );
+	return ( ( it != m_vertexAttributes.end() ) && ( IECore::runTimeCast< const IECore::V3fVectorData >( it->second ) ) )
+		? static_cast< size_t >( IECore::assertedStaticCast< const IECore::V3fVectorData >( it->second )->readable().size() )
+		: static_cast< size_t >( 0 );
+}
+
 bool Primitive::depthSortRequested( const State * state ) const
 {
 	return state->get<Primitive::TransparencySort>()->value() &&