Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RendererAlgo : Default render:includedPurposes to default, render #5521

Merged
merged 1 commit into from
Nov 17, 2023
+14 −13
Merged

RendererAlgo : Default render:includedPurposes to default, render #5521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Improvements
Breaking Changes
----------------

- Render : Changed `render:includedPurposes` default to `"default", "render"`.
- ValuePlug : Removed deprecated `getObjectValue()` overload.
- Dispatcher : Removed `createMatching()` method.
- Process : Removed non-const variant of the `handleException()` method.
Expand Down
18 changes: 10 additions & 8 deletions python/GafferSceneTest/RenderControllerTest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1535,36 +1535,37 @@ def testIncludedPurposes( self ) :

self.assertIsNotNone( renderer.capturedObject( "/group/sphere" ) )

# Should still be visible when we add a purpose attribute, because we haven't
# specified the `render:includedPurposes` option.
# Should still be visible when we add a purpose of `render`, because that's included
# in the default for `render:includedPurposes`.

sphereAttributes["attributes"].addChild( Gaffer.NameValuePlug( "usd:purpose", "proxy", defaultEnabled = True ) )
sphereAttributes["attributes"].addChild( Gaffer.NameValuePlug( "usd:purpose", "render", defaultEnabled = True ) )
self.assertTrue( controller.updateRequired() )
controller.update()
self.assertIsNotNone( renderer.capturedObject( "/group/sphere" ) )

# But should be hidden when we add `render:includedPurposes` to exclude it.

standardOptions["options"]["includedPurposes"]["enabled"].setValue( True )
standardOptions["options"]["includedPurposes"]["value"].setValue( IECore.StringVectorData( [ "default", "proxy" ] ) )
self.assertEqual(
standardOptions["options"]["includedPurposes"]["value"].getValue(),
IECore.StringVectorData( [ "default", "render" ] ),
IECore.StringVectorData( [ "default", "proxy" ] ),
)
self.assertTrue( controller.updateRequired() )
controller.update()
self.assertIsNone( renderer.capturedObject( "/group/sphere" ) )

# Should be shown again if we change purpose to one that is included.

sphereAttributes["attributes"][0]["value"].setValue( "render" )
sphereAttributes["attributes"][0]["value"].setValue( "proxy" )
self.assertTrue( controller.updateRequired() )
controller.update()
self.assertIsNotNone( renderer.capturedObject( "/group/sphere" ) )

# Shouldn't matter if parent has a purpose which is excluded, because local
# purpose will override that.

groupAttributes["attributes"].addChild( Gaffer.NameValuePlug( "usd:purpose", "proxy", defaultEnabled = True ) )
groupAttributes["attributes"].addChild( Gaffer.NameValuePlug( "usd:purpose", "render", defaultEnabled = True ) )
self.assertTrue( controller.updateRequired() )
controller.update()
self.assertIsNotNone( renderer.capturedObject( "/group/sphere" ) )
Expand All @@ -1577,7 +1578,8 @@ def testIncludedPurposes( self ) :
controller.update()
self.assertIsNone( renderer.capturedObject( "/group/sphere" ) )

# Reverting to no `includedPurposes` option should revert to showing everything.
# Reverting to no `includedPurposes` option should revert to showing
# just `default` and `render`.

standardOptions["options"]["includedPurposes"]["enabled"].setValue( False )
self.assertTrue( controller.updateRequired() )
Expand Down Expand Up @@ -1640,7 +1642,7 @@ def assertExpectedRenderOptions() :
# get another update.

del capture
standardOptions["options"]["includedPurposes"]["value"].setValue( IECore.StringVectorData( [ "default", "render", "proxy", "guide" ] ) )
standardOptions["options"]["includedPurposes"]["value"].setToDefault()
self.assertTrue( controller.updateRequired() )
controller.update()
assertExpectedRenderOptions()
Expand Down
4 changes: 2 additions & 2 deletions python/GafferSceneTest/RendererAlgoTest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,14 +672,14 @@ def assertIncludedObjects( scene, includedPurposes, paths ) :
else :
self.assertIsNone( renderer.capturedObject( path ) )

# If we don't specify a purpose, then we should get everything.
# If we don't specify a purpose, then we should get just "default"
# and "render".

assertIncludedObjects(
group["out"], None,
{
"/group/innerGroup1/cube",
"/group/innerGroup1/sphere",
"/group/innerGroup2/cube",
"/group/innerGroup2/sphere",
}
)
Expand Down
4 changes: 1 addition & 3 deletions src/GafferScene/RendererAlgo.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,7 @@ const InternedString g_shutterOptionName( "option:render:shutter" );
const InternedString g_includedPurposesOptionName( "option:render:includedPurposes" );
const InternedString g_purposeAttributeName( "usd:purpose" );

/// \todo We should really default to `{ "default", "render" }`, but can only
/// change that on a major version update.
const ConstStringVectorDataPtr g_defaultIncludedPurposes( new StringVectorData( { "default", "render", "proxy", "guide" } ) );
const ConstStringVectorDataPtr g_defaultIncludedPurposes( new StringVectorData( { "default", "render" } ) );
const std::string g_defaultPurpose( "default" );

} // namespace
Expand Down
Loading